diff --git a/.gitignore b/.gitignore index 95bd050..ea6f53a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +.env +.env.local **/__pycache__/ **/.speakeasy/temp/ **/.speakeasy/logs/ diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index fe7cc0f..eaacda5 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 9b8ab966-40b1-444c-b41e-217acf02dd9e management: - docChecksum: d196a9d657dff1b0b09905a63ce9aa76 + docChecksum: d6b189c9d006491dc28d168a3e2b7dac docVersion: 0.0.0 - speakeasyVersion: 1.606.10 - generationVersion: 2.687.13 - releaseVersion: 0.3.0 - configChecksum: 8f932295d68232771fc1632f3a315deb + speakeasyVersion: 1.650.0 + generationVersion: 2.743.2 + releaseVersion: 0.4.0 + configChecksum: 73792869a029519486fb0d6eb485aad6 repoURL: https://github.com/documenso/sdk-python.git installationURL: https://github.com/documenso/sdk-python.git published: true @@ -14,25 +14,26 @@ features: python: additionalDependencies: 1.0.0 constsAndDefaults: 1.0.5 - core: 5.20.1 + core: 5.23.5 defaultEnabledRetries: 0.2.0 devContainers: 3.0.0 enumUnions: 0.1.0 + enums: 3.2.0 envVarSecurityUsage: 0.3.2 flatRequests: 1.0.1 flattening: 3.1.1 - globalSecurity: 3.0.3 + globalSecurity: 3.0.4 globalSecurityCallbacks: 1.0.0 globalSecurityFlattening: 1.0.0 - globalServerURLs: 3.1.1 - groups: 3.0.0 + globalServerURLs: 3.2.0 + groups: 3.0.1 methodArguments: 1.0.2 nameOverrides: 3.0.1 nullables: 1.0.1 responseFormat: 1.0.1 retries: 3.0.2 sdkHooks: 1.1.0 - unions: 3.0.4 + unions: 3.1.0 generatedFiles: - .devcontainer/README.md - .devcontainer/devcontainer.json @@ -40,9 +41,9 @@ generatedFiles: - .gitattributes - .vscode/settings.json - USAGE.md + - docs/models/customdocumentdatum.md - docs/models/datasource.md - docs/models/datastatus.md - - docs/models/document.md - docs/models/documentaccessauth.md - docs/models/documentactionauth.md - docs/models/documentcreatedocumenttemporaryaccessauthrequest.md @@ -52,6 +53,7 @@ generatedFiles: - docs/models/documentcreatedocumenttemporarybadrequestissue.md - docs/models/documentcreatedocumenttemporarydateformat.md - docs/models/documentcreatedocumenttemporarydistributionmethodrequest.md + - docs/models/documentcreatedocumenttemporarydocument.md - docs/models/documentcreatedocumenttemporarydocumentdata.md - docs/models/documentcreatedocumenttemporarydocumentmeta.md - docs/models/documentcreatedocumenttemporaryemailsettingsrequest.md @@ -76,6 +78,7 @@ generatedFiles: - docs/models/documentcreatedocumenttemporarymeta.md - docs/models/documentcreatedocumenttemporaryreadstatus.md - docs/models/documentcreatedocumenttemporaryrecipientauthoptions.md + - docs/models/documentcreatedocumenttemporaryrecipientdirection.md - docs/models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md - docs/models/documentcreatedocumenttemporaryrecipientfieldmetadate.md - docs/models/documentcreatedocumenttemporaryrecipientfieldmetadropdown.md @@ -124,141 +127,151 @@ generatedFiles: - docs/models/documentcreatedocumenttemporaryvaluedropdown.md - docs/models/documentcreatedocumenttemporaryvalueradio.md - docs/models/documentcreatedocumenttemporaryvisibilityrequest.md - - docs/models/documentdeletedocumentbadrequesterror.md - - docs/models/documentdeletedocumentbadrequestissue.md - - docs/models/documentdeletedocumentinternalservererror.md - - docs/models/documentdeletedocumentinternalservererrorissue.md - - docs/models/documentdeletedocumentrequest.md - - docs/models/documentdeletedocumentresponse.md + - docs/models/documentdeletebadrequesterror.md + - docs/models/documentdeletebadrequestissue.md + - docs/models/documentdeleteinternalservererror.md + - docs/models/documentdeleteinternalservererrorissue.md + - docs/models/documentdeleterequest.md + - docs/models/documentdeleteresponse.md + - docs/models/documentdirection.md + - docs/models/documentdistributeauthoptions.md + - docs/models/documentdistributebadrequesterror.md + - docs/models/documentdistributebadrequestissue.md + - docs/models/documentdistributedateformat.md + - docs/models/documentdistributedistributionmethod.md + - docs/models/documentdistributeemailsettings.md + - docs/models/documentdistributeformvalues.md + - docs/models/documentdistributeglobalaccessauth.md + - docs/models/documentdistributeglobalactionauth.md + - docs/models/documentdistributeinternalservererror.md + - docs/models/documentdistributeinternalservererrorissue.md + - docs/models/documentdistributelanguage.md + - docs/models/documentdistributemeta.md + - docs/models/documentdistributerequest.md + - docs/models/documentdistributeresponse.md + - docs/models/documentdistributesource.md + - docs/models/documentdistributestatus.md + - docs/models/documentdistributevisibility.md - docs/models/documentdistributionmethod.md - docs/models/documentdocumentdatatype.md - - docs/models/documentduplicatedocumentbadrequesterror.md - - docs/models/documentduplicatedocumentbadrequestissue.md - - docs/models/documentduplicatedocumentinternalservererror.md - - docs/models/documentduplicatedocumentinternalservererrorissue.md - - docs/models/documentduplicatedocumentrequest.md - - docs/models/documentduplicatedocumentresponse.md + - docs/models/documentdownloadbadrequesterror.md + - docs/models/documentdownloadbadrequestissue.md + - docs/models/documentdownloadinternalservererror.md + - docs/models/documentdownloadinternalservererrorissue.md + - docs/models/documentdownloadnotfounderror.md + - docs/models/documentdownloadnotfoundissue.md + - docs/models/documentdownloadrequest.md + - docs/models/documentdownloadresponse.md + - docs/models/documentduplicatebadrequesterror.md + - docs/models/documentduplicatebadrequestissue.md + - docs/models/documentduplicateinternalservererror.md + - docs/models/documentduplicateinternalservererrorissue.md + - docs/models/documentduplicaterequest.md + - docs/models/documentduplicateresponse.md - docs/models/documentemailsettings.md - docs/models/documentfield.md - docs/models/documentfieldmetaunion.md - docs/models/documentfieldtype.md - - docs/models/documentfinddocumentsaccessauth.md - - docs/models/documentfinddocumentsactionauth.md - - docs/models/documentfinddocumentsauthoptions.md - - docs/models/documentfinddocumentsbadrequesterror.md - - docs/models/documentfinddocumentsbadrequestissue.md - - docs/models/documentfinddocumentsdata.md - - docs/models/documentfinddocumentsformvalues.md - - docs/models/documentfinddocumentsglobalaccessauth.md - - docs/models/documentfinddocumentsglobalactionauth.md - - docs/models/documentfinddocumentsinternalservererror.md - - docs/models/documentfinddocumentsinternalservererrorissue.md - - docs/models/documentfinddocumentsnotfounderror.md - - docs/models/documentfinddocumentsnotfoundissue.md - - docs/models/documentfinddocumentsreadstatus.md - - docs/models/documentfinddocumentsrecipient.md - - docs/models/documentfinddocumentsrecipientauthoptions.md - - docs/models/documentfinddocumentsrequest.md - - docs/models/documentfinddocumentsresponse.md - - docs/models/documentfinddocumentsrole.md - - docs/models/documentfinddocumentssendstatus.md - - docs/models/documentfinddocumentssigningstatus.md - - docs/models/documentfinddocumentsteam.md - - docs/models/documentfinddocumentsuser.md - - docs/models/documentfinddocumentsvisibility.md + - docs/models/documentfindaccessauth.md + - docs/models/documentfindactionauth.md + - docs/models/documentfindauthoptions.md + - docs/models/documentfindbadrequesterror.md + - docs/models/documentfindbadrequestissue.md + - docs/models/documentfinddata.md + - docs/models/documentfindformvalues.md + - docs/models/documentfindglobalaccessauth.md + - docs/models/documentfindglobalactionauth.md + - docs/models/documentfindinternalservererror.md + - docs/models/documentfindinternalservererrorissue.md + - docs/models/documentfindnotfounderror.md + - docs/models/documentfindnotfoundissue.md + - docs/models/documentfindreadstatus.md + - docs/models/documentfindrecipient.md + - docs/models/documentfindrecipientauthoptions.md + - docs/models/documentfindrequest.md + - docs/models/documentfindresponse.md + - docs/models/documentfindrole.md + - docs/models/documentfindsendstatus.md + - docs/models/documentfindsigningstatus.md + - docs/models/documentfindteam.md + - docs/models/documentfinduser.md + - docs/models/documentfindvisibility.md - docs/models/documentfoldertype.md - docs/models/documentfoldervisibility.md - docs/models/documentformvalues.md - - docs/models/documentgetdocumentwithdetailsbyidaccessauth.md - - docs/models/documentgetdocumentwithdetailsbyidactionauth.md - - docs/models/documentgetdocumentwithdetailsbyidauthoptions.md - - docs/models/documentgetdocumentwithdetailsbyidbadrequesterror.md - - docs/models/documentgetdocumentwithdetailsbyidbadrequestissue.md - - docs/models/documentgetdocumentwithdetailsbyiddistributionmethod.md - - docs/models/documentgetdocumentwithdetailsbyiddocumentdata.md - - docs/models/documentgetdocumentwithdetailsbyiddocumentdatatype.md - - docs/models/documentgetdocumentwithdetailsbyiddocumentmeta.md - - docs/models/documentgetdocumentwithdetailsbyidemailsettings.md - - docs/models/documentgetdocumentwithdetailsbyidfield.md - - docs/models/documentgetdocumentwithdetailsbyidfieldmetacheckbox.md - - docs/models/documentgetdocumentwithdetailsbyidfieldmetadate.md - - docs/models/documentgetdocumentwithdetailsbyidfieldmetadropdown.md - - docs/models/documentgetdocumentwithdetailsbyidfieldmetaemail.md - - docs/models/documentgetdocumentwithdetailsbyidfieldmetainitials.md - - docs/models/documentgetdocumentwithdetailsbyidfieldmetaname.md - - docs/models/documentgetdocumentwithdetailsbyidfieldmetanumber.md - - docs/models/documentgetdocumentwithdetailsbyidfieldmetaradio.md - - docs/models/documentgetdocumentwithdetailsbyidfieldmetatext.md - - docs/models/documentgetdocumentwithdetailsbyidfieldmetaunion.md - - docs/models/documentgetdocumentwithdetailsbyidfieldtype.md - - docs/models/documentgetdocumentwithdetailsbyidfolder.md - - docs/models/documentgetdocumentwithdetailsbyidfoldertype.md - - docs/models/documentgetdocumentwithdetailsbyidfoldervisibility.md - - docs/models/documentgetdocumentwithdetailsbyidformvalues.md - - docs/models/documentgetdocumentwithdetailsbyidglobalaccessauth.md - - docs/models/documentgetdocumentwithdetailsbyidglobalactionauth.md - - docs/models/documentgetdocumentwithdetailsbyidinternalservererror.md - - docs/models/documentgetdocumentwithdetailsbyidinternalservererrorissue.md - - docs/models/documentgetdocumentwithdetailsbyidnotfounderror.md - - docs/models/documentgetdocumentwithdetailsbyidnotfoundissue.md - - docs/models/documentgetdocumentwithdetailsbyidreadstatus.md - - docs/models/documentgetdocumentwithdetailsbyidrecipient.md - - docs/models/documentgetdocumentwithdetailsbyidrecipientauthoptions.md - - docs/models/documentgetdocumentwithdetailsbyidrequest.md - - docs/models/documentgetdocumentwithdetailsbyidresponse.md - - docs/models/documentgetdocumentwithdetailsbyidrole.md - - docs/models/documentgetdocumentwithdetailsbyidsendstatus.md - - docs/models/documentgetdocumentwithdetailsbyidsigningorder.md - - docs/models/documentgetdocumentwithdetailsbyidsigningstatus.md - - docs/models/documentgetdocumentwithdetailsbyidsource.md - - docs/models/documentgetdocumentwithdetailsbyidstatus.md - - docs/models/documentgetdocumentwithdetailsbyidtextalign1.md - - docs/models/documentgetdocumentwithdetailsbyidtextalign2.md - - docs/models/documentgetdocumentwithdetailsbyidtextalign3.md - - docs/models/documentgetdocumentwithdetailsbyidtextalign4.md - - docs/models/documentgetdocumentwithdetailsbyidtextalign5.md - - docs/models/documentgetdocumentwithdetailsbyidtextalign6.md - - docs/models/documentgetdocumentwithdetailsbyidtypecheckbox.md - - docs/models/documentgetdocumentwithdetailsbyidtypedate.md - - docs/models/documentgetdocumentwithdetailsbyidtypedropdown.md - - docs/models/documentgetdocumentwithdetailsbyidtypeemail.md - - docs/models/documentgetdocumentwithdetailsbyidtypeinitials.md - - docs/models/documentgetdocumentwithdetailsbyidtypename.md - - docs/models/documentgetdocumentwithdetailsbyidtypenumber.md - - docs/models/documentgetdocumentwithdetailsbyidtyperadio.md - - docs/models/documentgetdocumentwithdetailsbyidtypetext.md - - docs/models/documentgetdocumentwithdetailsbyidvalue1.md - - docs/models/documentgetdocumentwithdetailsbyidvalue2.md - - docs/models/documentgetdocumentwithdetailsbyidvalue3.md - - docs/models/documentgetdocumentwithdetailsbyidvisibility.md + - docs/models/documentgetaccessauth.md + - docs/models/documentgetactionauth.md + - docs/models/documentgetauthoptions.md + - docs/models/documentgetbadrequesterror.md + - docs/models/documentgetbadrequestissue.md + - docs/models/documentgetdirection.md + - docs/models/documentgetdistributionmethod.md + - docs/models/documentgetdocumentdata.md + - docs/models/documentgetdocumentdatatype.md + - docs/models/documentgetdocumentmeta.md + - docs/models/documentgetemailsettings.md + - docs/models/documentgetfield.md + - docs/models/documentgetfieldmetacheckbox.md + - docs/models/documentgetfieldmetadate.md + - docs/models/documentgetfieldmetadropdown.md + - docs/models/documentgetfieldmetaemail.md + - docs/models/documentgetfieldmetainitials.md + - docs/models/documentgetfieldmetaname.md + - docs/models/documentgetfieldmetanumber.md + - docs/models/documentgetfieldmetaradio.md + - docs/models/documentgetfieldmetatext.md + - docs/models/documentgetfieldmetaunion.md + - docs/models/documentgetfieldtype.md + - docs/models/documentgetfolder.md + - docs/models/documentgetfoldertype.md + - docs/models/documentgetfoldervisibility.md + - docs/models/documentgetformvalues.md + - docs/models/documentgetglobalaccessauth.md + - docs/models/documentgetglobalactionauth.md + - docs/models/documentgetinternalservererror.md + - docs/models/documentgetinternalservererrorissue.md + - docs/models/documentgetnotfounderror.md + - docs/models/documentgetnotfoundissue.md + - docs/models/documentgetreadstatus.md + - docs/models/documentgetrecipient.md + - docs/models/documentgetrecipientauthoptions.md + - docs/models/documentgetrequest.md + - docs/models/documentgetresponse.md + - docs/models/documentgetrole.md + - docs/models/documentgetsendstatus.md + - docs/models/documentgetsigningorder.md + - docs/models/documentgetsigningstatus.md + - docs/models/documentgetsource.md + - docs/models/documentgetstatus.md + - docs/models/documentgettextalign1.md + - docs/models/documentgettextalign2.md + - docs/models/documentgettextalign3.md + - docs/models/documentgettextalign4.md + - docs/models/documentgettextalign5.md + - docs/models/documentgettextalign6.md + - docs/models/documentgettypecheckbox.md + - docs/models/documentgettypedate.md + - docs/models/documentgettypedropdown.md + - docs/models/documentgettypeemail.md + - docs/models/documentgettypeinitials.md + - docs/models/documentgettypename.md + - docs/models/documentgettypenumber.md + - docs/models/documentgettyperadio.md + - docs/models/documentgettypetext.md + - docs/models/documentgetvalue1.md + - docs/models/documentgetvalue2.md + - docs/models/documentgetvalue3.md + - docs/models/documentgetvisibility.md - docs/models/documentglobalaccessauth.md - docs/models/documentglobalactionauth.md - docs/models/documentrecipient.md - - docs/models/documentresenddocumentbadrequesterror.md - - docs/models/documentresenddocumentbadrequestissue.md - - docs/models/documentresenddocumentinternalservererror.md - - docs/models/documentresenddocumentinternalservererrorissue.md - - docs/models/documentresenddocumentrequest.md - - docs/models/documentresenddocumentresponse.md + - docs/models/documentredistributebadrequesterror.md + - docs/models/documentredistributebadrequestissue.md + - docs/models/documentredistributeinternalservererror.md + - docs/models/documentredistributeinternalservererrorissue.md + - docs/models/documentredistributerequest.md + - docs/models/documentredistributeresponse.md - docs/models/documentrole.md - - docs/models/documentsenddocumentauthoptions.md - - docs/models/documentsenddocumentbadrequesterror.md - - docs/models/documentsenddocumentbadrequestissue.md - - docs/models/documentsenddocumentdateformat.md - - docs/models/documentsenddocumentdistributionmethod.md - - docs/models/documentsenddocumentemailsettings.md - - docs/models/documentsenddocumentformvalues.md - - docs/models/documentsenddocumentglobalaccessauth.md - - docs/models/documentsenddocumentglobalactionauth.md - - docs/models/documentsenddocumentinternalservererror.md - - docs/models/documentsenddocumentinternalservererrorissue.md - - docs/models/documentsenddocumentlanguage.md - - docs/models/documentsenddocumentmeta.md - - docs/models/documentsenddocumentrequest.md - - docs/models/documentsenddocumentresponse.md - - docs/models/documentsenddocumentsource.md - - docs/models/documentsenddocumentstatus.md - - docs/models/documentsenddocumentvisibility.md - docs/models/documentsigningorder.md - docs/models/documenttextalign1.md - docs/models/documenttextalign2.md @@ -275,29 +288,29 @@ generatedFiles: - docs/models/documenttypenumber.md - docs/models/documenttyperadio.md - docs/models/documenttypetext.md - - docs/models/documentupdatedocumentauthoptions.md - - docs/models/documentupdatedocumentbadrequesterror.md - - docs/models/documentupdatedocumentbadrequestissue.md - - docs/models/documentupdatedocumentdata.md - - docs/models/documentupdatedocumentdateformat.md - - docs/models/documentupdatedocumentdistributionmethod.md - - docs/models/documentupdatedocumentemailsettings.md - - docs/models/documentupdatedocumentformvalues.md - - docs/models/documentupdatedocumentglobalaccessauthrequest.md - - docs/models/documentupdatedocumentglobalaccessauthresponse.md - - docs/models/documentupdatedocumentglobalactionauthrequest.md - - docs/models/documentupdatedocumentglobalactionauthresponse.md - - docs/models/documentupdatedocumentinternalservererror.md - - docs/models/documentupdatedocumentinternalservererrorissue.md - - docs/models/documentupdatedocumentlanguage.md - - docs/models/documentupdatedocumentmeta.md - - docs/models/documentupdatedocumentrequest.md - - docs/models/documentupdatedocumentresponse.md - - docs/models/documentupdatedocumentsigningorder.md - - docs/models/documentupdatedocumentsource.md - - docs/models/documentupdatedocumentstatus.md - - docs/models/documentupdatedocumentvisibilityrequest.md - - docs/models/documentupdatedocumentvisibilityresponse.md + - docs/models/documentupdateauthoptions.md + - docs/models/documentupdatebadrequesterror.md + - docs/models/documentupdatebadrequestissue.md + - docs/models/documentupdatedata.md + - docs/models/documentupdatedateformat.md + - docs/models/documentupdatedistributionmethod.md + - docs/models/documentupdateemailsettings.md + - docs/models/documentupdateformvalues.md + - docs/models/documentupdateglobalaccessauthrequest.md + - docs/models/documentupdateglobalaccessauthresponse.md + - docs/models/documentupdateglobalactionauthrequest.md + - docs/models/documentupdateglobalactionauthresponse.md + - docs/models/documentupdateinternalservererror.md + - docs/models/documentupdateinternalservererrorissue.md + - docs/models/documentupdatelanguage.md + - docs/models/documentupdatemeta.md + - docs/models/documentupdaterequest.md + - docs/models/documentupdateresponse.md + - docs/models/documentupdatesigningorder.md + - docs/models/documentupdatesource.md + - docs/models/documentupdatestatus.md + - docs/models/documentupdatevisibilityrequest.md + - docs/models/documentupdatevisibilityresponse.md - docs/models/documentvalue1.md - docs/models/documentvalue2.md - docs/models/documentvalue3.md @@ -316,6 +329,8 @@ generatedFiles: - docs/models/embeddingpresignverifyembeddingpresigntokenresponse.md - docs/models/fieldcreatedocumentfieldbadrequesterror.md - docs/models/fieldcreatedocumentfieldbadrequestissue.md + - docs/models/fieldcreatedocumentfielddirectionrequest.md + - docs/models/fieldcreatedocumentfielddirectionresponse.md - docs/models/fieldcreatedocumentfieldfieldcheckbox.md - docs/models/fieldcreatedocumentfieldfielddate.md - docs/models/fieldcreatedocumentfieldfielddropdown.md @@ -362,6 +377,8 @@ generatedFiles: - docs/models/fieldcreatedocumentfieldresponse.md - docs/models/fieldcreatedocumentfieldsbadrequesterror.md - docs/models/fieldcreatedocumentfieldsbadrequestissue.md + - docs/models/fieldcreatedocumentfieldsdirectionrequest.md + - docs/models/fieldcreatedocumentfieldsdirectionresponse.md - docs/models/fieldcreatedocumentfieldsfieldcheckbox.md - docs/models/fieldcreatedocumentfieldsfielddate.md - docs/models/fieldcreatedocumentfieldsfielddropdown.md @@ -487,6 +504,8 @@ generatedFiles: - docs/models/fieldcreatedocumentfieldvalueresponse3.md - docs/models/fieldcreatetemplatefieldbadrequesterror.md - docs/models/fieldcreatetemplatefieldbadrequestissue.md + - docs/models/fieldcreatetemplatefielddirectionrequest.md + - docs/models/fieldcreatetemplatefielddirectionresponse.md - docs/models/fieldcreatetemplatefieldfieldcheckbox.md - docs/models/fieldcreatetemplatefieldfielddate.md - docs/models/fieldcreatetemplatefieldfielddropdown.md @@ -533,6 +552,8 @@ generatedFiles: - docs/models/fieldcreatetemplatefieldresponse.md - docs/models/fieldcreatetemplatefieldsbadrequesterror.md - docs/models/fieldcreatetemplatefieldsbadrequestissue.md + - docs/models/fieldcreatetemplatefieldsdirectionrequest.md + - docs/models/fieldcreatetemplatefieldsdirectionresponse.md - docs/models/fieldcreatetemplatefieldsfieldcheckbox.md - docs/models/fieldcreatetemplatefieldsfielddate.md - docs/models/fieldcreatetemplatefieldsfielddropdown.md @@ -670,6 +691,7 @@ generatedFiles: - docs/models/fielddeletetemplatefieldresponse.md - docs/models/fieldgetdocumentfieldbadrequesterror.md - docs/models/fieldgetdocumentfieldbadrequestissue.md + - docs/models/fieldgetdocumentfielddirection.md - docs/models/fieldgetdocumentfieldfieldmetacheckbox.md - docs/models/fieldgetdocumentfieldfieldmetadate.md - docs/models/fieldgetdocumentfieldfieldmetadropdown.md @@ -707,6 +729,7 @@ generatedFiles: - docs/models/fieldgetdocumentfieldvalue3.md - docs/models/fieldgettemplatefieldbadrequesterror.md - docs/models/fieldgettemplatefieldbadrequestissue.md + - docs/models/fieldgettemplatefielddirection.md - docs/models/fieldgettemplatefieldfieldmetacheckbox.md - docs/models/fieldgettemplatefieldfieldmetadate.md - docs/models/fieldgettemplatefieldfieldmetadropdown.md @@ -753,6 +776,8 @@ generatedFiles: - docs/models/fieldmetadocumenttext.md - docs/models/fieldupdatedocumentfieldbadrequesterror.md - docs/models/fieldupdatedocumentfieldbadrequestissue.md + - docs/models/fieldupdatedocumentfielddirectionrequest.md + - docs/models/fieldupdatedocumentfielddirectionresponse.md - docs/models/fieldupdatedocumentfieldfieldcheckbox.md - docs/models/fieldupdatedocumentfieldfielddate.md - docs/models/fieldupdatedocumentfieldfielddropdown.md @@ -799,6 +824,8 @@ generatedFiles: - docs/models/fieldupdatedocumentfieldresponse.md - docs/models/fieldupdatedocumentfieldsbadrequesterror.md - docs/models/fieldupdatedocumentfieldsbadrequestissue.md + - docs/models/fieldupdatedocumentfieldsdirectionrequest.md + - docs/models/fieldupdatedocumentfieldsdirectionresponse.md - docs/models/fieldupdatedocumentfieldsfieldcheckbox.md - docs/models/fieldupdatedocumentfieldsfielddate.md - docs/models/fieldupdatedocumentfieldsfielddropdown.md @@ -924,6 +951,8 @@ generatedFiles: - docs/models/fieldupdatedocumentfieldvalueresponse3.md - docs/models/fieldupdatetemplatefieldbadrequesterror.md - docs/models/fieldupdatetemplatefieldbadrequestissue.md + - docs/models/fieldupdatetemplatefielddirectionrequest.md + - docs/models/fieldupdatetemplatefielddirectionresponse.md - docs/models/fieldupdatetemplatefieldfieldcheckbox.md - docs/models/fieldupdatetemplatefieldfielddate.md - docs/models/fieldupdatetemplatefieldfielddropdown.md @@ -970,6 +999,8 @@ generatedFiles: - docs/models/fieldupdatetemplatefieldresponse.md - docs/models/fieldupdatetemplatefieldsbadrequesterror.md - docs/models/fieldupdatetemplatefieldsbadrequestissue.md + - docs/models/fieldupdatetemplatefieldsdirectionrequest.md + - docs/models/fieldupdatetemplatefieldsdirectionresponse.md - docs/models/fieldupdatetemplatefieldsfieldcheckbox.md - docs/models/fieldupdatetemplatefieldsfielddate.md - docs/models/fieldupdatetemplatefieldsfielddropdown.md @@ -1199,6 +1230,7 @@ generatedFiles: - docs/models/recipientgetdocumentrecipientauthoptions.md - docs/models/recipientgetdocumentrecipientbadrequesterror.md - docs/models/recipientgetdocumentrecipientbadrequestissue.md + - docs/models/recipientgetdocumentrecipientdirection.md - docs/models/recipientgetdocumentrecipientfield.md - docs/models/recipientgetdocumentrecipientfieldmetacheckbox.md - docs/models/recipientgetdocumentrecipientfieldmetadate.md @@ -1244,6 +1276,7 @@ generatedFiles: - docs/models/recipientgettemplaterecipientauthoptions.md - docs/models/recipientgettemplaterecipientbadrequesterror.md - docs/models/recipientgettemplaterecipientbadrequestissue.md + - docs/models/recipientgettemplaterecipientdirection.md - docs/models/recipientgettemplaterecipientfield.md - docs/models/recipientgettemplaterecipientfieldmetacheckbox.md - docs/models/recipientgettemplaterecipientfieldmetadate.md @@ -1291,6 +1324,7 @@ generatedFiles: - docs/models/recipientupdatedocumentrecipientauthoptions.md - docs/models/recipientupdatedocumentrecipientbadrequesterror.md - docs/models/recipientupdatedocumentrecipientbadrequestissue.md + - docs/models/recipientupdatedocumentrecipientdirection.md - docs/models/recipientupdatedocumentrecipientfield.md - docs/models/recipientupdatedocumentrecipientfieldmetacheckbox.md - docs/models/recipientupdatedocumentrecipientfieldmetadate.md @@ -1317,6 +1351,7 @@ generatedFiles: - docs/models/recipientupdatedocumentrecipientsauthoptions.md - docs/models/recipientupdatedocumentrecipientsbadrequesterror.md - docs/models/recipientupdatedocumentrecipientsbadrequestissue.md + - docs/models/recipientupdatedocumentrecipientsdirection.md - docs/models/recipientupdatedocumentrecipientsendstatus.md - docs/models/recipientupdatedocumentrecipientsfield.md - docs/models/recipientupdatedocumentrecipientsfieldmetacheckbox.md @@ -1386,6 +1421,7 @@ generatedFiles: - docs/models/recipientupdatetemplaterecipientauthoptions.md - docs/models/recipientupdatetemplaterecipientbadrequesterror.md - docs/models/recipientupdatetemplaterecipientbadrequestissue.md + - docs/models/recipientupdatetemplaterecipientdirection.md - docs/models/recipientupdatetemplaterecipientfield.md - docs/models/recipientupdatetemplaterecipientfieldmetacheckbox.md - docs/models/recipientupdatetemplaterecipientfieldmetadate.md @@ -1412,6 +1448,7 @@ generatedFiles: - docs/models/recipientupdatetemplaterecipientsauthoptions.md - docs/models/recipientupdatetemplaterecipientsbadrequesterror.md - docs/models/recipientupdatetemplaterecipientsbadrequestissue.md + - docs/models/recipientupdatetemplaterecipientsdirection.md - docs/models/recipientupdatetemplaterecipientsendstatus.md - docs/models/recipientupdatetemplaterecipientsfield.md - docs/models/recipientupdatetemplaterecipientsfieldmetacheckbox.md @@ -1480,6 +1517,7 @@ generatedFiles: - docs/models/templatecreatedocumentfromtemplateauthoptions.md - docs/models/templatecreatedocumentfromtemplatebadrequesterror.md - docs/models/templatecreatedocumentfromtemplatebadrequestissue.md + - docs/models/templatecreatedocumentfromtemplatedirection.md - docs/models/templatecreatedocumentfromtemplatedistributionmethod.md - docs/models/templatecreatedocumentfromtemplatedocumentdata.md - docs/models/templatecreatedocumentfromtemplatedocumentdatatype.md @@ -1542,6 +1580,78 @@ generatedFiles: - docs/models/templatecreatetemplatedirectlinkinternalservererrorissue.md - docs/models/templatecreatetemplatedirectlinkrequest.md - docs/models/templatecreatetemplatedirectlinkresponse.md + - docs/models/templatecreatetemplatetemporaryaccessauth.md + - docs/models/templatecreatetemplatetemporaryactionauth.md + - docs/models/templatecreatetemplatetemporaryauthoptions.md + - docs/models/templatecreatetemplatetemporarybadrequesterror.md + - docs/models/templatecreatetemplatetemporarybadrequestissue.md + - docs/models/templatecreatetemplatetemporarydateformat.md + - docs/models/templatecreatetemplatetemporarydirection.md + - docs/models/templatecreatetemplatetemporarydirectlink.md + - docs/models/templatecreatetemplatetemporarydistributionmethodrequest.md + - docs/models/templatecreatetemplatetemporaryemailsettingsrequest.md + - docs/models/templatecreatetemplatetemporaryfield.md + - docs/models/templatecreatetemplatetemporaryfieldmetacheckbox.md + - docs/models/templatecreatetemplatetemporaryfieldmetadate.md + - docs/models/templatecreatetemplatetemporaryfieldmetadropdown.md + - docs/models/templatecreatetemplatetemporaryfieldmetaemail.md + - docs/models/templatecreatetemplatetemporaryfieldmetainitials.md + - docs/models/templatecreatetemplatetemporaryfieldmetaname.md + - docs/models/templatecreatetemplatetemporaryfieldmetanumber.md + - docs/models/templatecreatetemplatetemporaryfieldmetaradio.md + - docs/models/templatecreatetemplatetemporaryfieldmetatext.md + - docs/models/templatecreatetemplatetemporaryfieldmetaunion.md + - docs/models/templatecreatetemplatetemporaryfieldtype.md + - docs/models/templatecreatetemplatetemporaryfolder.md + - docs/models/templatecreatetemplatetemporaryfoldertype.md + - docs/models/templatecreatetemplatetemporaryfoldervisibility.md + - docs/models/templatecreatetemplatetemporaryglobalaccessauthrequest.md + - docs/models/templatecreatetemplatetemporaryglobalaccessauthresponse.md + - docs/models/templatecreatetemplatetemporaryglobalactionauthrequest.md + - docs/models/templatecreatetemplatetemporaryglobalactionauthresponse.md + - docs/models/templatecreatetemplatetemporaryinternalservererror.md + - docs/models/templatecreatetemplatetemporaryinternalservererrorissue.md + - docs/models/templatecreatetemplatetemporarylanguage.md + - docs/models/templatecreatetemplatetemporarymeta.md + - docs/models/templatecreatetemplatetemporaryreadstatus.md + - docs/models/templatecreatetemplatetemporaryrecipient.md + - docs/models/templatecreatetemplatetemporaryrecipientauthoptions.md + - docs/models/templatecreatetemplatetemporaryrequest.md + - docs/models/templatecreatetemplatetemporaryresponse.md + - docs/models/templatecreatetemplatetemporaryrole.md + - docs/models/templatecreatetemplatetemporarysendstatus.md + - docs/models/templatecreatetemplatetemporarysigningorderrequest.md + - docs/models/templatecreatetemplatetemporarysigningstatus.md + - docs/models/templatecreatetemplatetemporarytemplate.md + - docs/models/templatecreatetemplatetemporarytemplatedocumentdata.md + - docs/models/templatecreatetemplatetemporarytemplatedocumentdatatype.md + - docs/models/templatecreatetemplatetemporarytemplatemeta.md + - docs/models/templatecreatetemplatetemporarytemplatemetadistributionmethod.md + - docs/models/templatecreatetemplatetemporarytemplatemetaemailsettings.md + - docs/models/templatecreatetemplatetemporarytemplatemetasigningorder.md + - docs/models/templatecreatetemplatetemporarytextalign1.md + - docs/models/templatecreatetemplatetemporarytextalign2.md + - docs/models/templatecreatetemplatetemporarytextalign3.md + - docs/models/templatecreatetemplatetemporarytextalign4.md + - docs/models/templatecreatetemplatetemporarytextalign5.md + - docs/models/templatecreatetemplatetemporarytextalign6.md + - docs/models/templatecreatetemplatetemporarytypecheckbox.md + - docs/models/templatecreatetemplatetemporarytypedate.md + - docs/models/templatecreatetemplatetemporarytypedropdown.md + - docs/models/templatecreatetemplatetemporarytypeemail.md + - docs/models/templatecreatetemplatetemporarytypeinitials.md + - docs/models/templatecreatetemplatetemporarytypename.md + - docs/models/templatecreatetemplatetemporarytypenumber.md + - docs/models/templatecreatetemplatetemporarytyperadio.md + - docs/models/templatecreatetemplatetemporarytyperequest.md + - docs/models/templatecreatetemplatetemporarytyperesponse.md + - docs/models/templatecreatetemplatetemporarytypetext.md + - docs/models/templatecreatetemplatetemporaryuser.md + - docs/models/templatecreatetemplatetemporaryvalue1.md + - docs/models/templatecreatetemplatetemporaryvalue2.md + - docs/models/templatecreatetemplatetemporaryvalue3.md + - docs/models/templatecreatetemplatetemporaryvisibilityrequest.md + - docs/models/templatecreatetemplatetemporaryvisibilityresponse.md - docs/models/templatedeletetemplatebadrequesterror.md - docs/models/templatedeletetemplatebadrequestissue.md - docs/models/templatedeletetemplatedirectlinkbadrequesterror.md @@ -1554,8 +1664,6 @@ generatedFiles: - docs/models/templatedeletetemplateinternalservererrorissue.md - docs/models/templatedeletetemplaterequest.md - docs/models/templatedeletetemplateresponse.md - - docs/models/templatedocumentdata.md - - docs/models/templatedocumentdatatype.md - docs/models/templateduplicatetemplateauthoptions.md - docs/models/templateduplicatetemplatebadrequesterror.md - docs/models/templateduplicatetemplatebadrequestissue.md @@ -1574,6 +1682,7 @@ generatedFiles: - docs/models/templatefindtemplatesbadrequestissue.md - docs/models/templatefindtemplatesdata.md - docs/models/templatefindtemplatesdatatype.md + - docs/models/templatefindtemplatesdirection.md - docs/models/templatefindtemplatesdirectlink.md - docs/models/templatefindtemplatesdistributionmethod.md - docs/models/templatefindtemplatesfield.md @@ -1629,6 +1738,7 @@ generatedFiles: - docs/models/templategettemplatebyidauthoptions.md - docs/models/templategettemplatebyidbadrequesterror.md - docs/models/templategettemplatebyidbadrequestissue.md + - docs/models/templategettemplatebyiddirection.md - docs/models/templategettemplatebyiddirectlink.md - docs/models/templategettemplatebyiddistributionmethod.md - docs/models/templategettemplatebyidemailsettings.md @@ -1662,6 +1772,8 @@ generatedFiles: - docs/models/templategettemplatebyidsendstatus.md - docs/models/templategettemplatebyidsigningorder.md - docs/models/templategettemplatebyidsigningstatus.md + - docs/models/templategettemplatebyidtemplatedocumentdata.md + - docs/models/templategettemplatebyidtemplatedocumentdatatype.md - docs/models/templategettemplatebyidtemplatemeta.md - docs/models/templategettemplatebyidtextalign1.md - docs/models/templategettemplatebyidtextalign2.md @@ -1713,13 +1825,15 @@ generatedFiles: - docs/models/templateupdatetemplatevisibilityrequest.md - docs/models/templateupdatetemplatevisibilityresponse.md - docs/models/utils/retryconfig.md + - docs/models/version.md - docs/sdks/directlinksdk/README.md - - docs/sdks/documenso/README.md - docs/sdks/documents/README.md + - docs/sdks/documentsdk/README.md - docs/sdks/documentsfields/README.md - docs/sdks/documentsrecipients/README.md - docs/sdks/embedding/README.md - docs/sdks/templates/README.md + - docs/sdks/templatesdk/README.md - docs/sdks/templatesfields/README.md - docs/sdks/templatesrecipients/README.md - poetry.toml @@ -1735,6 +1849,7 @@ generatedFiles: - src/documenso_sdk/_version.py - src/documenso_sdk/basesdk.py - src/documenso_sdk/directlink_sdk.py + - src/documenso_sdk/document_sdk.py - src/documenso_sdk/documents.py - src/documenso_sdk/documents_fields.py - src/documenso_sdk/documents_recipients.py @@ -1744,13 +1859,14 @@ generatedFiles: - src/documenso_sdk/models/apierror.py - src/documenso_sdk/models/documensoerror.py - src/documenso_sdk/models/document_createdocumenttemporaryop.py - - src/documenso_sdk/models/document_deletedocumentop.py - - src/documenso_sdk/models/document_duplicatedocumentop.py - - src/documenso_sdk/models/document_finddocumentsop.py - - src/documenso_sdk/models/document_getdocumentwithdetailsbyidop.py - - src/documenso_sdk/models/document_resenddocumentop.py - - src/documenso_sdk/models/document_senddocumentop.py - - src/documenso_sdk/models/document_updatedocumentop.py + - src/documenso_sdk/models/document_deleteop.py + - src/documenso_sdk/models/document_distributeop.py + - src/documenso_sdk/models/document_downloadop.py + - src/documenso_sdk/models/document_duplicateop.py + - src/documenso_sdk/models/document_findop.py + - src/documenso_sdk/models/document_getop.py + - src/documenso_sdk/models/document_redistributeop.py + - src/documenso_sdk/models/document_updateop.py - src/documenso_sdk/models/embeddingpresign_createembeddingpresigntokenop.py - src/documenso_sdk/models/embeddingpresign_verifyembeddingpresigntokenop.py - src/documenso_sdk/models/field_createdocumentfieldop.py @@ -1782,6 +1898,7 @@ generatedFiles: - src/documenso_sdk/models/security.py - src/documenso_sdk/models/template_createdocumentfromtemplateop.py - src/documenso_sdk/models/template_createtemplatedirectlinkop.py + - src/documenso_sdk/models/template_createtemplatetemporaryop.py - src/documenso_sdk/models/template_deletetemplatedirectlinkop.py - src/documenso_sdk/models/template_deletetemplateop.py - src/documenso_sdk/models/template_duplicatetemplateop.py @@ -1792,6 +1909,7 @@ generatedFiles: - src/documenso_sdk/py.typed - src/documenso_sdk/sdk.py - src/documenso_sdk/sdkconfiguration.py + - src/documenso_sdk/template_sdk.py - src/documenso_sdk/templates.py - src/documenso_sdk/templates_fields.py - src/documenso_sdk/templates_recipients.py @@ -1849,7 +1967,7 @@ examples: application/json: {"title": ""} responses: "200": - application/json: {"document": {"visibility": "MANAGER_AND_ABOVE", "status": "DRAFT", "source": "TEMPLATE_DIRECT_LINK", "id": 9025.78, "externalId": "", "userId": 3553.42, "authOptions": null, "formValues": {}, "title": "", "documentDataId": "", "createdAt": "1727678986659", "updatedAt": "1735619356040", "completedAt": null, "deletedAt": "", "teamId": 2366.18, "templateId": 5940.67, "folderId": "", "documentData": {"type": "BYTES_64", "id": "", "data": "", "initialData": ""}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "NONE", "id": "", "subject": "", "message": "", "timezone": "America/Detroit", "password": "R2lXhpWYWQqLVzM", "dateFormat": "", "documentId": 4554.27, "redirectUrl": "https://ugly-interior.org", "typedSignatureEnabled": false, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}}, "folder": null, "recipients": [{"role": "APPROVER", "readStatus": "NOT_OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 8131.59, "documentId": 7061.91, "templateId": 1136.33, "email": "Isabell_Koch@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["TWO_FACTOR_AUTH"]}, "signingOrder": 4474.72, "rejectionReason": ""}], "fields": []}, "uploadUrl": "https://esteemed-hubris.net/"} + application/json: {"document": {"visibility": "MANAGER_AND_ABOVE", "status": "DRAFT", "source": "TEMPLATE_DIRECT_LINK", "id": 9025.78, "externalId": "", "userId": 3553.42, "authOptions": null, "formValues": {}, "title": "", "createdAt": "1727678986659", "updatedAt": "1735619356040", "completedAt": null, "deletedAt": "", "teamId": 2366.18, "folderId": "", "envelopeId": "", "documentDataId": "", "documentData": {"type": "BYTES_64", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "NONE", "id": "", "subject": "", "message": "", "timezone": "America/Detroit", "dateFormat": "", "redirectUrl": "https://ugly-interior.org", "typedSignatureEnabled": false, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": null, "password": null, "documentId": -1}, "folder": null, "recipients": [{"envelopeId": "", "role": "APPROVER", "readStatus": "NOT_OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 8131.59, "email": "Isabell_Koch@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["TWO_FACTOR_AUTH"]}, "signingOrder": 4474.72, "rejectionReason": "", "documentId": 7061.91, "templateId": 1136.33}], "fields": []}, "uploadUrl": "https://esteemed-hubris.net/"} "400": application/json: {"message": "", "code": ""} "500": @@ -1927,7 +2045,7 @@ examples: fieldId: 6077.81 responses: "200": - application/json: {"type": "DROPDOWN", "id": 1675.25, "secondaryId": "", "documentId": 5913.76, "templateId": 5141.8, "recipientId": 41.83, "page": 2158.79, "customText": "", "inserted": true, "fieldMeta": {"type": "radio"}} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "DROPDOWN", "id": 1675.25, "secondaryId": "", "recipientId": 41.83, "page": 2158.79, "customText": "", "inserted": true, "fieldMeta": {"type": "radio"}} "400": application/json: {"message": "", "code": ""} "404": @@ -1940,7 +2058,7 @@ examples: application/json: {"documentId": 8001.93, "field": {"type": "NAME", "recipientId": 2564.68, "pageNumber": 791.77, "pageX": 7845.22, "pageY": 6843.16, "width": 3932.15, "height": 8879.89}} responses: "200": - application/json: {"type": "SIGNATURE", "id": 2381.57, "secondaryId": "", "documentId": 3378.71, "templateId": 787.23, "recipientId": 1080.89, "page": 9103.02, "customText": "", "inserted": false, "fieldMeta": null} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "SIGNATURE", "id": 2381.57, "secondaryId": "", "recipientId": 1080.89, "page": 9103.02, "customText": "", "inserted": false, "fieldMeta": null} "400": application/json: {"message": "", "code": ""} "500": @@ -1962,7 +2080,7 @@ examples: application/json: {"documentId": 5956.26, "field": {"type": "FREE_SIGNATURE", "id": 6955.16}} responses: "200": - application/json: {"type": "INITIALS", "id": 1295.68, "secondaryId": "", "documentId": 4731.43, "templateId": 502.03, "recipientId": 9839.63, "page": 8795.43, "customText": "", "inserted": true, "fieldMeta": {"type": "initials"}} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "INITIALS", "id": 1295.68, "secondaryId": "", "recipientId": 9839.63, "page": 8795.43, "customText": "", "inserted": true, "fieldMeta": {"type": "initials"}} "400": application/json: {"message": "", "code": ""} "500": @@ -1996,7 +2114,7 @@ examples: recipientId: 874.3 responses: "200": - application/json: {"role": "VIEWER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 2011.21, "documentId": 8537.53, "templateId": 7026.32, "email": "Micaela.McCullough@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": null, "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["ACCOUNT"]}, "signingOrder": 2776.88, "rejectionReason": "", "fields": [{"type": "FREE_SIGNATURE", "id": 6796.74, "secondaryId": "", "documentId": null, "templateId": null, "recipientId": 4324.4, "page": 7869.52, "customText": "", "inserted": true, "fieldMeta": {"type": "checkbox"}}]} + application/json: {"envelopeId": "", "role": "VIEWER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 2011.21, "email": "Micaela.McCullough@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": null, "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["ACCOUNT"]}, "signingOrder": 2776.88, "rejectionReason": "", "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "FREE_SIGNATURE", "id": 6796.74, "secondaryId": "", "recipientId": 4324.4, "page": 7869.52, "customText": "", "inserted": true, "fieldMeta": {"type": "checkbox", "direction": "vertical"}, "documentId": null, "templateId": null}]} "400": application/json: {"message": "", "code": ""} "404": @@ -2009,7 +2127,7 @@ examples: application/json: {"documentId": 3058.31, "recipient": {"email": "Ila.Steuber@yahoo.com", "name": "", "role": "ASSISTANT"}} responses: "200": - application/json: {"role": "ASSISTANT", "readStatus": "NOT_OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 4556.07, "documentId": 2327.54, "templateId": 7160.46, "email": "Kitty_Heathcote-Huels@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["TWO_FACTOR_AUTH"]}, "signingOrder": 3961.73, "rejectionReason": null} + application/json: {"envelopeId": "", "role": "ASSISTANT", "readStatus": "NOT_OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 4556.07, "email": "Kitty_Heathcote-Huels@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["TWO_FACTOR_AUTH"]}, "signingOrder": 3961.73, "rejectionReason": null} "400": application/json: {"message": "", "code": ""} "500": @@ -2031,7 +2149,7 @@ examples: application/json: {"documentId": 7045.62, "recipient": {"id": 2224.05}} responses: "200": - application/json: {"role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 6679.58, "documentId": 1962.76, "templateId": 8876.44, "email": "Ned42@yahoo.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["PASSKEY"]}, "signingOrder": 231.61, "rejectionReason": "", "fields": []} + application/json: {"envelopeId": "", "role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 6679.58, "email": "Ned42@yahoo.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["PASSKEY"]}, "signingOrder": 231.61, "rejectionReason": "", "fields": []} "400": application/json: {"message": "", "code": ""} "500": @@ -2042,7 +2160,7 @@ examples: application/json: {"documentId": 3189.76, "recipients": []} responses: "200": - application/json: {"recipients": [{"role": "VIEWER", "readStatus": "NOT_OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 7967.19, "documentId": 366.25, "templateId": 5896.63, "email": "Burley.Kuhn68@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": null, "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["PASSKEY"]}, "signingOrder": 4432.77, "rejectionReason": "", "fields": []}]} + application/json: {"recipients": [{"envelopeId": "", "role": "VIEWER", "readStatus": "NOT_OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 7967.19, "email": "Burley.Kuhn68@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": null, "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["PASSKEY"]}, "signingOrder": 4432.77, "rejectionReason": "", "fields": [], "documentId": 366.25, "templateId": 5896.63}]} "400": application/json: {"message": "", "code": ""} "500": @@ -2062,7 +2180,7 @@ examples: speakeasy-default-template-find-templates: responses: "200": - application/json: {"data": [{"type": "PRIVATE", "visibility": "ADMIN", "id": 8353.5, "externalId": "", "title": "", "userId": 3928.48, "teamId": 3159.46, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["TWO_FACTOR_AUTH"]}, "templateDocumentDataId": "", "createdAt": "1714153048686", "updatedAt": "1735669673106", "publicTitle": "", "publicDescription": "", "folderId": "", "useLegacyFieldInsertion": false, "team": {"id": 4826.51, "url": "https://fearless-cd.name/"}, "fields": [], "recipients": [], "templateMeta": {"signingOrder": "SEQUENTIAL", "distributionMethod": "EMAIL"}, "directLink": {"token": "", "enabled": true}}], "count": 2399.32, "currentPage": 1008.79, "perPage": 7002.73, "totalPages": 1006.98} + application/json: {"data": [{"type": "PRIVATE", "visibility": "ADMIN", "id": 8353.5, "externalId": "", "title": "", "userId": 3928.48, "teamId": 3159.46, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["TWO_FACTOR_AUTH"]}, "createdAt": "1714153048686", "updatedAt": "1735669673106", "publicTitle": "", "publicDescription": "", "folderId": "", "useLegacyFieldInsertion": false, "envelopeId": "", "team": {"id": 4826.51, "url": "https://fearless-cd.name/"}, "fields": [], "recipients": [], "templateMeta": {"signingOrder": "SEQUENTIAL", "distributionMethod": "EMAIL"}, "directLink": {"token": "", "enabled": true}, "templateDocumentDataId": ""}], "count": 2399.32, "currentPage": 1008.79, "perPage": 7002.73, "totalPages": 1006.98} "400": application/json: {"message": "", "code": ""} "404": @@ -2076,7 +2194,7 @@ examples: templateId: 2128.54 responses: "200": - application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 2786.55, "externalId": "", "title": "", "userId": 6940.89, "teamId": 3976.59, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["PASSKEY"]}, "templateDocumentDataId": "", "createdAt": "1730357255418", "updatedAt": "1735658892432", "publicTitle": "", "publicDescription": "", "folderId": "", "templateDocumentData": {"type": "S3_PATH", "id": "", "data": "", "initialData": ""}, "templateMeta": null, "directLink": {"id": "", "templateId": 7277.86, "token": "", "createdAt": "1717601799828", "enabled": false, "directTemplateRecipientId": 834.56}, "user": {"id": 9738.42, "name": null, "email": "Mack_Medhurst1@yahoo.com"}, "recipients": [{"role": "SIGNER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 4032.33, "documentId": 1928.67, "templateId": 8554.25, "email": "Jerod84@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": null, "signingOrder": 2256.36, "rejectionReason": ""}], "fields": [{"type": "DROPDOWN", "id": 5010.54, "secondaryId": "", "documentId": 7051.15, "templateId": 2232.05, "recipientId": 1178.91, "page": 6095.28, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}}], "folder": {"id": "", "name": "", "type": "DOCUMENT", "visibility": "EVERYONE", "userId": 4312.16, "teamId": 6940.89, "pinned": true, "parentId": "", "createdAt": "1722107407943", "updatedAt": "1735666987948"}} + application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 2786.55, "externalId": "", "title": "", "userId": 6940.89, "teamId": 3976.59, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["PASSKEY"]}, "createdAt": "1730357255418", "updatedAt": "1735658892432", "publicTitle": "", "publicDescription": "", "folderId": "", "envelopeId": "", "templateDocumentDataId": "", "templateDocumentData": {"type": "S3_PATH", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "templateMeta": {"id": "", "subject": "", "message": "", "timezone": "America/Indiana/Indianapolis", "dateFormat": "", "signingOrder": "SEQUENTIAL", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": false, "allowDictateNextSigner": false, "distributionMethod": "EMAIL", "redirectUrl": "https://prudent-embossing.com", "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": "", "templateId": 834.56}, "directLink": {"id": "", "envelopeId": "", "token": "", "createdAt": "1717601799828", "enabled": false, "directTemplateRecipientId": 834.56, "templateId": 7277.86}, "user": {"id": 9738.42, "name": null, "email": "Mack_Medhurst1@yahoo.com"}, "recipients": [{"envelopeId": "", "role": "SIGNER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 4032.33, "email": "Jerod84@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": null, "signingOrder": 2256.36, "rejectionReason": "", "documentId": 1928.67, "templateId": 8554.25}], "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "DROPDOWN", "id": 5010.54, "secondaryId": "", "recipientId": 1178.91, "page": 6095.28, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}, "documentId": 7051.15, "templateId": 2232.05}], "folder": {"id": "", "name": "", "type": "DOCUMENT", "visibility": "EVERYONE", "userId": 4312.16, "teamId": 6940.89, "pinned": true, "parentId": "", "createdAt": "1722107407943", "updatedAt": "1735666987948"}} "400": application/json: {"message": "", "code": ""} "404": @@ -2089,7 +2207,7 @@ examples: application/json: {"templateId": 9404.77} responses: "200": - application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 5983.02, "externalId": "", "title": "", "userId": 9111.71, "teamId": 6120.86, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["ACCOUNT"]}, "templateDocumentDataId": "", "createdAt": "1713421873205", "updatedAt": "1735604426304", "publicTitle": "", "publicDescription": "", "folderId": "", "useLegacyFieldInsertion": true} + application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 5983.02, "externalId": "", "title": "", "userId": 9111.71, "teamId": 6120.86, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["ACCOUNT"]}, "createdAt": "1713421873205", "updatedAt": "1735604426304", "publicTitle": "", "publicDescription": "", "folderId": "", "useLegacyFieldInsertion": true, "envelopeId": "", "templateDocumentDataId": ""} "400": application/json: {"message": "", "code": ""} "500": @@ -2100,7 +2218,7 @@ examples: application/json: {"templateId": 2490.16} responses: "200": - application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 4866.89, "externalId": "", "title": "", "userId": 9126.65, "teamId": 4478.26, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["ACCOUNT"]}, "templateDocumentDataId": "", "createdAt": "1724731479749", "updatedAt": "1735650902968", "publicTitle": "", "publicDescription": "", "folderId": "", "useLegacyFieldInsertion": true} + application/json: {"type": "PUBLIC", "visibility": "MANAGER_AND_ABOVE", "id": 4866.89, "externalId": "", "title": "", "userId": 9126.65, "teamId": 4478.26, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["ACCOUNT"]}, "createdAt": "1724731479749", "updatedAt": "1735650902968", "publicTitle": "", "publicDescription": "", "folderId": "", "useLegacyFieldInsertion": true, "envelopeId": "", "templateDocumentDataId": ""} "400": application/json: {"message": "", "code": ""} "500": @@ -2122,7 +2240,7 @@ examples: application/json: {"templateId": 7392.96, "recipients": []} responses: "200": - application/json: {"visibility": "EVERYONE", "status": "DRAFT", "source": "DOCUMENT", "id": 5310.67, "externalId": "", "userId": 4199.74, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["TWO_FACTOR_AUTH"]}, "formValues": {"key": ""}, "title": "", "documentDataId": "", "createdAt": "1713071497395", "updatedAt": "1735653497198", "completedAt": "", "deletedAt": "", "teamId": 7804.64, "templateId": null, "folderId": "", "documentData": {"type": "S3_PATH", "id": "", "data": "", "initialData": ""}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL", "id": "", "subject": "", "message": "", "timezone": "America/Detroit", "password": "sYbkNhe0kXAWK9U", "dateFormat": null, "documentId": 9505.54, "redirectUrl": "https://wide-bump.org/", "typedSignatureEnabled": false, "uploadSignatureEnabled": true, "drawSignatureEnabled": true, "allowDictateNextSigner": true, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}}, "folder": {"id": "", "name": "", "type": "DOCUMENT", "visibility": "EVERYONE", "userId": 2922.71, "teamId": 5310.67, "pinned": true, "parentId": "", "createdAt": "1727134759765", "updatedAt": "1735631030392"}, "recipients": [], "fields": [{"type": "DATE", "id": 4993.43, "secondaryId": "", "documentId": 518.53, "templateId": 9453.15, "recipientId": 9324.88, "page": 5546.12, "customText": "", "inserted": true, "fieldMeta": {"type": "radio"}}]} + application/json: {"visibility": "EVERYONE", "status": "DRAFT", "source": "DOCUMENT", "id": 5310.67, "externalId": "", "userId": 4199.74, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": ["TWO_FACTOR_AUTH"]}, "formValues": {"key": ""}, "title": "", "createdAt": "1713071497395", "updatedAt": "1735653497198", "completedAt": "", "deletedAt": "", "teamId": 7804.64, "folderId": "", "envelopeId": "", "documentDataId": "", "documentData": {"type": "S3_PATH", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "EMAIL", "id": "", "subject": "", "message": "", "timezone": "America/Detroit", "dateFormat": null, "redirectUrl": "https://wide-bump.org/", "typedSignatureEnabled": false, "uploadSignatureEnabled": true, "drawSignatureEnabled": true, "allowDictateNextSigner": true, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": "", "password": null, "documentId": -1}, "folder": {"id": "", "name": "", "type": "DOCUMENT", "visibility": "EVERYONE", "userId": 2922.71, "teamId": 5310.67, "pinned": true, "parentId": "", "createdAt": "1727134759765", "updatedAt": "1735631030392"}, "recipients": [], "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "DATE", "id": 4993.43, "secondaryId": "", "recipientId": 9324.88, "page": 5546.12, "customText": "", "inserted": true, "fieldMeta": {"type": "radio"}, "documentId": 518.53, "templateId": 9453.15}]} "400": application/json: {"message": "", "code": ""} "500": @@ -2144,7 +2262,7 @@ examples: application/json: {"templateId": 1203.71, "field": {"type": "DATE", "recipientId": 2738.54, "pageNumber": 5735.12, "pageX": 2936.28, "pageY": 8594.41, "width": 7589.39, "height": 3122.23}} responses: "200": - application/json: {"type": "NAME", "id": 3321.38, "secondaryId": "", "documentId": 7985.8, "templateId": 394.38, "recipientId": 8001.07, "page": 9090.42, "customText": "", "inserted": false, "fieldMeta": {"type": "checkbox"}} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "NAME", "id": 3321.38, "secondaryId": "", "recipientId": 8001.07, "page": 9090.42, "customText": "", "inserted": false, "fieldMeta": {"type": "checkbox", "direction": "vertical"}} "400": application/json: {"message": "", "code": ""} "500": @@ -2156,7 +2274,7 @@ examples: fieldId: 1152.82 responses: "200": - application/json: {"type": "TEXT", "id": 2979.32, "secondaryId": "", "documentId": 3596.91, "templateId": 6711.15, "recipientId": 6690.25, "page": 5824.69, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "TEXT", "id": 2979.32, "secondaryId": "", "recipientId": 6690.25, "page": 5824.69, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}} "400": application/json: {"message": "", "code": ""} "404": @@ -2169,7 +2287,7 @@ examples: application/json: {"templateId": 586.2, "fields": [{"type": "SIGNATURE", "recipientId": 6990.12, "pageNumber": 3472.45, "pageX": 4747.87, "pageY": 1673.94, "width": 7215.37, "height": 9417.43}]} responses: "200": - application/json: {"fields": [{"type": "CHECKBOX", "id": 7862.02, "secondaryId": "", "documentId": 6981.63, "templateId": 9898.46, "recipientId": 8274.39, "page": 3264.78, "customText": "", "inserted": true, "fieldMeta": {"type": "name"}}]} + application/json: {"fields": [{"envelopeId": "", "envelopeItemId": "", "type": "CHECKBOX", "id": 7862.02, "secondaryId": "", "recipientId": 8274.39, "page": 3264.78, "customText": "", "inserted": true, "fieldMeta": {"type": "name"}, "documentId": 6981.63, "templateId": 9898.46}]} "400": application/json: {"message": "", "code": ""} "500": @@ -2180,7 +2298,7 @@ examples: application/json: {"templateId": 5083.07, "field": {"type": "TEXT", "id": 1792.29}} responses: "200": - application/json: {"type": "CHECKBOX", "id": 5188.56, "secondaryId": "", "documentId": 9956.37, "templateId": 7914.68, "recipientId": 4165.02, "page": 9069.54, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}} + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "CHECKBOX", "id": 5188.56, "secondaryId": "", "recipientId": 4165.02, "page": 9069.54, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}} "400": application/json: {"message": "", "code": ""} "500": @@ -2191,7 +2309,7 @@ examples: application/json: {"templateId": 3969.1, "fields": [{"type": "DROPDOWN", "id": 2460.72}]} responses: "200": - application/json: {"fields": [{"type": "CHECKBOX", "id": 5681.05, "secondaryId": "", "documentId": 3141.26, "templateId": 6919.19, "recipientId": 3658.89, "page": 6460.06, "customText": "", "inserted": true, "fieldMeta": {"type": "initials"}}]} + application/json: {"fields": [{"envelopeId": "", "envelopeItemId": "", "type": "CHECKBOX", "id": 5681.05, "secondaryId": "", "recipientId": 3658.89, "page": 6460.06, "customText": "", "inserted": true, "fieldMeta": {"type": "initials"}, "documentId": 3141.26, "templateId": 6919.19}]} "400": application/json: {"message": "", "code": ""} "500": @@ -2214,7 +2332,7 @@ examples: recipientId: 9436.42 responses: "200": - application/json: {"role": "SIGNER", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 3084.26, "documentId": 9767.45, "templateId": 4075, "email": "Clovis_Stoltenberg@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": null, "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["EXPLICIT_NONE"]}, "signingOrder": 5048.3, "rejectionReason": null, "fields": [{"type": "DROPDOWN", "id": 1498.08, "secondaryId": "", "documentId": 3041.54, "templateId": 8898.39, "recipientId": 5421.45, "page": 5530.65, "customText": "", "inserted": false, "fieldMeta": {"type": "radio"}}]} + application/json: {"envelopeId": "", "role": "SIGNER", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "NOT_SENT", "id": 3084.26, "email": "Clovis_Stoltenberg@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": null, "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["EXPLICIT_NONE"]}, "signingOrder": 5048.3, "rejectionReason": null, "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "DROPDOWN", "id": 1498.08, "secondaryId": "", "recipientId": 5421.45, "page": 5530.65, "customText": "", "inserted": false, "fieldMeta": {"type": "radio"}, "documentId": 3041.54, "templateId": 8898.39}]} "400": application/json: {"message": "", "code": ""} "404": @@ -2227,7 +2345,7 @@ examples: application/json: {"templateId": 5712.95, "recipient": {"email": "Gerhard88@yahoo.com", "name": "", "role": "SIGNER"}} responses: "200": - application/json: {"role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 3391.15, "documentId": 1642.76, "templateId": 1072.6, "email": "Vida29@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": null, "signingOrder": 8644.53, "rejectionReason": ""} + application/json: {"envelopeId": "", "role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 3391.15, "email": "Vida29@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": null, "signingOrder": 8644.53, "rejectionReason": ""} "400": application/json: {"message": "", "code": ""} "500": @@ -2249,7 +2367,7 @@ examples: application/json: {"templateId": 2984.61, "recipient": {"id": 8617.99}} responses: "200": - application/json: {"role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 3174.79, "documentId": 149.88, "templateId": 5506.77, "email": "Esperanza_Moen@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["PASSKEY"]}, "signingOrder": 8121.07, "rejectionReason": null, "fields": [{"type": "DROPDOWN", "id": 6673.61, "secondaryId": "", "documentId": null, "templateId": null, "recipientId": 1427.37, "page": 6941.53, "customText": "", "inserted": false, "fieldMeta": {"type": "radio"}}]} + application/json: {"envelopeId": "", "role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 3174.79, "email": "Esperanza_Moen@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["PASSKEY"]}, "signingOrder": 8121.07, "rejectionReason": null, "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "DROPDOWN", "id": 6673.61, "secondaryId": "", "recipientId": 1427.37, "page": 6941.53, "customText": "", "inserted": false, "fieldMeta": {"type": "radio"}, "documentId": null, "templateId": null}]} "400": application/json: {"message": "", "code": ""} "500": @@ -2260,7 +2378,7 @@ examples: application/json: {"templateId": 5597.58, "recipients": [{"id": 1630.42}]} responses: "200": - application/json: {"recipients": [{"role": "CC", "readStatus": "NOT_OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 653.82, "documentId": 3004.48, "templateId": null, "email": "Ramona58@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": null, "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["EXPLICIT_NONE"]}, "signingOrder": 8960.7, "rejectionReason": "", "fields": []}]} + application/json: {"recipients": [{"envelopeId": "", "role": "CC", "readStatus": "NOT_OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 653.82, "email": "Ramona58@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": null, "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["EXPLICIT_NONE"]}, "signingOrder": 8960.7, "rejectionReason": "", "fields": [], "documentId": 3004.48, "templateId": null}]} "400": application/json: {"message": "", "code": ""} "500": @@ -2282,7 +2400,7 @@ examples: application/json: {"templateId": 5094.31} responses: "200": - application/json: {"id": "", "templateId": 9525.52, "token": "", "createdAt": "1721338708803", "enabled": true, "directTemplateRecipientId": 892.62} + application/json: {"id": "", "token": "", "createdAt": "1721338708803", "enabled": true, "directTemplateRecipientId": 892.62, "envelopeId": "", "templateId": 9525.52} "400": application/json: {"message": "", "code": ""} "500": @@ -2304,7 +2422,7 @@ examples: application/json: {"templateId": 6583.54, "enabled": false} responses: "200": - application/json: {"id": "", "templateId": 3373.72, "token": "", "createdAt": "1718653442722", "enabled": false, "directTemplateRecipientId": 6029.67} + application/json: {"id": "", "token": "", "createdAt": "1718653442722", "enabled": false, "directTemplateRecipientId": 6029.67, "envelopeId": "", "templateId": 3373.72} "400": application/json: {"message": "", "code": ""} "500": @@ -2331,6 +2449,116 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + document-get: + speakeasy-default-document-get: + parameters: + path: + documentId: 6150.61 + responses: + "200": + application/json: {"visibility": "MANAGER_AND_ABOVE", "status": "COMPLETED", "source": "TEMPLATE_DIRECT_LINK", "id": 790.23, "externalId": "", "userId": 6931.1, "authOptions": {"globalAccessAuth": [], "globalActionAuth": ["PASSWORD"]}, "formValues": {"key": true}, "title": "", "createdAt": "1711154896799", "updatedAt": "1735666806591", "completedAt": "", "deletedAt": "", "teamId": 3827.21, "folderId": "", "envelopeId": "", "documentDataId": "", "documentData": {"type": "BYTES", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "documentMeta": {"signingOrder": "PARALLEL", "distributionMethod": "NONE", "id": "", "subject": "", "message": "", "timezone": "Europe/Riga", "dateFormat": "", "redirectUrl": "https://vain-bungalow.org", "typedSignatureEnabled": false, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": false, "language": "", "emailSettings": null, "emailId": null, "emailReplyTo": "", "password": null, "documentId": -1}, "folder": {"id": "", "name": "", "type": "DOCUMENT", "visibility": "ADMIN", "userId": 5921.96, "teamId": 8072.54, "pinned": false, "parentId": null, "createdAt": "1713490499102", "updatedAt": "1735685068441"}, "recipients": [], "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "RADIO", "id": 5425.59, "secondaryId": "", "recipientId": 7294.47, "page": 7862.41, "customText": "", "inserted": false, "fieldMeta": {"type": "number"}}]} + "400": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-find: + speakeasy-default-document-find: + parameters: + query: + orderByDirection: "desc" + responses: + "200": + application/json: {"data": [{"visibility": "MANAGER_AND_ABOVE", "status": "DRAFT", "source": "TEMPLATE_DIRECT_LINK", "id": 7654.95, "externalId": "", "userId": 7633.68, "authOptions": {"globalAccessAuth": ["ACCOUNT"], "globalActionAuth": []}, "formValues": {}, "title": "", "createdAt": "1727038710195", "updatedAt": "1735623651736", "completedAt": "", "deletedAt": "", "teamId": 4974.29, "folderId": "", "useLegacyFieldInsertion": true, "envelopeId": "", "documentDataId": "", "user": {"id": 5236.27, "name": "", "email": "Jasper94@gmail.com"}, "recipients": [{"envelopeId": "", "role": "ASSISTANT", "readStatus": "OPENED", "signingStatus": "NOT_SIGNED", "sendStatus": "SENT", "id": 8051.23, "email": "Abelardo76@yahoo.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": [], "actionAuth": ["PASSWORD"]}, "signingOrder": 3283.21, "rejectionReason": ""}], "team": {"id": 9905.87, "url": "https://ethical-experience.com/"}}], "count": 1256.25, "currentPage": 9643.96, "perPage": 6162.13, "totalPages": 1918.85} + "400": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-update: + speakeasy-default-document-update: + requestBody: + application/json: {"documentId": 3428.95} + responses: + "200": + application/json: {"visibility": "EVERYONE", "status": "COMPLETED", "source": "TEMPLATE_DIRECT_LINK", "id": 3519.03, "externalId": null, "userId": 7295.76, "authOptions": {"globalAccessAuth": ["TWO_FACTOR_AUTH"], "globalActionAuth": []}, "formValues": {"key": 2836.38}, "title": "", "createdAt": "1715198116202", "updatedAt": "1735678172451", "completedAt": null, "deletedAt": "", "teamId": 6211.31, "folderId": null, "useLegacyFieldInsertion": true, "envelopeId": "", "documentDataId": ""} + "400": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-delete: + speakeasy-default-document-delete: + requestBody: + application/json: {"documentId": 3963.4} + responses: + "200": + application/json: {"success": false} + "400": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-duplicate: + speakeasy-default-document-duplicate: + requestBody: + application/json: {"documentId": 5285.3} + responses: + "200": + application/json: {"id": "", "documentId": 1846.9} + "400": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-distribute: + speakeasy-default-document-distribute: + requestBody: + application/json: {"documentId": 7548.74} + responses: + "200": + application/json: {"visibility": "MANAGER_AND_ABOVE", "status": "DRAFT", "source": "TEMPLATE", "id": 4202.33, "externalId": "", "userId": 139.61, "authOptions": {"globalAccessAuth": ["TWO_FACTOR_AUTH"], "globalActionAuth": []}, "formValues": {"key": 3939.25}, "title": "", "createdAt": "1711393054424", "updatedAt": "1735639958766", "completedAt": "", "deletedAt": "", "teamId": 3513.5, "folderId": "", "useLegacyFieldInsertion": false, "envelopeId": "", "documentDataId": ""} + "400": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-redistribute: + speakeasy-default-document-redistribute: + requestBody: + application/json: {"documentId": 9084.69, "recipients": [6011.8, 4441.56, 4251.15]} + responses: + "200": + application/json: {"success": false} + "400": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-download: + speakeasy-default-document-download: + parameters: + path: + documentId: 5396.97 + query: + version: "signed" + responses: + "200": + application/json: {"downloadUrl": "https://mundane-parsnip.net", "filename": "example.file", "contentType": ""} + "400": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + template-createTemplateTemporary: + speakeasy-default-template-create-template-temporary: + requestBody: + application/json: {"title": ""} + responses: + "200": + application/json: {"template": {"type": "PUBLIC", "visibility": "ADMIN", "id": 8391.69, "externalId": "", "title": "", "userId": 6247.95, "teamId": 5122.65, "authOptions": {"globalAccessAuth": ["TWO_FACTOR_AUTH"], "globalActionAuth": ["PASSKEY"]}, "createdAt": "1730629200797", "updatedAt": "1735624064163", "publicTitle": "", "publicDescription": "", "folderId": "", "envelopeId": "", "templateDocumentDataId": "", "templateDocumentData": {"type": "BYTES_64", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "templateMeta": {"id": "", "subject": "", "message": "", "timezone": "Asia/Sakhalin", "dateFormat": "", "signingOrder": "SEQUENTIAL", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": true, "allowDictateNextSigner": false, "distributionMethod": "EMAIL", "redirectUrl": "https://grave-circumference.org", "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": "", "templateId": 8644.62}, "directLink": {"id": "", "envelopeId": "", "token": "", "createdAt": "1731294026083", "enabled": false, "directTemplateRecipientId": 8884.73, "templateId": 697.57}, "user": {"id": 1951.08, "name": "", "email": "Irving.Wilderman49@yahoo.com"}, "recipients": [], "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "FREE_SIGNATURE", "id": 7540.28, "secondaryId": "", "recipientId": 8834.46, "page": 4328.3, "customText": "", "inserted": true, "fieldMeta": null}], "folder": null}, "uploadUrl": "https://last-glider.biz/"} + "400": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} examplesVersion: 1.0.2 generatedTests: {} -releaseNotes: "## SDK Changes Detected:\n* `documenso.documents.recipients.update()`: \n * `request.recipient` **Changed** **Breaking** :warning:\n * `response.auth_options` **Changed** **Breaking** :warning:\n* `documenso.documents.create_v0()`: \n * `request` **Changed** **Breaking** :warning:\n * `response.document` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.update_many()`: \n * `request.recipients.[]` **Changed** **Breaking** :warning:\n * `response.recipients.[].auth_options` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.update()`: \n * `request.recipient` **Changed** **Breaking** :warning:\n * `response.auth_options` **Changed** **Breaking** :warning:\n* `documenso.documents.find()`: \n * `request.folder_id` **Added**\n * `response.data.[]` **Changed** **Breaking** :warning:\n* `documenso.documents.get()`: \n * `request.folder_id` **Added**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.documents.recipients.create_many()`: \n * `request.recipients.[]` **Changed** **Breaking** :warning:\n * `response.recipients.[].auth_options` **Changed** **Breaking** :warning:\n* `documenso.documents.update()`: \n * `request.data` **Changed** **Breaking** :warning:\n * `response` **Changed** **Breaking** :warning:\n* `documenso.documents.distribute()`: `response` **Changed** **Breaking** :warning:\n* `documenso.documents.recipients.get()`: `response.auth_options` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.create_many()`: \n * `request.recipients.[]` **Changed** **Breaking** :warning:\n * `response.recipients.[].auth_options` **Changed** **Breaking** :warning:\n* `documenso.documents.recipients.create()`: \n * `request.recipient` **Changed** **Breaking** :warning:\n * `response.auth_options` **Changed** **Breaking** :warning:\n* `documenso.templates.update()`: \n * `request.data` **Changed** **Breaking** :warning:\n * `response` **Changed** **Breaking** :warning:\n* `documenso.documents.recipients.update_many()`: \n * `request.recipients.[]` **Changed** **Breaking** :warning:\n * `response.recipients.[].auth_options` **Changed** **Breaking** :warning:\n* `documenso.templates.find()`: \n * `request.folder_id` **Added**\n * `response.data.[]` **Changed** **Breaking** :warning:\n* `documenso.templates.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.create()`: \n * `request.recipient` **Changed** **Breaking** :warning:\n * `response.auth_options` **Changed** **Breaking** :warning:\n* `documenso.templates.duplicate()`: `response` **Changed** **Breaking** :warning:\n* `documenso.templates.use()`: \n * `request.prefill_fields.[].[class]` **Added**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.get()`: `response.auth_options` **Changed** **Breaking** :warning:\n* `documenso.embedding.embedding_presign-create_embedding_presign_token()`: **Added**\n* `documenso.embedding.embedding_presign-verify_embedding_presign_token()`: **Added**\n* `documenso.templates.move_to_team()`: **Deleted** **Breaking** :warning:\n* `documenso.documents.move_to_team()`: **Deleted** **Breaking** :warning:\n" +releaseNotes: "## Python SDK Changes Detected:\n* `documenso.documents.recipients.update()`: `response` **Changed** **Breaking** :warning:\n* `documenso.documents.recipients.update_many()`: `response.recipients.[]` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.update_many()`: `response.recipients.[]` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.update()`: `response` **Changed** **Breaking** :warning:\n* `documenso.documents.get()`: \n * `request.folder_id` **Removed** **Breaking** :warning:\n * `response` **Changed** **Breaking** :warning:\n* `documenso.documents.create_v0()`: \n * `request` **Changed**\n * `response.document` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.templates.fields.update_many()`: \n * `request.fields.[].[class].field_meta` **Changed**\n * `response.fields.[]` **Changed** **Breaking** :warning:\n* `documenso.documents.fields.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.documents.fields.create()`: \n * `request.field.[class].field_meta` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.documents.fields.create_many()`: \n * `request.fields.[].[class].field_meta` **Changed**\n * `response.fields.[]` **Changed** **Breaking** :warning:\n* `documenso.documents.fields.update()`: \n * `request.field.[class].field_meta` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.documents.fields.update_many()`: \n * `request.fields.[].[class].field_meta` **Changed**\n * `response.fields.[]` **Changed** **Breaking** :warning:\n* `documenso.documents.recipients.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.templates.fields.update()`: \n * `request.field.[class].field_meta` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.templates.fields.create_many()`: \n * `request.fields.[].[class].field_meta` **Changed**\n * `response.fields.[]` **Changed** **Breaking** :warning:\n* `documenso.templates.fields.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.templates.fields.create()`: \n * `request.field.[class].field_meta` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.templates.find()`: `response.data.[]` **Changed** **Breaking** :warning:\n* `documenso.templates.get()`: `response` **Changed** **Breaking** :warning:\n* `documenso.templates.use()`: \n * `request` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `documenso.templates.recipients.create_many()`: `response.recipients.[]` **Changed**\n* `documenso.templates.direct_link.create()`: `response.envelope_id` **Added**\n* `documenso.document.document-download()`: **Added**\n* `documenso.template.template-create_template_temporary()`: **Added**\n* `documenso.documents.recipients.create_many()`: `response.recipients.[]` **Changed**\n* `documenso.templates.duplicate()`: `response` **Changed**\n* `documenso.templates.recipients.create()`: `response` **Changed**\n* `documenso.documents.distribute()`: \n * `request.meta` **Changed**\n * `response` **Changed**\n* `documenso.templates.update()`: \n * `request` **Changed**\n * `response` **Changed**\n* `documenso.documents.duplicate()`: `response.id` **Added**\n* `documenso.documents.find()`: `response.data.[]` **Changed**\n* `documenso.documents.update()`: \n * `request` **Changed**\n * `response` **Changed**\n* `documenso.documents.recipients.create()`: `response` **Changed**\n* `documenso.templates.direct_link.toggle()`: `response.envelope_id` **Added**\n" diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 1fa09df..3df396e 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -19,18 +19,23 @@ generation: auth: oAuth2ClientCredentialsEnabled: false oAuth2PasswordEnabled: false + hoistGlobalSecurity: true + schemas: + allOfMergeStrategy: shallowMerge + requestBodyFieldName: "" tests: generateTests: true generateNewTests: false skipResponseBodyAssertions: false python: - version: 0.3.0 + version: 0.4.0 additionalDependencies: dev: {} main: {} allowedRedefinedBuiltins: - id - object + asyncMode: both authors: - Speakeasy baseErrorName: DocumensoError @@ -54,6 +59,7 @@ python: shared: "" webhooks: "" inputModelSuffix: input + legacyPyright: true maxMethodParams: 999 methodArguments: infer-optional-args moduleName: "" @@ -63,4 +69,5 @@ python: pytestFilterWarnings: [] pytestTimeout: 0 responseFormat: flat + sseFlatResponse: false templateVersion: v2 diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index f4389dd..067b6fb 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,20 +1,20 @@ -speakeasyVersion: 1.606.10 +speakeasyVersion: 1.650.0 sources: documenso-OAS: sourceNamespace: documenso-v-2-beta-api - sourceRevisionDigest: sha256:edad9cc20eb56ca39753b7a96c8c75f876e716df520da392bd8aab9dac31f0f9 - sourceBlobDigest: sha256:03b086614aed59a736a1a84f96e719f587b3fe7c599647320f711b19c6e7a586 + sourceRevisionDigest: sha256:5655c327963c859a6b2690d2f07ff5a14c557dae975710c55e1e94a3a8ca03c5 + sourceBlobDigest: sha256:628fee4fefdec824deaa24deaf158a9f7e61fea8a997f4e39e47dca425903deb tags: - latest - - speakeasy-sdk-regen-1751415201 + - speakeasy-sdk-regen-1761013204 targets: documenso: source: documenso-OAS sourceNamespace: documenso-v-2-beta-api - sourceRevisionDigest: sha256:edad9cc20eb56ca39753b7a96c8c75f876e716df520da392bd8aab9dac31f0f9 - sourceBlobDigest: sha256:03b086614aed59a736a1a84f96e719f587b3fe7c599647320f711b19c6e7a586 + sourceRevisionDigest: sha256:5655c327963c859a6b2690d2f07ff5a14c557dae975710c55e1e94a3a8ca03c5 + sourceBlobDigest: sha256:628fee4fefdec824deaa24deaf158a9f7e61fea8a997f4e39e47dca425903deb codeSamplesNamespace: documenso-oas-python-code-samples - codeSamplesRevisionDigest: sha256:db0a037286d8310ff53552a5aae4c5f7b9cd7a833eac6b4a19c3fd9c4cb4de26 + codeSamplesRevisionDigest: sha256:53f618cc489932a12c726e56679c21857f6fcf990eb82978223a629e9a5f9b68 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README-PYPI.md b/README-PYPI.md index 6afead6..6b7cc28 100644 --- a/README-PYPI.md +++ b/README-PYPI.md @@ -245,17 +245,20 @@ if __name__ == "__main__":
Available methods +### [document](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documentsdk/README.md) + +* [document_download](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documentsdk/README.md#document_download) - Download document (beta) ### [documents](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md) -* [update](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#update) - Update document -* [find](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#find) - Find documents * [get](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#get) - Get document -* [create_v0](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#create_v0) - Create document +* [find](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#find) - Find documents +* [update](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#update) - Update document * [delete](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#delete) - Delete document +* [duplicate](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#duplicate) - Duplicate document * [distribute](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#distribute) - Distribute document * [redistribute](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#redistribute) - Redistribute document -* [duplicate](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#duplicate) - Duplicate document +* [create_v0](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#create_v0) - Create document #### [documents.fields](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documentsfields/README.md) @@ -280,6 +283,10 @@ if __name__ == "__main__": * [embedding_presign_create_embedding_presign_token](https://github.com/documenso/sdk-python/blob/master/docs/sdks/embedding/README.md#embedding_presign_create_embedding_presign_token) - Create embedding presign token * [embedding_presign_verify_embedding_presign_token](https://github.com/documenso/sdk-python/blob/master/docs/sdks/embedding/README.md#embedding_presign_verify_embedding_presign_token) - Verify embedding presign token +### [template](https://github.com/documenso/sdk-python/blob/master/docs/sdks/templatesdk/README.md) + +* [template_create_template_temporary](https://github.com/documenso/sdk-python/blob/master/docs/sdks/templatesdk/README.md#template_create_template_temporary) - Create template + ### [templates](https://github.com/documenso/sdk-python/blob/master/docs/sdks/templates/README.md) * [find](https://github.com/documenso/sdk-python/blob/master/docs/sdks/templates/README.md#find) - Find templates @@ -332,7 +339,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92, + res = documenso.documents.get(document_id=6150.61, RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False)) # Handle response @@ -352,7 +359,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92) + res = documenso.documents.get(document_id=6150.61) # Handle response print(res) @@ -387,7 +394,7 @@ with Documenso( res = None try: - res = documenso.documents.update(document_id=9701.92) + res = documenso.documents.get(document_id=6150.61) # Handle response print(res) @@ -402,17 +409,17 @@ with Documenso( print(e.raw_response) # Depending on the method different errors may be thrown - if isinstance(e, models.DocumentUpdateDocumentBadRequestError): + if isinstance(e, models.DocumentGetBadRequestError): print(e.data.message) # str print(e.data.code) # str - print(e.data.issues) # Optional[List[documenso_sdk.DocumentUpdateDocumentBadRequestIssue]] + print(e.data.issues) # Optional[List[documenso_sdk.DocumentGetBadRequestIssue]] ``` ### Error Classes **Primary error:** * [`DocumensoError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documensoerror.py): The base class for HTTP error responses. -
Less common errors (99) +
Less common errors (104)
@@ -423,100 +430,105 @@ with Documenso( **Inherit from [`DocumensoError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documensoerror.py)**: -* [`DocumentUpdateDocumentBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentupdatedocumentbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentFindDocumentsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentfinddocumentsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentGetDocumentWithDetailsByIDBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentgetdocumentwithdetailsbyidbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentCreateDocumentTemporaryBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentcreatedocumenttemporarybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentDeleteDocumentBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdeletedocumentbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentSendDocumentBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentsenddocumentbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentResendDocumentBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentresenddocumentbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentDuplicateDocumentBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentduplicatedocumentbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateFindTemplatesBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatefindtemplatesbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateGetTemplateByIDBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templategettemplatebyidbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateUpdateTemplateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateupdatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateDuplicateTemplateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateduplicatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateDeleteTemplateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateCreateDocumentFromTemplateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatedocumentfromtemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokenbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokenbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldGetDocumentFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgetdocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldCreateDocumentFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldCreateDocumentFieldsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldUpdateDocumentFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldUpdateDocumentFieldsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldDeleteDocumentFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientGetDocumentRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgetdocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientCreateDocumentRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientCreateDocumentRecipientsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateDocumentRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateDocumentRecipientsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientDeleteDocumentRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldCreateTemplateFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldGetTemplateFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgettemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldCreateTemplateFieldsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldUpdateTemplateFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldUpdateTemplateFieldsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldDeleteTemplateFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientGetTemplateRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgettemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientCreateTemplateRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientCreateTemplateRecipientsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateTemplateRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateTemplateRecipientsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientDeleteTemplateRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateCreateTemplateDirectLinkBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateDeleteTemplateDirectLinkBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateToggleTemplateDirectLinkBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatetoggletemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentFindDocumentsNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentfinddocumentsnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`DocumentGetDocumentWithDetailsByIDNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentgetdocumentwithdetailsbyidnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`TemplateFindTemplatesNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatefindtemplatesnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`TemplateGetTemplateByIDNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templategettemplatebyidnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`FieldGetDocumentFieldNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgetdocumentfieldnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`RecipientGetDocumentRecipientNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgetdocumentrecipientnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`FieldGetTemplateFieldNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgettemplatefieldnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`RecipientGetTemplateRecipientNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgettemplaterecipientnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`DocumentUpdateDocumentInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentupdatedocumentinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentFindDocumentsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentfinddocumentsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentGetDocumentWithDetailsByIDInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentgetdocumentwithdetailsbyidinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentCreateDocumentTemporaryInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentcreatedocumenttemporaryinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentDeleteDocumentInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdeletedocumentinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentSendDocumentInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentsenddocumentinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentResendDocumentInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentresenddocumentinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentDuplicateDocumentInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentduplicatedocumentinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateFindTemplatesInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatefindtemplatesinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateGetTemplateByIDInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templategettemplatebyidinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateUpdateTemplateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateupdatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateDuplicateTemplateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateduplicatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateDeleteTemplateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateCreateDocumentFromTemplateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatedocumentfromtemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokeninternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokeninternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldGetDocumentFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgetdocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldCreateDocumentFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldCreateDocumentFieldsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldUpdateDocumentFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldUpdateDocumentFieldsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldDeleteDocumentFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientGetDocumentRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgetdocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientCreateDocumentRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientCreateDocumentRecipientsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateDocumentRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateDocumentRecipientsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientDeleteDocumentRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldCreateTemplateFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldGetTemplateFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgettemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldCreateTemplateFieldsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldUpdateTemplateFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldUpdateTemplateFieldsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldDeleteTemplateFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientGetTemplateRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgettemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientCreateTemplateRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientCreateTemplateRecipientsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateTemplateRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateTemplateRecipientsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientDeleteTemplateRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateCreateTemplateDirectLinkInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateDeleteTemplateDirectLinkInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateToggleTemplateDirectLinkInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatetoggletemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* +* [`DocumentGetBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentgetbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentFindBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentfindbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentUpdateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentupdatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentDeleteBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentDuplicateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentduplicatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentDistributeBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdistributebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentRedistributeBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentredistributebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentCreateDocumentTemporaryBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentcreatedocumenttemporarybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentDownloadBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdownloadbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateFindTemplatesBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatefindtemplatesbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateGetTemplateByIDBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templategettemplatebyidbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateUpdateTemplateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateupdatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateDuplicateTemplateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateduplicatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateDeleteTemplateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateCreateDocumentFromTemplateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatedocumentfromtemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateCreateTemplateTemporaryBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatetemporarybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokenbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokenbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldGetDocumentFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgetdocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldCreateDocumentFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldCreateDocumentFieldsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldUpdateDocumentFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldUpdateDocumentFieldsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldDeleteDocumentFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientGetDocumentRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgetdocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientCreateDocumentRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientCreateDocumentRecipientsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateDocumentRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateDocumentRecipientsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientDeleteDocumentRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldCreateTemplateFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldGetTemplateFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgettemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldCreateTemplateFieldsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldUpdateTemplateFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldUpdateTemplateFieldsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldDeleteTemplateFieldBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientGetTemplateRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgettemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientCreateTemplateRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientCreateTemplateRecipientsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateTemplateRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateTemplateRecipientsBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientDeleteTemplateRecipientBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateCreateTemplateDirectLinkBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateDeleteTemplateDirectLinkBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateToggleTemplateDirectLinkBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatetoggletemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentGetNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentgetnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`DocumentFindNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentfindnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`DocumentDownloadNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdownloadnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`TemplateFindTemplatesNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatefindtemplatesnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`TemplateGetTemplateByIDNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templategettemplatebyidnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`FieldGetDocumentFieldNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgetdocumentfieldnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`RecipientGetDocumentRecipientNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgetdocumentrecipientnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`FieldGetTemplateFieldNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgettemplatefieldnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`RecipientGetTemplateRecipientNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgettemplaterecipientnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`DocumentGetInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentgetinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentFindInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentfindinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentUpdateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentupdateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentDeleteInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentDuplicateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentduplicateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentDistributeInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdistributeinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentRedistributeInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentredistributeinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentCreateDocumentTemporaryInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentcreatedocumenttemporaryinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentDownloadInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdownloadinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateFindTemplatesInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatefindtemplatesinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateGetTemplateByIDInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templategettemplatebyidinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateUpdateTemplateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateupdatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateDuplicateTemplateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateduplicatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateDeleteTemplateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateCreateDocumentFromTemplateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatedocumentfromtemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateCreateTemplateTemporaryInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatetemporaryinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokeninternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokeninternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldGetDocumentFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgetdocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldCreateDocumentFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldCreateDocumentFieldsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldUpdateDocumentFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldUpdateDocumentFieldsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldDeleteDocumentFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientGetDocumentRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgetdocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientCreateDocumentRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientCreateDocumentRecipientsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateDocumentRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateDocumentRecipientsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientDeleteDocumentRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldCreateTemplateFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldGetTemplateFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgettemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldCreateTemplateFieldsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldUpdateTemplateFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldUpdateTemplateFieldsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldDeleteTemplateFieldInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientGetTemplateRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgettemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientCreateTemplateRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientCreateTemplateRecipientsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateTemplateRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateTemplateRecipientsInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientDeleteTemplateRecipientInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateCreateTemplateDirectLinkInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateDeleteTemplateDirectLinkInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateToggleTemplateDirectLinkInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatetoggletemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* * [`ResponseValidationError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
@@ -540,7 +552,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92) + res = documenso.documents.get(document_id=6150.61) # Handle response print(res) diff --git a/README.md b/README.md index 15d171d..a3678d0 100644 --- a/README.md +++ b/README.md @@ -245,17 +245,20 @@ if __name__ == "__main__":
Available methods +### [document](docs/sdks/documentsdk/README.md) + +* [document_download](docs/sdks/documentsdk/README.md#document_download) - Download document (beta) ### [documents](docs/sdks/documents/README.md) -* [update](docs/sdks/documents/README.md#update) - Update document -* [find](docs/sdks/documents/README.md#find) - Find documents * [get](docs/sdks/documents/README.md#get) - Get document -* [create_v0](docs/sdks/documents/README.md#create_v0) - Create document +* [find](docs/sdks/documents/README.md#find) - Find documents +* [update](docs/sdks/documents/README.md#update) - Update document * [delete](docs/sdks/documents/README.md#delete) - Delete document +* [duplicate](docs/sdks/documents/README.md#duplicate) - Duplicate document * [distribute](docs/sdks/documents/README.md#distribute) - Distribute document * [redistribute](docs/sdks/documents/README.md#redistribute) - Redistribute document -* [duplicate](docs/sdks/documents/README.md#duplicate) - Duplicate document +* [create_v0](docs/sdks/documents/README.md#create_v0) - Create document #### [documents.fields](docs/sdks/documentsfields/README.md) @@ -280,6 +283,10 @@ if __name__ == "__main__": * [embedding_presign_create_embedding_presign_token](docs/sdks/embedding/README.md#embedding_presign_create_embedding_presign_token) - Create embedding presign token * [embedding_presign_verify_embedding_presign_token](docs/sdks/embedding/README.md#embedding_presign_verify_embedding_presign_token) - Verify embedding presign token +### [template](docs/sdks/templatesdk/README.md) + +* [template_create_template_temporary](docs/sdks/templatesdk/README.md#template_create_template_temporary) - Create template + ### [templates](docs/sdks/templates/README.md) * [find](docs/sdks/templates/README.md#find) - Find templates @@ -332,7 +339,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92, + res = documenso.documents.get(document_id=6150.61, RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False)) # Handle response @@ -352,7 +359,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92) + res = documenso.documents.get(document_id=6150.61) # Handle response print(res) @@ -387,7 +394,7 @@ with Documenso( res = None try: - res = documenso.documents.update(document_id=9701.92) + res = documenso.documents.get(document_id=6150.61) # Handle response print(res) @@ -402,17 +409,17 @@ with Documenso( print(e.raw_response) # Depending on the method different errors may be thrown - if isinstance(e, models.DocumentUpdateDocumentBadRequestError): + if isinstance(e, models.DocumentGetBadRequestError): print(e.data.message) # str print(e.data.code) # str - print(e.data.issues) # Optional[List[documenso_sdk.DocumentUpdateDocumentBadRequestIssue]] + print(e.data.issues) # Optional[List[documenso_sdk.DocumentGetBadRequestIssue]] ``` ### Error Classes **Primary error:** * [`DocumensoError`](./src/documenso_sdk/models/documensoerror.py): The base class for HTTP error responses. -
Less common errors (99) +
Less common errors (104)
@@ -423,100 +430,105 @@ with Documenso( **Inherit from [`DocumensoError`](./src/documenso_sdk/models/documensoerror.py)**: -* [`DocumentUpdateDocumentBadRequestError`](./src/documenso_sdk/models/documentupdatedocumentbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentFindDocumentsBadRequestError`](./src/documenso_sdk/models/documentfinddocumentsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentGetDocumentWithDetailsByIDBadRequestError`](./src/documenso_sdk/models/documentgetdocumentwithdetailsbyidbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentCreateDocumentTemporaryBadRequestError`](./src/documenso_sdk/models/documentcreatedocumenttemporarybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentDeleteDocumentBadRequestError`](./src/documenso_sdk/models/documentdeletedocumentbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentSendDocumentBadRequestError`](./src/documenso_sdk/models/documentsenddocumentbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentResendDocumentBadRequestError`](./src/documenso_sdk/models/documentresenddocumentbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentDuplicateDocumentBadRequestError`](./src/documenso_sdk/models/documentduplicatedocumentbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateFindTemplatesBadRequestError`](./src/documenso_sdk/models/templatefindtemplatesbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateGetTemplateByIDBadRequestError`](./src/documenso_sdk/models/templategettemplatebyidbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateUpdateTemplateBadRequestError`](./src/documenso_sdk/models/templateupdatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateDuplicateTemplateBadRequestError`](./src/documenso_sdk/models/templateduplicatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateDeleteTemplateBadRequestError`](./src/documenso_sdk/models/templatedeletetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateCreateDocumentFromTemplateBadRequestError`](./src/documenso_sdk/models/templatecreatedocumentfromtemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError`](./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokenbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError`](./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokenbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldGetDocumentFieldBadRequestError`](./src/documenso_sdk/models/fieldgetdocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldCreateDocumentFieldBadRequestError`](./src/documenso_sdk/models/fieldcreatedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldCreateDocumentFieldsBadRequestError`](./src/documenso_sdk/models/fieldcreatedocumentfieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldUpdateDocumentFieldBadRequestError`](./src/documenso_sdk/models/fieldupdatedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldUpdateDocumentFieldsBadRequestError`](./src/documenso_sdk/models/fieldupdatedocumentfieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldDeleteDocumentFieldBadRequestError`](./src/documenso_sdk/models/fielddeletedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientGetDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientgetdocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientCreateDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientCreateDocumentRecipientsBadRequestError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateDocumentRecipientsBadRequestError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientDeleteDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientdeletedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldCreateTemplateFieldBadRequestError`](./src/documenso_sdk/models/fieldcreatetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldGetTemplateFieldBadRequestError`](./src/documenso_sdk/models/fieldgettemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldCreateTemplateFieldsBadRequestError`](./src/documenso_sdk/models/fieldcreatetemplatefieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldUpdateTemplateFieldBadRequestError`](./src/documenso_sdk/models/fieldupdatetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldUpdateTemplateFieldsBadRequestError`](./src/documenso_sdk/models/fieldupdatetemplatefieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`FieldDeleteTemplateFieldBadRequestError`](./src/documenso_sdk/models/fielddeletetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientGetTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientgettemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientCreateTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientCreateTemplateRecipientsBadRequestError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateTemplateRecipientsBadRequestError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`RecipientDeleteTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientdeletetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateCreateTemplateDirectLinkBadRequestError`](./src/documenso_sdk/models/templatecreatetemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateDeleteTemplateDirectLinkBadRequestError`](./src/documenso_sdk/models/templatedeletetemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`TemplateToggleTemplateDirectLinkBadRequestError`](./src/documenso_sdk/models/templatetoggletemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 43 methods.* -* [`DocumentFindDocumentsNotFoundError`](./src/documenso_sdk/models/documentfinddocumentsnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`DocumentGetDocumentWithDetailsByIDNotFoundError`](./src/documenso_sdk/models/documentgetdocumentwithdetailsbyidnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`TemplateFindTemplatesNotFoundError`](./src/documenso_sdk/models/templatefindtemplatesnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`TemplateGetTemplateByIDNotFoundError`](./src/documenso_sdk/models/templategettemplatebyidnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`FieldGetDocumentFieldNotFoundError`](./src/documenso_sdk/models/fieldgetdocumentfieldnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`RecipientGetDocumentRecipientNotFoundError`](./src/documenso_sdk/models/recipientgetdocumentrecipientnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`FieldGetTemplateFieldNotFoundError`](./src/documenso_sdk/models/fieldgettemplatefieldnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`RecipientGetTemplateRecipientNotFoundError`](./src/documenso_sdk/models/recipientgettemplaterecipientnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 43 methods.* -* [`DocumentUpdateDocumentInternalServerError`](./src/documenso_sdk/models/documentupdatedocumentinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentFindDocumentsInternalServerError`](./src/documenso_sdk/models/documentfinddocumentsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentGetDocumentWithDetailsByIDInternalServerError`](./src/documenso_sdk/models/documentgetdocumentwithdetailsbyidinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentCreateDocumentTemporaryInternalServerError`](./src/documenso_sdk/models/documentcreatedocumenttemporaryinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentDeleteDocumentInternalServerError`](./src/documenso_sdk/models/documentdeletedocumentinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentSendDocumentInternalServerError`](./src/documenso_sdk/models/documentsenddocumentinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentResendDocumentInternalServerError`](./src/documenso_sdk/models/documentresenddocumentinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`DocumentDuplicateDocumentInternalServerError`](./src/documenso_sdk/models/documentduplicatedocumentinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateFindTemplatesInternalServerError`](./src/documenso_sdk/models/templatefindtemplatesinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateGetTemplateByIDInternalServerError`](./src/documenso_sdk/models/templategettemplatebyidinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateUpdateTemplateInternalServerError`](./src/documenso_sdk/models/templateupdatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateDuplicateTemplateInternalServerError`](./src/documenso_sdk/models/templateduplicatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateDeleteTemplateInternalServerError`](./src/documenso_sdk/models/templatedeletetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateCreateDocumentFromTemplateInternalServerError`](./src/documenso_sdk/models/templatecreatedocumentfromtemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError`](./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokeninternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError`](./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokeninternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldGetDocumentFieldInternalServerError`](./src/documenso_sdk/models/fieldgetdocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldCreateDocumentFieldInternalServerError`](./src/documenso_sdk/models/fieldcreatedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldCreateDocumentFieldsInternalServerError`](./src/documenso_sdk/models/fieldcreatedocumentfieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldUpdateDocumentFieldInternalServerError`](./src/documenso_sdk/models/fieldupdatedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldUpdateDocumentFieldsInternalServerError`](./src/documenso_sdk/models/fieldupdatedocumentfieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldDeleteDocumentFieldInternalServerError`](./src/documenso_sdk/models/fielddeletedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientGetDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientgetdocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientCreateDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientCreateDocumentRecipientsInternalServerError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateDocumentRecipientsInternalServerError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientDeleteDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientdeletedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldCreateTemplateFieldInternalServerError`](./src/documenso_sdk/models/fieldcreatetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldGetTemplateFieldInternalServerError`](./src/documenso_sdk/models/fieldgettemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldCreateTemplateFieldsInternalServerError`](./src/documenso_sdk/models/fieldcreatetemplatefieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldUpdateTemplateFieldInternalServerError`](./src/documenso_sdk/models/fieldupdatetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldUpdateTemplateFieldsInternalServerError`](./src/documenso_sdk/models/fieldupdatetemplatefieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`FieldDeleteTemplateFieldInternalServerError`](./src/documenso_sdk/models/fielddeletetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientGetTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientgettemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientCreateTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientCreateTemplateRecipientsInternalServerError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientUpdateTemplateRecipientsInternalServerError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`RecipientDeleteTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientdeletetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateCreateTemplateDirectLinkInternalServerError`](./src/documenso_sdk/models/templatecreatetemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateDeleteTemplateDirectLinkInternalServerError`](./src/documenso_sdk/models/templatedeletetemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* -* [`TemplateToggleTemplateDirectLinkInternalServerError`](./src/documenso_sdk/models/templatetoggletemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 43 methods.* +* [`DocumentGetBadRequestError`](./src/documenso_sdk/models/documentgetbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentFindBadRequestError`](./src/documenso_sdk/models/documentfindbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentUpdateBadRequestError`](./src/documenso_sdk/models/documentupdatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentDeleteBadRequestError`](./src/documenso_sdk/models/documentdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentDuplicateBadRequestError`](./src/documenso_sdk/models/documentduplicatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentDistributeBadRequestError`](./src/documenso_sdk/models/documentdistributebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentRedistributeBadRequestError`](./src/documenso_sdk/models/documentredistributebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentCreateDocumentTemporaryBadRequestError`](./src/documenso_sdk/models/documentcreatedocumenttemporarybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentDownloadBadRequestError`](./src/documenso_sdk/models/documentdownloadbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateFindTemplatesBadRequestError`](./src/documenso_sdk/models/templatefindtemplatesbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateGetTemplateByIDBadRequestError`](./src/documenso_sdk/models/templategettemplatebyidbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateUpdateTemplateBadRequestError`](./src/documenso_sdk/models/templateupdatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateDuplicateTemplateBadRequestError`](./src/documenso_sdk/models/templateduplicatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateDeleteTemplateBadRequestError`](./src/documenso_sdk/models/templatedeletetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateCreateDocumentFromTemplateBadRequestError`](./src/documenso_sdk/models/templatecreatedocumentfromtemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateCreateTemplateTemporaryBadRequestError`](./src/documenso_sdk/models/templatecreatetemplatetemporarybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError`](./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokenbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError`](./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokenbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldGetDocumentFieldBadRequestError`](./src/documenso_sdk/models/fieldgetdocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldCreateDocumentFieldBadRequestError`](./src/documenso_sdk/models/fieldcreatedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldCreateDocumentFieldsBadRequestError`](./src/documenso_sdk/models/fieldcreatedocumentfieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldUpdateDocumentFieldBadRequestError`](./src/documenso_sdk/models/fieldupdatedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldUpdateDocumentFieldsBadRequestError`](./src/documenso_sdk/models/fieldupdatedocumentfieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldDeleteDocumentFieldBadRequestError`](./src/documenso_sdk/models/fielddeletedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientGetDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientgetdocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientCreateDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientCreateDocumentRecipientsBadRequestError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateDocumentRecipientsBadRequestError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientDeleteDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientdeletedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldCreateTemplateFieldBadRequestError`](./src/documenso_sdk/models/fieldcreatetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldGetTemplateFieldBadRequestError`](./src/documenso_sdk/models/fieldgettemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldCreateTemplateFieldsBadRequestError`](./src/documenso_sdk/models/fieldcreatetemplatefieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldUpdateTemplateFieldBadRequestError`](./src/documenso_sdk/models/fieldupdatetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldUpdateTemplateFieldsBadRequestError`](./src/documenso_sdk/models/fieldupdatetemplatefieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`FieldDeleteTemplateFieldBadRequestError`](./src/documenso_sdk/models/fielddeletetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientGetTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientgettemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientCreateTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientCreateTemplateRecipientsBadRequestError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateTemplateRecipientsBadRequestError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`RecipientDeleteTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientdeletetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateCreateTemplateDirectLinkBadRequestError`](./src/documenso_sdk/models/templatecreatetemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateDeleteTemplateDirectLinkBadRequestError`](./src/documenso_sdk/models/templatedeletetemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`TemplateToggleTemplateDirectLinkBadRequestError`](./src/documenso_sdk/models/templatetoggletemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 45 methods.* +* [`DocumentGetNotFoundError`](./src/documenso_sdk/models/documentgetnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`DocumentFindNotFoundError`](./src/documenso_sdk/models/documentfindnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`DocumentDownloadNotFoundError`](./src/documenso_sdk/models/documentdownloadnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`TemplateFindTemplatesNotFoundError`](./src/documenso_sdk/models/templatefindtemplatesnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`TemplateGetTemplateByIDNotFoundError`](./src/documenso_sdk/models/templategettemplatebyidnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`FieldGetDocumentFieldNotFoundError`](./src/documenso_sdk/models/fieldgetdocumentfieldnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`RecipientGetDocumentRecipientNotFoundError`](./src/documenso_sdk/models/recipientgetdocumentrecipientnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`FieldGetTemplateFieldNotFoundError`](./src/documenso_sdk/models/fieldgettemplatefieldnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`RecipientGetTemplateRecipientNotFoundError`](./src/documenso_sdk/models/recipientgettemplaterecipientnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 45 methods.* +* [`DocumentGetInternalServerError`](./src/documenso_sdk/models/documentgetinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentFindInternalServerError`](./src/documenso_sdk/models/documentfindinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentUpdateInternalServerError`](./src/documenso_sdk/models/documentupdateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentDeleteInternalServerError`](./src/documenso_sdk/models/documentdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentDuplicateInternalServerError`](./src/documenso_sdk/models/documentduplicateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentDistributeInternalServerError`](./src/documenso_sdk/models/documentdistributeinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentRedistributeInternalServerError`](./src/documenso_sdk/models/documentredistributeinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentCreateDocumentTemporaryInternalServerError`](./src/documenso_sdk/models/documentcreatedocumenttemporaryinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`DocumentDownloadInternalServerError`](./src/documenso_sdk/models/documentdownloadinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateFindTemplatesInternalServerError`](./src/documenso_sdk/models/templatefindtemplatesinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateGetTemplateByIDInternalServerError`](./src/documenso_sdk/models/templategettemplatebyidinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateUpdateTemplateInternalServerError`](./src/documenso_sdk/models/templateupdatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateDuplicateTemplateInternalServerError`](./src/documenso_sdk/models/templateduplicatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateDeleteTemplateInternalServerError`](./src/documenso_sdk/models/templatedeletetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateCreateDocumentFromTemplateInternalServerError`](./src/documenso_sdk/models/templatecreatedocumentfromtemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateCreateTemplateTemporaryInternalServerError`](./src/documenso_sdk/models/templatecreatetemplatetemporaryinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError`](./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokeninternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError`](./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokeninternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldGetDocumentFieldInternalServerError`](./src/documenso_sdk/models/fieldgetdocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldCreateDocumentFieldInternalServerError`](./src/documenso_sdk/models/fieldcreatedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldCreateDocumentFieldsInternalServerError`](./src/documenso_sdk/models/fieldcreatedocumentfieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldUpdateDocumentFieldInternalServerError`](./src/documenso_sdk/models/fieldupdatedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldUpdateDocumentFieldsInternalServerError`](./src/documenso_sdk/models/fieldupdatedocumentfieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldDeleteDocumentFieldInternalServerError`](./src/documenso_sdk/models/fielddeletedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientGetDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientgetdocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientCreateDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientCreateDocumentRecipientsInternalServerError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateDocumentRecipientsInternalServerError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientDeleteDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientdeletedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldCreateTemplateFieldInternalServerError`](./src/documenso_sdk/models/fieldcreatetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldGetTemplateFieldInternalServerError`](./src/documenso_sdk/models/fieldgettemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldCreateTemplateFieldsInternalServerError`](./src/documenso_sdk/models/fieldcreatetemplatefieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldUpdateTemplateFieldInternalServerError`](./src/documenso_sdk/models/fieldupdatetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldUpdateTemplateFieldsInternalServerError`](./src/documenso_sdk/models/fieldupdatetemplatefieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`FieldDeleteTemplateFieldInternalServerError`](./src/documenso_sdk/models/fielddeletetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientGetTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientgettemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientCreateTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientCreateTemplateRecipientsInternalServerError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientUpdateTemplateRecipientsInternalServerError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`RecipientDeleteTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientdeletetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateCreateTemplateDirectLinkInternalServerError`](./src/documenso_sdk/models/templatecreatetemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateDeleteTemplateDirectLinkInternalServerError`](./src/documenso_sdk/models/templatedeletetemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* +* [`TemplateToggleTemplateDirectLinkInternalServerError`](./src/documenso_sdk/models/templatetoggletemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 45 methods.* * [`ResponseValidationError`](./src/documenso_sdk/models/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
@@ -540,7 +552,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92) + res = documenso.documents.get(document_id=6150.61) # Handle response print(res) diff --git a/RELEASES.md b/RELEASES.md index c5023aa..374cdd8 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -26,4 +26,14 @@ Based on: ### Generated - [python v0.3.0] . ### Releases -- [PyPI v0.3.0] https://pypi.org/project/documenso_sdk/0.3.0 - . \ No newline at end of file +- [PyPI v0.3.0] https://pypi.org/project/documenso_sdk/0.3.0 - . + +## 2025-11-07 00:13:33 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.650.0 (2.743.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.4.0] . +### Releases +- [PyPI v0.4.0] https://pypi.org/project/documenso_sdk/0.4.0 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index 068ff0c..e698432 100644 --- a/USAGE.md +++ b/USAGE.md @@ -9,7 +9,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92) + res = documenso.documents.get(document_id=6150.61) # Handle response print(res) @@ -18,6 +18,7 @@ with Documenso(
The same SDK client can also be used to make asynchronous requests by importing asyncio. + ```python # Asynchronous Example import asyncio @@ -30,7 +31,7 @@ async def main(): api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = await documenso.documents.update_async(document_id=9701.92) + res = await documenso.documents.get_async(document_id=6150.61) # Handle response print(res) diff --git a/docs/models/customdocumentdatum.md b/docs/models/customdocumentdatum.md new file mode 100644 index 0000000..0cb232a --- /dev/null +++ b/docs/models/customdocumentdatum.md @@ -0,0 +1,9 @@ +# CustomDocumentDatum + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `document_data_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/document.md b/docs/models/document.md deleted file mode 100644 index 0f1e8bc..0000000 --- a/docs/models/document.md +++ /dev/null @@ -1,29 +0,0 @@ -# Document - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `visibility` | [models.DocumentVisibility](../models/documentvisibility.md) | :heavy_check_mark: | N/A | -| `status` | [models.DocumentCreateDocumentTemporaryStatus](../models/documentcreatedocumenttemporarystatus.md) | :heavy_check_mark: | N/A | -| `source` | [models.DocumentCreateDocumentTemporarySource](../models/documentcreatedocumenttemporarysource.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | -| `external_id` | *Nullable[str]* | :heavy_check_mark: | A custom external ID you can use to identify the document. | -| `user_id` | *float* | :heavy_check_mark: | The ID of the user that created this document. | -| `auth_options` | [Nullable[models.DocumentCreateDocumentTemporaryAuthOptions]](../models/documentcreatedocumenttemporaryauthoptions.md) | :heavy_check_mark: | N/A | -| `form_values` | Dict[str, [models.DocumentFormValues](../models/documentformvalues.md)] | :heavy_check_mark: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `document_data_id` | *str* | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `updated_at` | *str* | :heavy_check_mark: | N/A | -| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `team_id` | *float* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `document_data` | [models.DocumentCreateDocumentTemporaryDocumentData](../models/documentcreatedocumenttemporarydocumentdata.md) | :heavy_check_mark: | N/A | -| `document_meta` | [Nullable[models.DocumentCreateDocumentTemporaryDocumentMeta]](../models/documentcreatedocumenttemporarydocumentmeta.md) | :heavy_check_mark: | N/A | -| `folder` | [Nullable[models.DocumentCreateDocumentTemporaryFolder]](../models/documentcreatedocumenttemporaryfolder.md) | :heavy_check_mark: | N/A | -| `recipients` | List[[models.DocumentRecipient](../models/documentrecipient.md)] | :heavy_check_mark: | N/A | -| `fields` | List[[models.DocumentField](../models/documentfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentaccessauth.md b/docs/models/documentaccessauth.md index dbb71d8..4265e91 100644 --- a/docs/models/documentaccessauth.md +++ b/docs/models/documentaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryaccessauthrequest.md b/docs/models/documentcreatedocumenttemporaryaccessauthrequest.md index 214921d..e6a0878 100644 --- a/docs/models/documentcreatedocumenttemporaryaccessauthrequest.md +++ b/docs/models/documentcreatedocumenttemporaryaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarydateformat.md b/docs/models/documentcreatedocumenttemporarydateformat.md index 6290b39..8570782 100644 --- a/docs/models/documentcreatedocumenttemporarydateformat.md +++ b/docs/models/documentcreatedocumenttemporarydateformat.md @@ -5,15 +5,27 @@ The date format to use for date fields and signing the document. ## Values -| Name | Value | -| ------------------------------ | ------------------------------ | -| `YYYY_MM_DD_HH_MM_A` | yyyy-MM-dd hh:mm a | -| `YYYY_MM_DD` | yyyy-MM-dd | -| `DD_MM_YYYY_HH_MM_A` | dd/MM/yyyy hh:mm a | -| `MM_DD_YYYY_HH_MM_A` | MM/dd/yyyy hh:mm a | -| `YYYY_MM_DD_HH_MM` | yyyy-MM-dd HH:mm | -| `YY_MM_DD_HH_MM_A` | yy-MM-dd hh:mm a | -| `YYYY_MM_DD_HH_MM_SS` | yyyy-MM-dd HH:mm:ss | -| `MMMM_DD_YYYY_HH_MM_A` | MMMM dd, yyyy hh:mm a | -| `EEEE_MMMM_DD_YYYY_HH_MM_A` | EEEE, MMMM dd, yyyy hh:mm a | -| `YYYY_MM_DD_T_HH_MM_SS_SSSXXX` | yyyy-MM-dd'T'HH:mm:ss.SSSXXX | \ No newline at end of file +| Name | Value | +| --------------------------------- | --------------------------------- | +| `YYYY_M_MDD_HH_MM_A` | yyyy-MM-dd hh:mm a | +| `YYYY_M_MDD` | yyyy-MM-dd | +| `DD_MM_SLASH_YYYY` | dd/MM/yyyy | +| `MM_DD_SLASH_YYYY` | MM/dd/yyyy | +| `YY_M_MDD` | yy-MM-dd | +| `MMMM_DD_COMMA_YYYY` | MMMM dd, yyyy | +| `EEEE_MMMM_DD_COMMA_YYYY` | EEEE, MMMM dd, yyyy | +| `DD_MM_SLASH_YYYY_HH_MM_A` | dd/MM/yyyy hh:mm a | +| `DD_MM_SLASH_YYYY_H_HMM` | dd/MM/yyyy HH:mm | +| `MM_DD_SLASH_YYYY_HH_MM_A` | MM/dd/yyyy hh:mm a | +| `MM_DD_SLASH_YYYY_H_HMM` | MM/dd/yyyy HH:mm | +| `DD_DOT_MM_DOT_YYYY` | dd.MM.yyyy | +| `DD_DOT_MM_DOT_YYYY_H_HMM` | dd.MM.yyyy HH:mm | +| `YYYY_M_MDD_H_HMM` | yyyy-MM-dd HH:mm | +| `YY_M_MDD_HH_MM_A` | yy-MM-dd hh:mm a | +| `YY_M_MDD_H_HMM` | yy-MM-dd HH:mm | +| `YYYY_M_MDD_H_HMMSS` | yyyy-MM-dd HH:mm:ss | +| `MMMM_DD_COMMA_YYYY_HH_MM_A` | MMMM dd, yyyy hh:mm a | +| `MMMM_DD_COMMA_YYYY_H_HMM` | MMMM dd, yyyy HH:mm | +| `EEEE_MMMM_DD_COMMA_YYYY_HH_MM_A` | EEEE, MMMM dd, yyyy hh:mm a | +| `EEEE_MMMM_DD_COMMA_YYYY_H_HMM` | EEEE, MMMM dd, yyyy HH:mm | +| `ISO8601_FULL` | yyyy-MM-dd'T'HH:mm:ss.SSSXXX | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarydocument.md b/docs/models/documentcreatedocumenttemporarydocument.md new file mode 100644 index 0000000..236e5b0 --- /dev/null +++ b/docs/models/documentcreatedocumenttemporarydocument.md @@ -0,0 +1,30 @@ +# DocumentCreateDocumentTemporaryDocument + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `visibility` | [models.DocumentVisibility](../models/documentvisibility.md) | :heavy_check_mark: | N/A | +| `status` | [models.DocumentCreateDocumentTemporaryStatus](../models/documentcreatedocumenttemporarystatus.md) | :heavy_check_mark: | N/A | +| `source` | [models.DocumentCreateDocumentTemporarySource](../models/documentcreatedocumenttemporarysource.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `external_id` | *Nullable[str]* | :heavy_check_mark: | A custom external ID you can use to identify the document. | +| `user_id` | *float* | :heavy_check_mark: | The ID of the user that created this document. | +| `auth_options` | [Nullable[models.DocumentCreateDocumentTemporaryAuthOptions]](../models/documentcreatedocumenttemporaryauthoptions.md) | :heavy_check_mark: | N/A | +| `form_values` | Dict[str, [models.DocumentFormValues](../models/documentformvalues.md)] | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | +| `document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `document_data` | [models.DocumentCreateDocumentTemporaryDocumentData](../models/documentcreatedocumenttemporarydocumentdata.md) | :heavy_check_mark: | N/A | +| `document_meta` | [models.DocumentCreateDocumentTemporaryDocumentMeta](../models/documentcreatedocumenttemporarydocumentmeta.md) | :heavy_check_mark: | N/A | +| `folder` | [Nullable[models.DocumentCreateDocumentTemporaryFolder]](../models/documentcreatedocumenttemporaryfolder.md) | :heavy_check_mark: | N/A | +| `recipients` | List[[models.DocumentRecipient](../models/documentrecipient.md)] | :heavy_check_mark: | N/A | +| `fields` | List[[models.DocumentField](../models/documentfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarydocumentdata.md b/docs/models/documentcreatedocumenttemporarydocumentdata.md index c7f58dc..d635e52 100644 --- a/docs/models/documentcreatedocumenttemporarydocumentdata.md +++ b/docs/models/documentcreatedocumenttemporarydocumentdata.md @@ -8,4 +8,5 @@ | `type` | [models.DocumentDocumentDataType](../models/documentdocumentdatatype.md) | :heavy_check_mark: | N/A | | `id` | *str* | :heavy_check_mark: | N/A | | `data` | *str* | :heavy_check_mark: | N/A | -| `initial_data` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `initial_data` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarydocumentmeta.md b/docs/models/documentcreatedocumenttemporarydocumentmeta.md index 85cf6af..1c8dda0 100644 --- a/docs/models/documentcreatedocumenttemporarydocumentmeta.md +++ b/docs/models/documentcreatedocumenttemporarydocumentmeta.md @@ -11,13 +11,15 @@ | `subject` | *Nullable[str]* | :heavy_check_mark: | N/A | | `message` | *Nullable[str]* | :heavy_check_mark: | N/A | | `timezone` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `password` | *Nullable[str]* | :heavy_check_mark: | N/A | | `date_format` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `document_id` | *float* | :heavy_check_mark: | N/A | | `redirect_url` | *Nullable[str]* | :heavy_check_mark: | N/A | | `typed_signature_enabled` | *bool* | :heavy_check_mark: | N/A | | `upload_signature_enabled` | *bool* | :heavy_check_mark: | N/A | | `draw_signature_enabled` | *bool* | :heavy_check_mark: | N/A | | `allow_dictate_next_signer` | *bool* | :heavy_check_mark: | N/A | | `language` | *str* | :heavy_check_mark: | N/A | -| `email_settings` | [Nullable[models.DocumentEmailSettings]](../models/documentemailsettings.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `email_settings` | [Nullable[models.DocumentEmailSettings]](../models/documentemailsettings.md) | :heavy_check_mark: | N/A | +| `email_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `email_reply_to` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `document_id` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryglobalaccessauthrequest.md b/docs/models/documentcreatedocumenttemporaryglobalaccessauthrequest.md index 6ba246b..c5a3422 100644 --- a/docs/models/documentcreatedocumenttemporaryglobalaccessauthrequest.md +++ b/docs/models/documentcreatedocumenttemporaryglobalaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarymeta.md b/docs/models/documentcreatedocumenttemporarymeta.md index 460fa99..7ff0adf 100644 --- a/docs/models/documentcreatedocumenttemporarymeta.md +++ b/docs/models/documentcreatedocumenttemporarymeta.md @@ -11,9 +11,12 @@ | `date_format` | [Optional[models.DocumentCreateDocumentTemporaryDateFormat]](../models/documentcreatedocumenttemporarydateformat.md) | :heavy_minus_sign: | The date format to use for date fields and signing the document. | | `distribution_method` | [Optional[models.DocumentCreateDocumentTemporaryDistributionMethodRequest]](../models/documentcreatedocumenttemporarydistributionmethodrequest.md) | :heavy_minus_sign: | The distribution method to use when sending the document to the recipients. | | `signing_order` | [Optional[models.DocumentCreateDocumentTemporarySigningOrderRequest]](../models/documentcreatedocumenttemporarysigningorderrequest.md) | :heavy_minus_sign: | N/A | +| `allow_dictate_next_signer` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `redirect_url` | *Optional[str]* | :heavy_minus_sign: | The URL to which the recipient should be redirected after signing the document. | | `language` | [Optional[models.DocumentCreateDocumentTemporaryLanguage]](../models/documentcreatedocumenttemporarylanguage.md) | :heavy_minus_sign: | The language to use for email communications with recipients. | | `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using a typed signature. | -| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using a draw signature. | | `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using an uploaded signature. | -| `email_settings` | [Optional[models.DocumentCreateDocumentTemporaryEmailSettingsRequest]](../models/documentcreatedocumenttemporaryemailsettingsrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using a draw signature. | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [OptionalNullable[models.DocumentCreateDocumentTemporaryEmailSettingsRequest]](../models/documentcreatedocumenttemporaryemailsettingsrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientdirection.md b/docs/models/documentcreatedocumenttemporaryrecipientdirection.md new file mode 100644 index 0000000..43acffc --- /dev/null +++ b/docs/models/documentcreatedocumenttemporaryrecipientdirection.md @@ -0,0 +1,9 @@ +# DocumentCreateDocumentTemporaryRecipientDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md index e3f17a9..023eec0 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeCheckbox2](../models/documentcreatedocumenttemporaryrecipienttypecheckbox2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.DocumentCreateDocumentTemporaryValueCheckbox](../models/documentcreatedocumenttemporaryvaluecheckbox.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeCheckbox2](../models/documentcreatedocumenttemporaryrecipienttypecheckbox2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.DocumentCreateDocumentTemporaryValueCheckbox](../models/documentcreatedocumenttemporaryvaluecheckbox.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.DocumentCreateDocumentTemporaryRecipientDirection]](../models/documentcreatedocumenttemporaryrecipientdirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetanumber.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetanumber.md index 28840bd..ff256f9 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetanumber.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeNumber2](../models/documentcreatedocumenttemporaryrecipienttypenumber2.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.DocumentCreateDocumentTemporaryTextAlignNumber]](../models/documentcreatedocumenttemporarytextalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrequest.md b/docs/models/documentcreatedocumenttemporaryrequest.md index b7ece11..b19f5b4 100644 --- a/docs/models/documentcreatedocumenttemporaryrequest.md +++ b/docs/models/documentcreatedocumenttemporaryrequest.md @@ -11,5 +11,6 @@ | `global_access_auth` | List[[models.DocumentCreateDocumentTemporaryGlobalAccessAuthRequest](../models/documentcreatedocumenttemporaryglobalaccessauthrequest.md)] | :heavy_minus_sign: | N/A | | `global_action_auth` | List[[models.DocumentCreateDocumentTemporaryGlobalActionAuthRequest](../models/documentcreatedocumenttemporaryglobalactionauthrequest.md)] | :heavy_minus_sign: | N/A | | `form_values` | Dict[str, [models.FormValuesRequest](../models/formvaluesrequest.md)] | :heavy_minus_sign: | N/A | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the folder to create the document in. If not provided, the document will be created in the root folder. | | `recipients` | List[[models.DocumentCreateDocumentTemporaryRecipientRequest](../models/documentcreatedocumenttemporaryrecipientrequest.md)] | :heavy_minus_sign: | N/A | | `meta` | [Optional[models.DocumentCreateDocumentTemporaryMeta]](../models/documentcreatedocumenttemporarymeta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryresponse.md b/docs/models/documentcreatedocumenttemporaryresponse.md index 64d8f44..1c8118c 100644 --- a/docs/models/documentcreatedocumenttemporaryresponse.md +++ b/docs/models/documentcreatedocumenttemporaryresponse.md @@ -5,7 +5,7 @@ Successful response ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `document` | [models.Document](../models/document.md) | :heavy_check_mark: | N/A | -| `upload_url` | *str* | :heavy_check_mark: | The URL to upload the document PDF to. Use a PUT request with the file via form-data | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `document` | [models.DocumentCreateDocumentTemporaryDocument](../models/documentcreatedocumenttemporarydocument.md) | :heavy_check_mark: | N/A | +| `upload_url` | *str* | :heavy_check_mark: | The URL to upload the document PDF to. Use a PUT request with the file via form-data | \ No newline at end of file diff --git a/docs/models/documentdeletebadrequesterror.md b/docs/models/documentdeletebadrequesterror.md new file mode 100644 index 0000000..d7713b2 --- /dev/null +++ b/docs/models/documentdeletebadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentDeleteBadRequestError + +Invalid input data + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDeleteBadRequestIssue](../models/documentdeletebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsnotfoundissue.md b/docs/models/documentdeletebadrequestissue.md similarity index 87% rename from docs/models/documentfinddocumentsnotfoundissue.md rename to docs/models/documentdeletebadrequestissue.md index b4b0ba3..4fb2858 100644 --- a/docs/models/documentfinddocumentsnotfoundissue.md +++ b/docs/models/documentdeletebadrequestissue.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsNotFoundIssue +# DocumentDeleteBadRequestIssue ## Fields diff --git a/docs/models/documentdeletedocumentbadrequesterror.md b/docs/models/documentdeletedocumentbadrequesterror.md deleted file mode 100644 index 17c750d..0000000 --- a/docs/models/documentdeletedocumentbadrequesterror.md +++ /dev/null @@ -1,12 +0,0 @@ -# DocumentDeleteDocumentBadRequestError - -Invalid input data - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentDeleteDocumentBadRequestIssue](../models/documentdeletedocumentbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdeletedocumentinternalservererror.md b/docs/models/documentdeletedocumentinternalservererror.md deleted file mode 100644 index 25d92d0..0000000 --- a/docs/models/documentdeletedocumentinternalservererror.md +++ /dev/null @@ -1,12 +0,0 @@ -# DocumentDeleteDocumentInternalServerError - -Internal server error - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentDeleteDocumentInternalServerErrorIssue](../models/documentdeletedocumentinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdeleteinternalservererror.md b/docs/models/documentdeleteinternalservererror.md new file mode 100644 index 0000000..6e7f8d1 --- /dev/null +++ b/docs/models/documentdeleteinternalservererror.md @@ -0,0 +1,12 @@ +# DocumentDeleteInternalServerError + +Internal server error + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDeleteInternalServerErrorIssue](../models/documentdeleteinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdeletedocumentbadrequestissue.md b/docs/models/documentdeleteinternalservererrorissue.md similarity index 86% rename from docs/models/documentdeletedocumentbadrequestissue.md rename to docs/models/documentdeleteinternalservererrorissue.md index fab138d..a8de16e 100644 --- a/docs/models/documentdeletedocumentbadrequestissue.md +++ b/docs/models/documentdeleteinternalservererrorissue.md @@ -1,4 +1,4 @@ -# DocumentDeleteDocumentBadRequestIssue +# DocumentDeleteInternalServerErrorIssue ## Fields diff --git a/docs/models/documentdeletedocumentrequest.md b/docs/models/documentdeleterequest.md similarity index 89% rename from docs/models/documentdeletedocumentrequest.md rename to docs/models/documentdeleterequest.md index be5e608..588f8d5 100644 --- a/docs/models/documentdeletedocumentrequest.md +++ b/docs/models/documentdeleterequest.md @@ -1,4 +1,4 @@ -# DocumentDeleteDocumentRequest +# DocumentDeleteRequest ## Fields diff --git a/docs/models/documentresenddocumentresponse.md b/docs/models/documentdeleteresponse.md similarity index 89% rename from docs/models/documentresenddocumentresponse.md rename to docs/models/documentdeleteresponse.md index eb4468e..a63ad32 100644 --- a/docs/models/documentresenddocumentresponse.md +++ b/docs/models/documentdeleteresponse.md @@ -1,4 +1,4 @@ -# DocumentResendDocumentResponse +# DocumentDeleteResponse Successful response diff --git a/docs/models/documentdirection.md b/docs/models/documentdirection.md new file mode 100644 index 0000000..61c8e16 --- /dev/null +++ b/docs/models/documentdirection.md @@ -0,0 +1,9 @@ +# DocumentDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsnotfounderror.md b/docs/models/documentdistributeauthoptions.md similarity index 53% rename from docs/models/documentfinddocumentsnotfounderror.md rename to docs/models/documentdistributeauthoptions.md index 06f1f36..450e451 100644 --- a/docs/models/documentfinddocumentsnotfounderror.md +++ b/docs/models/documentdistributeauthoptions.md @@ -1,12 +1,9 @@ -# DocumentFindDocumentsNotFoundError - -Not found +# DocumentDistributeAuthOptions ## Fields | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentFindDocumentsNotFoundIssue](../models/documentfinddocumentsnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `global_access_auth` | List[[models.DocumentDistributeGlobalAccessAuth](../models/documentdistributeglobalaccessauth.md)] | :heavy_check_mark: | N/A | +| `global_action_auth` | List[[models.DocumentDistributeGlobalActionAuth](../models/documentdistributeglobalactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdistributebadrequesterror.md b/docs/models/documentdistributebadrequesterror.md new file mode 100644 index 0000000..692b3db --- /dev/null +++ b/docs/models/documentdistributebadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentDistributeBadRequestError + +Invalid input data + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDistributeBadRequestIssue](../models/documentdistributebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentbadrequestissue.md b/docs/models/documentdistributebadrequestissue.md similarity index 87% rename from docs/models/documentsenddocumentbadrequestissue.md rename to docs/models/documentdistributebadrequestissue.md index d2033ac..3d78574 100644 --- a/docs/models/documentsenddocumentbadrequestissue.md +++ b/docs/models/documentdistributebadrequestissue.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentBadRequestIssue +# DocumentDistributeBadRequestIssue ## Fields diff --git a/docs/models/documentdistributedateformat.md b/docs/models/documentdistributedateformat.md new file mode 100644 index 0000000..f4e8ab2 --- /dev/null +++ b/docs/models/documentdistributedateformat.md @@ -0,0 +1,31 @@ +# DocumentDistributeDateFormat + +The date format to use for date fields and signing the document. + + +## Values + +| Name | Value | +| --------------------------------- | --------------------------------- | +| `YYYY_M_MDD_HH_MM_A` | yyyy-MM-dd hh:mm a | +| `YYYY_M_MDD` | yyyy-MM-dd | +| `DD_MM_SLASH_YYYY` | dd/MM/yyyy | +| `MM_DD_SLASH_YYYY` | MM/dd/yyyy | +| `YY_M_MDD` | yy-MM-dd | +| `MMMM_DD_COMMA_YYYY` | MMMM dd, yyyy | +| `EEEE_MMMM_DD_COMMA_YYYY` | EEEE, MMMM dd, yyyy | +| `DD_MM_SLASH_YYYY_HH_MM_A` | dd/MM/yyyy hh:mm a | +| `DD_MM_SLASH_YYYY_H_HMM` | dd/MM/yyyy HH:mm | +| `MM_DD_SLASH_YYYY_HH_MM_A` | MM/dd/yyyy hh:mm a | +| `MM_DD_SLASH_YYYY_H_HMM` | MM/dd/yyyy HH:mm | +| `DD_DOT_MM_DOT_YYYY` | dd.MM.yyyy | +| `DD_DOT_MM_DOT_YYYY_H_HMM` | dd.MM.yyyy HH:mm | +| `YYYY_M_MDD_H_HMM` | yyyy-MM-dd HH:mm | +| `YY_M_MDD_HH_MM_A` | yy-MM-dd hh:mm a | +| `YY_M_MDD_H_HMM` | yy-MM-dd HH:mm | +| `YYYY_M_MDD_H_HMMSS` | yyyy-MM-dd HH:mm:ss | +| `MMMM_DD_COMMA_YYYY_HH_MM_A` | MMMM dd, yyyy hh:mm a | +| `MMMM_DD_COMMA_YYYY_H_HMM` | MMMM dd, yyyy HH:mm | +| `EEEE_MMMM_DD_COMMA_YYYY_HH_MM_A` | EEEE, MMMM dd, yyyy hh:mm a | +| `EEEE_MMMM_DD_COMMA_YYYY_H_HMM` | EEEE, MMMM dd, yyyy HH:mm | +| `ISO8601_FULL` | yyyy-MM-dd'T'HH:mm:ss.SSSXXX | \ No newline at end of file diff --git a/docs/models/documentsenddocumentdistributionmethod.md b/docs/models/documentdistributedistributionmethod.md similarity index 81% rename from docs/models/documentsenddocumentdistributionmethod.md rename to docs/models/documentdistributedistributionmethod.md index 2d28a63..83fe713 100644 --- a/docs/models/documentsenddocumentdistributionmethod.md +++ b/docs/models/documentdistributedistributionmethod.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentDistributionMethod +# DocumentDistributeDistributionMethod The distribution method to use when sending the document to the recipients. diff --git a/docs/models/documentsenddocumentemailsettings.md b/docs/models/documentdistributeemailsettings.md similarity index 99% rename from docs/models/documentsenddocumentemailsettings.md rename to docs/models/documentdistributeemailsettings.md index 997d62a..d1c2ab7 100644 --- a/docs/models/documentsenddocumentemailsettings.md +++ b/docs/models/documentdistributeemailsettings.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentEmailSettings +# DocumentDistributeEmailSettings ## Fields diff --git a/docs/models/documentsenddocumentformvalues.md b/docs/models/documentdistributeformvalues.md similarity index 85% rename from docs/models/documentsenddocumentformvalues.md rename to docs/models/documentdistributeformvalues.md index 7f1fb3f..b0d8f63 100644 --- a/docs/models/documentsenddocumentformvalues.md +++ b/docs/models/documentdistributeformvalues.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentFormValues +# DocumentDistributeFormValues ## Supported Types diff --git a/docs/models/documentdistributeglobalaccessauth.md b/docs/models/documentdistributeglobalaccessauth.md new file mode 100644 index 0000000..fa9054d --- /dev/null +++ b/docs/models/documentdistributeglobalaccessauth.md @@ -0,0 +1,11 @@ +# DocumentDistributeGlobalAccessAuth + +The type of authentication required for the recipient to access the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentsenddocumentglobalactionauth.md b/docs/models/documentdistributeglobalactionauth.md similarity index 91% rename from docs/models/documentsenddocumentglobalactionauth.md rename to docs/models/documentdistributeglobalactionauth.md index f7b911d..c5ce13a 100644 --- a/docs/models/documentsenddocumentglobalactionauth.md +++ b/docs/models/documentdistributeglobalactionauth.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentGlobalActionAuth +# DocumentDistributeGlobalActionAuth The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. diff --git a/docs/models/documentgetdocumentwithdetailsbyidinternalservererror.md b/docs/models/documentdistributeinternalservererror.md similarity index 52% rename from docs/models/documentgetdocumentwithdetailsbyidinternalservererror.md rename to docs/models/documentdistributeinternalservererror.md index 5a84970..6d30ecd 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidinternalservererror.md +++ b/docs/models/documentdistributeinternalservererror.md @@ -1,12 +1,12 @@ -# DocumentGetDocumentWithDetailsByIDInternalServerError +# DocumentDistributeInternalServerError Internal server error ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentGetDocumentWithDetailsByIDInternalServerErrorIssue](../models/documentgetdocumentwithdetailsbyidinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDistributeInternalServerErrorIssue](../models/documentdistributeinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdistributeinternalservererrorissue.md b/docs/models/documentdistributeinternalservererrorissue.md new file mode 100644 index 0000000..eef5d52 --- /dev/null +++ b/docs/models/documentdistributeinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentDistributeInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentlanguage.md b/docs/models/documentdistributelanguage.md similarity index 87% rename from docs/models/documentsenddocumentlanguage.md rename to docs/models/documentdistributelanguage.md index b199c5d..c013032 100644 --- a/docs/models/documentsenddocumentlanguage.md +++ b/docs/models/documentdistributelanguage.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentLanguage +# DocumentDistributeLanguage The language to use for email communications with recipients. diff --git a/docs/models/documentdistributemeta.md b/docs/models/documentdistributemeta.md new file mode 100644 index 0000000..82205db --- /dev/null +++ b/docs/models/documentdistributemeta.md @@ -0,0 +1,17 @@ +# DocumentDistributeMeta + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | The subject of the email that will be sent to the recipients. | +| `message` | *Optional[str]* | :heavy_minus_sign: | The message of the email that will be sent to the recipients. | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne | +| `date_format` | [Optional[models.DocumentDistributeDateFormat]](../models/documentdistributedateformat.md) | :heavy_minus_sign: | The date format to use for date fields and signing the document. | +| `distribution_method` | [Optional[models.DocumentDistributeDistributionMethod]](../models/documentdistributedistributionmethod.md) | :heavy_minus_sign: | The distribution method to use when sending the document to the recipients. | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | The URL to which the recipient should be redirected after signing the document. | +| `language` | [Optional[models.DocumentDistributeLanguage]](../models/documentdistributelanguage.md) | :heavy_minus_sign: | The language to use for email communications with recipients. | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [Optional[models.DocumentDistributeEmailSettings]](../models/documentdistributeemailsettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdistributerequest.md b/docs/models/documentdistributerequest.md new file mode 100644 index 0000000..cdfdd51 --- /dev/null +++ b/docs/models/documentdistributerequest.md @@ -0,0 +1,9 @@ +# DocumentDistributeRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `document_id` | *float* | :heavy_check_mark: | The ID of the document to send. | +| `meta` | [Optional[models.DocumentDistributeMeta]](../models/documentdistributemeta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdistributeresponse.md b/docs/models/documentdistributeresponse.md new file mode 100644 index 0000000..5b74b95 --- /dev/null +++ b/docs/models/documentdistributeresponse.md @@ -0,0 +1,28 @@ +# DocumentDistributeResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `visibility` | [models.DocumentDistributeVisibility](../models/documentdistributevisibility.md) | :heavy_check_mark: | N/A | +| `status` | [models.DocumentDistributeStatus](../models/documentdistributestatus.md) | :heavy_check_mark: | N/A | +| `source` | [models.DocumentDistributeSource](../models/documentdistributesource.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `external_id` | *Nullable[str]* | :heavy_check_mark: | A custom external ID you can use to identify the document. | +| `user_id` | *float* | :heavy_check_mark: | The ID of the user that created this document. | +| `auth_options` | [Nullable[models.DocumentDistributeAuthOptions]](../models/documentdistributeauthoptions.md) | :heavy_check_mark: | N/A | +| `form_values` | Dict[str, [models.DocumentDistributeFormValues](../models/documentdistributeformvalues.md)] | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | \ No newline at end of file diff --git a/docs/models/documentsenddocumentsource.md b/docs/models/documentdistributesource.md similarity index 90% rename from docs/models/documentsenddocumentsource.md rename to docs/models/documentdistributesource.md index b17dec9..a673891 100644 --- a/docs/models/documentsenddocumentsource.md +++ b/docs/models/documentdistributesource.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentSource +# DocumentDistributeSource ## Values diff --git a/docs/models/documentsenddocumentstatus.md b/docs/models/documentdistributestatus.md similarity index 86% rename from docs/models/documentsenddocumentstatus.md rename to docs/models/documentdistributestatus.md index 2031b96..6c115f2 100644 --- a/docs/models/documentsenddocumentstatus.md +++ b/docs/models/documentdistributestatus.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentStatus +# DocumentDistributeStatus ## Values diff --git a/docs/models/documentsenddocumentvisibility.md b/docs/models/documentdistributevisibility.md similarity index 88% rename from docs/models/documentsenddocumentvisibility.md rename to docs/models/documentdistributevisibility.md index 72c1a40..de1aa72 100644 --- a/docs/models/documentsenddocumentvisibility.md +++ b/docs/models/documentdistributevisibility.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentVisibility +# DocumentDistributeVisibility ## Values diff --git a/docs/models/documentfinddocumentsrecipientauthoptions.md b/docs/models/documentdownloadbadrequesterror.md similarity index 58% rename from docs/models/documentfinddocumentsrecipientauthoptions.md rename to docs/models/documentdownloadbadrequesterror.md index c516e13..158b174 100644 --- a/docs/models/documentfinddocumentsrecipientauthoptions.md +++ b/docs/models/documentdownloadbadrequesterror.md @@ -1,9 +1,12 @@ -# DocumentFindDocumentsRecipientAuthOptions +# DocumentDownloadBadRequestError + +Invalid input data ## Fields | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `access_auth` | List[[models.DocumentFindDocumentsAccessAuth](../models/documentfinddocumentsaccessauth.md)] | :heavy_check_mark: | N/A | -| `action_auth` | List[[models.DocumentFindDocumentsActionAuth](../models/documentfinddocumentsactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDownloadBadRequestIssue](../models/documentdownloadbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsbadrequestissue.md b/docs/models/documentdownloadbadrequestissue.md similarity index 87% rename from docs/models/documentfinddocumentsbadrequestissue.md rename to docs/models/documentdownloadbadrequestissue.md index 599d929..8af3567 100644 --- a/docs/models/documentfinddocumentsbadrequestissue.md +++ b/docs/models/documentdownloadbadrequestissue.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsBadRequestIssue +# DocumentDownloadBadRequestIssue ## Fields diff --git a/docs/models/documentduplicatedocumentbadrequesterror.md b/docs/models/documentdownloadinternalservererror.md similarity index 91% rename from docs/models/documentduplicatedocumentbadrequesterror.md rename to docs/models/documentdownloadinternalservererror.md index 77d7fa8..8d16df8 100644 --- a/docs/models/documentduplicatedocumentbadrequesterror.md +++ b/docs/models/documentdownloadinternalservererror.md @@ -1,6 +1,6 @@ -# DocumentDuplicateDocumentBadRequestError +# DocumentDownloadInternalServerError -Invalid input data +Internal server error ## Fields @@ -9,4 +9,4 @@ Invalid input data | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `message` | *str* | :heavy_check_mark: | N/A | | `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentDuplicateDocumentBadRequestIssue](../models/documentduplicatedocumentbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.DocumentDownloadInternalServerErrorIssue](../models/documentdownloadinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicatedocumentbadrequestissue.md b/docs/models/documentdownloadinternalservererrorissue.md similarity index 86% rename from docs/models/documentduplicatedocumentbadrequestissue.md rename to docs/models/documentdownloadinternalservererrorissue.md index 3337aa0..e4157a4 100644 --- a/docs/models/documentduplicatedocumentbadrequestissue.md +++ b/docs/models/documentdownloadinternalservererrorissue.md @@ -1,4 +1,4 @@ -# DocumentDuplicateDocumentBadRequestIssue +# DocumentDownloadInternalServerErrorIssue ## Fields diff --git a/docs/models/documentdownloadnotfounderror.md b/docs/models/documentdownloadnotfounderror.md new file mode 100644 index 0000000..2701e9d --- /dev/null +++ b/docs/models/documentdownloadnotfounderror.md @@ -0,0 +1,12 @@ +# DocumentDownloadNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDownloadNotFoundIssue](../models/documentdownloadnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentresenddocumentbadrequestissue.md b/docs/models/documentdownloadnotfoundissue.md similarity index 87% rename from docs/models/documentresenddocumentbadrequestissue.md rename to docs/models/documentdownloadnotfoundissue.md index 1f60f7d..6389b5d 100644 --- a/docs/models/documentresenddocumentbadrequestissue.md +++ b/docs/models/documentdownloadnotfoundissue.md @@ -1,4 +1,4 @@ -# DocumentResendDocumentBadRequestIssue +# DocumentDownloadNotFoundIssue ## Fields diff --git a/docs/models/documentdownloadrequest.md b/docs/models/documentdownloadrequest.md new file mode 100644 index 0000000..ab39be9 --- /dev/null +++ b/docs/models/documentdownloadrequest.md @@ -0,0 +1,9 @@ +# DocumentDownloadRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | The ID of the document to download. | +| `version` | [Optional[models.Version]](../models/version.md) | :heavy_minus_sign: | The version of the document to download. "signed" returns the completed document with signatures, "original" returns the original uploaded document. | \ No newline at end of file diff --git a/docs/models/documentdownloadresponse.md b/docs/models/documentdownloadresponse.md new file mode 100644 index 0000000..b80c4a8 --- /dev/null +++ b/docs/models/documentdownloadresponse.md @@ -0,0 +1,12 @@ +# DocumentDownloadResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `download_url` | *str* | :heavy_check_mark: | Pre-signed URL for downloading the PDF file | +| `filename` | *str* | :heavy_check_mark: | The filename of the PDF file | +| `content_type` | *str* | :heavy_check_mark: | MIME type of the file | \ No newline at end of file diff --git a/docs/models/documentduplicatebadrequesterror.md b/docs/models/documentduplicatebadrequesterror.md new file mode 100644 index 0000000..20811bd --- /dev/null +++ b/docs/models/documentduplicatebadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentDuplicateBadRequestError + +Invalid input data + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDuplicateBadRequestIssue](../models/documentduplicatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicatebadrequestissue.md b/docs/models/documentduplicatebadrequestissue.md new file mode 100644 index 0000000..eb8d941 --- /dev/null +++ b/docs/models/documentduplicatebadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentDuplicateBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicateinternalservererror.md b/docs/models/documentduplicateinternalservererror.md new file mode 100644 index 0000000..afa5e61 --- /dev/null +++ b/docs/models/documentduplicateinternalservererror.md @@ -0,0 +1,12 @@ +# DocumentDuplicateInternalServerError + +Internal server error + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDuplicateInternalServerErrorIssue](../models/documentduplicateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicateinternalservererrorissue.md b/docs/models/documentduplicateinternalservererrorissue.md new file mode 100644 index 0000000..26cce9c --- /dev/null +++ b/docs/models/documentduplicateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentDuplicateInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicatedocumentrequest.md b/docs/models/documentduplicaterequest.md similarity index 88% rename from docs/models/documentduplicatedocumentrequest.md rename to docs/models/documentduplicaterequest.md index be9b08c..802c14d 100644 --- a/docs/models/documentduplicatedocumentrequest.md +++ b/docs/models/documentduplicaterequest.md @@ -1,4 +1,4 @@ -# DocumentDuplicateDocumentRequest +# DocumentDuplicateRequest ## Fields diff --git a/docs/models/documentduplicateresponse.md b/docs/models/documentduplicateresponse.md new file mode 100644 index 0000000..5b96313 --- /dev/null +++ b/docs/models/documentduplicateresponse.md @@ -0,0 +1,11 @@ +# DocumentDuplicateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ---------------------- | ---------------------- | ---------------------- | ---------------------- | +| `id` | *str* | :heavy_check_mark: | The envelope ID | +| `document_id` | *float* | :heavy_check_mark: | The legacy document ID | \ No newline at end of file diff --git a/docs/models/documentfield.md b/docs/models/documentfield.md index 8c124b0..116842d 100644 --- a/docs/models/documentfield.md +++ b/docs/models/documentfield.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.DocumentFieldType](../models/documentfieldtype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.DocumentFieldMetaUnion]](../models/documentfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.DocumentFieldMetaUnion]](../models/documentfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfindaccessauth.md b/docs/models/documentfindaccessauth.md new file mode 100644 index 0000000..7030b9a --- /dev/null +++ b/docs/models/documentfindaccessauth.md @@ -0,0 +1,11 @@ +# DocumentFindAccessAuth + +The type of authentication required for the recipient to access the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsactionauth.md b/docs/models/documentfindactionauth.md similarity index 91% rename from docs/models/documentfinddocumentsactionauth.md rename to docs/models/documentfindactionauth.md index 31a0c8f..bf21313 100644 --- a/docs/models/documentfinddocumentsactionauth.md +++ b/docs/models/documentfindactionauth.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsActionAuth +# DocumentFindActionAuth The type of authentication required for the recipient to sign the document. diff --git a/docs/models/documentupdatedocumentrequest.md b/docs/models/documentfindauthoptions.md similarity index 54% rename from docs/models/documentupdatedocumentrequest.md rename to docs/models/documentfindauthoptions.md index 8ffc3fc..7cceb5b 100644 --- a/docs/models/documentupdatedocumentrequest.md +++ b/docs/models/documentfindauthoptions.md @@ -1,10 +1,9 @@ -# DocumentUpdateDocumentRequest +# DocumentFindAuthOptions ## Fields | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `document_id` | *float* | :heavy_check_mark: | N/A | -| `data` | [Optional[models.DocumentUpdateDocumentData]](../models/documentupdatedocumentdata.md) | :heavy_minus_sign: | N/A | -| `meta` | [Optional[models.DocumentUpdateDocumentMeta]](../models/documentupdatedocumentmeta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `global_access_auth` | List[[models.DocumentFindGlobalAccessAuth](../models/documentfindglobalaccessauth.md)] | :heavy_check_mark: | N/A | +| `global_action_auth` | List[[models.DocumentFindGlobalActionAuth](../models/documentfindglobalactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfindbadrequesterror.md b/docs/models/documentfindbadrequesterror.md new file mode 100644 index 0000000..d33811f --- /dev/null +++ b/docs/models/documentfindbadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentFindBadRequestError + +Invalid input data + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentFindBadRequestIssue](../models/documentfindbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfindbadrequestissue.md b/docs/models/documentfindbadrequestissue.md new file mode 100644 index 0000000..54fb183 --- /dev/null +++ b/docs/models/documentfindbadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentFindBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddata.md b/docs/models/documentfinddata.md new file mode 100644 index 0000000..3c0bef6 --- /dev/null +++ b/docs/models/documentfinddata.md @@ -0,0 +1,29 @@ +# DocumentFindData + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `visibility` | [models.DocumentFindVisibility](../models/documentfindvisibility.md) | :heavy_check_mark: | N/A | +| `status` | [models.DataStatus](../models/datastatus.md) | :heavy_check_mark: | N/A | +| `source` | [models.DataSource](../models/datasource.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `external_id` | *Nullable[str]* | :heavy_check_mark: | A custom external ID you can use to identify the document. | +| `user_id` | *float* | :heavy_check_mark: | The ID of the user that created this document. | +| `auth_options` | [Nullable[models.DocumentFindAuthOptions]](../models/documentfindauthoptions.md) | :heavy_check_mark: | N/A | +| `form_values` | Dict[str, [models.DocumentFindFormValues](../models/documentfindformvalues.md)] | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | +| `user` | [models.DocumentFindUser](../models/documentfinduser.md) | :heavy_check_mark: | N/A | +| `recipients` | List[[models.DocumentFindRecipient](../models/documentfindrecipient.md)] | :heavy_check_mark: | N/A | +| `team` | [Nullable[models.DocumentFindTeam]](../models/documentfindteam.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsaccessauth.md b/docs/models/documentfinddocumentsaccessauth.md deleted file mode 100644 index 0ad503a..0000000 --- a/docs/models/documentfinddocumentsaccessauth.md +++ /dev/null @@ -1,10 +0,0 @@ -# DocumentFindDocumentsAccessAuth - -The type of authentication required for the recipient to access the document. - - -## Values - -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsauthoptions.md b/docs/models/documentfinddocumentsauthoptions.md deleted file mode 100644 index 408c70f..0000000 --- a/docs/models/documentfinddocumentsauthoptions.md +++ /dev/null @@ -1,9 +0,0 @@ -# DocumentFindDocumentsAuthOptions - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `global_access_auth` | List[[models.DocumentFindDocumentsGlobalAccessAuth](../models/documentfinddocumentsglobalaccessauth.md)] | :heavy_check_mark: | N/A | -| `global_action_auth` | List[[models.DocumentFindDocumentsGlobalActionAuth](../models/documentfinddocumentsglobalactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsdata.md b/docs/models/documentfinddocumentsdata.md deleted file mode 100644 index 21b8d3b..0000000 --- a/docs/models/documentfinddocumentsdata.md +++ /dev/null @@ -1,28 +0,0 @@ -# DocumentFindDocumentsData - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `visibility` | [models.DocumentFindDocumentsVisibility](../models/documentfinddocumentsvisibility.md) | :heavy_check_mark: | N/A | -| `status` | [models.DataStatus](../models/datastatus.md) | :heavy_check_mark: | N/A | -| `source` | [models.DataSource](../models/datasource.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | -| `external_id` | *Nullable[str]* | :heavy_check_mark: | A custom external ID you can use to identify the document. | -| `user_id` | *float* | :heavy_check_mark: | The ID of the user that created this document. | -| `auth_options` | [Nullable[models.DocumentFindDocumentsAuthOptions]](../models/documentfinddocumentsauthoptions.md) | :heavy_check_mark: | N/A | -| `form_values` | Dict[str, [models.DocumentFindDocumentsFormValues](../models/documentfinddocumentsformvalues.md)] | :heavy_check_mark: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `document_data_id` | *str* | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `updated_at` | *str* | :heavy_check_mark: | N/A | -| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `team_id` | *float* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | -| `user` | [models.DocumentFindDocumentsUser](../models/documentfinddocumentsuser.md) | :heavy_check_mark: | N/A | -| `recipients` | List[[models.DocumentFindDocumentsRecipient](../models/documentfinddocumentsrecipient.md)] | :heavy_check_mark: | N/A | -| `team` | [Nullable[models.DocumentFindDocumentsTeam]](../models/documentfinddocumentsteam.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsglobalaccessauth.md b/docs/models/documentfinddocumentsglobalaccessauth.md deleted file mode 100644 index 843bee6..0000000 --- a/docs/models/documentfinddocumentsglobalaccessauth.md +++ /dev/null @@ -1,10 +0,0 @@ -# DocumentFindDocumentsGlobalAccessAuth - -The type of authentication required for the recipient to access the document. - - -## Values - -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsinternalservererror.md b/docs/models/documentfinddocumentsinternalservererror.md deleted file mode 100644 index 5efc1b1..0000000 --- a/docs/models/documentfinddocumentsinternalservererror.md +++ /dev/null @@ -1,12 +0,0 @@ -# DocumentFindDocumentsInternalServerError - -Internal server error - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentFindDocumentsInternalServerErrorIssue](../models/documentfinddocumentsinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsinternalservererrorissue.md b/docs/models/documentfinddocumentsinternalservererrorissue.md deleted file mode 100644 index d8dd5f1..0000000 --- a/docs/models/documentfinddocumentsinternalservererrorissue.md +++ /dev/null @@ -1,8 +0,0 @@ -# DocumentFindDocumentsInternalServerErrorIssue - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsrecipient.md b/docs/models/documentfinddocumentsrecipient.md deleted file mode 100644 index 7c53a59..0000000 --- a/docs/models/documentfinddocumentsrecipient.md +++ /dev/null @@ -1,23 +0,0 @@ -# DocumentFindDocumentsRecipient - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `role` | [models.DocumentFindDocumentsRole](../models/documentfinddocumentsrole.md) | :heavy_check_mark: | N/A | -| `read_status` | [models.DocumentFindDocumentsReadStatus](../models/documentfinddocumentsreadstatus.md) | :heavy_check_mark: | N/A | -| `signing_status` | [models.DocumentFindDocumentsSigningStatus](../models/documentfinddocumentssigningstatus.md) | :heavy_check_mark: | N/A | -| `send_status` | [models.DocumentFindDocumentsSendStatus](../models/documentfinddocumentssendstatus.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `email` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `document_deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `auth_options` | [Nullable[models.DocumentFindDocumentsRecipientAuthOptions]](../models/documentfinddocumentsrecipientauthoptions.md) | :heavy_check_mark: | N/A | -| `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsresponse.md b/docs/models/documentfinddocumentsresponse.md deleted file mode 100644 index ec79e53..0000000 --- a/docs/models/documentfinddocumentsresponse.md +++ /dev/null @@ -1,14 +0,0 @@ -# DocumentFindDocumentsResponse - -Successful response - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `data` | List[[models.DocumentFindDocumentsData](../models/documentfinddocumentsdata.md)] | :heavy_check_mark: | N/A | -| `count` | *float* | :heavy_check_mark: | The total number of items. | -| `current_page` | *float* | :heavy_check_mark: | The current page number, starts at 1. | -| `per_page` | *float* | :heavy_check_mark: | The number of items per page. | -| `total_pages` | *float* | :heavy_check_mark: | The total number of pages. | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsformvalues.md b/docs/models/documentfindformvalues.md similarity index 85% rename from docs/models/documentfinddocumentsformvalues.md rename to docs/models/documentfindformvalues.md index 0e5e789..c386ebb 100644 --- a/docs/models/documentfinddocumentsformvalues.md +++ b/docs/models/documentfindformvalues.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsFormValues +# DocumentFindFormValues ## Supported Types diff --git a/docs/models/documentfindglobalaccessauth.md b/docs/models/documentfindglobalaccessauth.md new file mode 100644 index 0000000..9369665 --- /dev/null +++ b/docs/models/documentfindglobalaccessauth.md @@ -0,0 +1,11 @@ +# DocumentFindGlobalAccessAuth + +The type of authentication required for the recipient to access the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsglobalactionauth.md b/docs/models/documentfindglobalactionauth.md similarity index 90% rename from docs/models/documentfinddocumentsglobalactionauth.md rename to docs/models/documentfindglobalactionauth.md index acbc433..81c7ca6 100644 --- a/docs/models/documentfinddocumentsglobalactionauth.md +++ b/docs/models/documentfindglobalactionauth.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsGlobalActionAuth +# DocumentFindGlobalActionAuth The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. diff --git a/docs/models/documentfinddocumentsbadrequesterror.md b/docs/models/documentfindinternalservererror.md similarity index 91% rename from docs/models/documentfinddocumentsbadrequesterror.md rename to docs/models/documentfindinternalservererror.md index 3e68c47..e06e817 100644 --- a/docs/models/documentfinddocumentsbadrequesterror.md +++ b/docs/models/documentfindinternalservererror.md @@ -1,6 +1,6 @@ -# DocumentFindDocumentsBadRequestError +# DocumentFindInternalServerError -Invalid input data +Internal server error ## Fields @@ -9,4 +9,4 @@ Invalid input data | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `message` | *str* | :heavy_check_mark: | N/A | | `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentFindDocumentsBadRequestIssue](../models/documentfinddocumentsbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.DocumentFindInternalServerErrorIssue](../models/documentfindinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfindinternalservererrorissue.md b/docs/models/documentfindinternalservererrorissue.md new file mode 100644 index 0000000..01342ab --- /dev/null +++ b/docs/models/documentfindinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentFindInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfindnotfounderror.md b/docs/models/documentfindnotfounderror.md new file mode 100644 index 0000000..ca51893 --- /dev/null +++ b/docs/models/documentfindnotfounderror.md @@ -0,0 +1,12 @@ +# DocumentFindNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentFindNotFoundIssue](../models/documentfindnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfindnotfoundissue.md b/docs/models/documentfindnotfoundissue.md new file mode 100644 index 0000000..4dba3af --- /dev/null +++ b/docs/models/documentfindnotfoundissue.md @@ -0,0 +1,8 @@ +# DocumentFindNotFoundIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsreadstatus.md b/docs/models/documentfindreadstatus.md similarity index 80% rename from docs/models/documentfinddocumentsreadstatus.md rename to docs/models/documentfindreadstatus.md index 88dd131..6881bbe 100644 --- a/docs/models/documentfinddocumentsreadstatus.md +++ b/docs/models/documentfindreadstatus.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsReadStatus +# DocumentFindReadStatus ## Values diff --git a/docs/models/documentfindrecipient.md b/docs/models/documentfindrecipient.md new file mode 100644 index 0000000..382be0d --- /dev/null +++ b/docs/models/documentfindrecipient.md @@ -0,0 +1,24 @@ +# DocumentFindRecipient + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `role` | [models.DocumentFindRole](../models/documentfindrole.md) | :heavy_check_mark: | N/A | +| `read_status` | [models.DocumentFindReadStatus](../models/documentfindreadstatus.md) | :heavy_check_mark: | N/A | +| `signing_status` | [models.DocumentFindSigningStatus](../models/documentfindsigningstatus.md) | :heavy_check_mark: | N/A | +| `send_status` | [models.DocumentFindSendStatus](../models/documentfindsendstatus.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `email` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | +| `document_deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `auth_options` | [Nullable[models.DocumentFindRecipientAuthOptions]](../models/documentfindrecipientauthoptions.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfindrecipientauthoptions.md b/docs/models/documentfindrecipientauthoptions.md new file mode 100644 index 0000000..de7951c --- /dev/null +++ b/docs/models/documentfindrecipientauthoptions.md @@ -0,0 +1,9 @@ +# DocumentFindRecipientAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `access_auth` | List[[models.DocumentFindAccessAuth](../models/documentfindaccessauth.md)] | :heavy_check_mark: | N/A | +| `action_auth` | List[[models.DocumentFindActionAuth](../models/documentfindactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsrequest.md b/docs/models/documentfindrequest.md similarity index 99% rename from docs/models/documentfinddocumentsrequest.md rename to docs/models/documentfindrequest.md index 5e73587..0a119ca 100644 --- a/docs/models/documentfinddocumentsrequest.md +++ b/docs/models/documentfindrequest.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsRequest +# DocumentFindRequest ## Fields diff --git a/docs/models/documentfindresponse.md b/docs/models/documentfindresponse.md new file mode 100644 index 0000000..e1ee428 --- /dev/null +++ b/docs/models/documentfindresponse.md @@ -0,0 +1,14 @@ +# DocumentFindResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `data` | List[[models.DocumentFindData](../models/documentfinddata.md)] | :heavy_check_mark: | N/A | +| `count` | *float* | :heavy_check_mark: | The total number of items. | +| `current_page` | *float* | :heavy_check_mark: | The current page number, starts at 1. | +| `per_page` | *float* | :heavy_check_mark: | The number of items per page. | +| `total_pages` | *float* | :heavy_check_mark: | The total number of pages. | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsrole.md b/docs/models/documentfindrole.md similarity index 88% rename from docs/models/documentfinddocumentsrole.md rename to docs/models/documentfindrole.md index 0e646bb..fe63314 100644 --- a/docs/models/documentfinddocumentsrole.md +++ b/docs/models/documentfindrole.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsRole +# DocumentFindRole ## Values diff --git a/docs/models/documentfinddocumentssendstatus.md b/docs/models/documentfindsendstatus.md similarity index 78% rename from docs/models/documentfinddocumentssendstatus.md rename to docs/models/documentfindsendstatus.md index 11723b5..7056983 100644 --- a/docs/models/documentfinddocumentssendstatus.md +++ b/docs/models/documentfindsendstatus.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsSendStatus +# DocumentFindSendStatus ## Values diff --git a/docs/models/documentfinddocumentssigningstatus.md b/docs/models/documentfindsigningstatus.md similarity index 82% rename from docs/models/documentfinddocumentssigningstatus.md rename to docs/models/documentfindsigningstatus.md index a19c17a..78e0d85 100644 --- a/docs/models/documentfinddocumentssigningstatus.md +++ b/docs/models/documentfindsigningstatus.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsSigningStatus +# DocumentFindSigningStatus ## Values diff --git a/docs/models/documentfinddocumentsteam.md b/docs/models/documentfindteam.md similarity index 92% rename from docs/models/documentfinddocumentsteam.md rename to docs/models/documentfindteam.md index 7a83b34..f0fe218 100644 --- a/docs/models/documentfinddocumentsteam.md +++ b/docs/models/documentfindteam.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsTeam +# DocumentFindTeam ## Fields diff --git a/docs/models/documentfinddocumentsuser.md b/docs/models/documentfinduser.md similarity index 94% rename from docs/models/documentfinddocumentsuser.md rename to docs/models/documentfinduser.md index d998aab..d3121d4 100644 --- a/docs/models/documentfinddocumentsuser.md +++ b/docs/models/documentfinduser.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsUser +# DocumentFindUser ## Fields diff --git a/docs/models/documentfinddocumentsvisibility.md b/docs/models/documentfindvisibility.md similarity index 87% rename from docs/models/documentfinddocumentsvisibility.md rename to docs/models/documentfindvisibility.md index 373908d..6b3ae8d 100644 --- a/docs/models/documentfinddocumentsvisibility.md +++ b/docs/models/documentfindvisibility.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsVisibility +# DocumentFindVisibility ## Values diff --git a/docs/models/documentgetaccessauth.md b/docs/models/documentgetaccessauth.md new file mode 100644 index 0000000..7bd12c5 --- /dev/null +++ b/docs/models/documentgetaccessauth.md @@ -0,0 +1,11 @@ +# DocumentGetAccessAuth + +The type of authentication required for the recipient to access the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidactionauth.md b/docs/models/documentgetactionauth.md similarity index 89% rename from docs/models/documentgetdocumentwithdetailsbyidactionauth.md rename to docs/models/documentgetactionauth.md index 1a28804..0b6ece6 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidactionauth.md +++ b/docs/models/documentgetactionauth.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDActionAuth +# DocumentGetActionAuth The type of authentication required for the recipient to sign the document. diff --git a/docs/models/documentgetauthoptions.md b/docs/models/documentgetauthoptions.md new file mode 100644 index 0000000..0cae9d4 --- /dev/null +++ b/docs/models/documentgetauthoptions.md @@ -0,0 +1,9 @@ +# DocumentGetAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `global_access_auth` | List[[models.DocumentGetGlobalAccessAuth](../models/documentgetglobalaccessauth.md)] | :heavy_check_mark: | N/A | +| `global_action_auth` | List[[models.DocumentGetGlobalActionAuth](../models/documentgetglobalactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentrequest.md b/docs/models/documentgetbadrequesterror.md similarity index 56% rename from docs/models/documentsenddocumentrequest.md rename to docs/models/documentgetbadrequesterror.md index e76017b..7a2802b 100644 --- a/docs/models/documentsenddocumentrequest.md +++ b/docs/models/documentgetbadrequesterror.md @@ -1,9 +1,12 @@ -# DocumentSendDocumentRequest +# DocumentGetBadRequestError + +Invalid input data ## Fields | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `document_id` | *float* | :heavy_check_mark: | The ID of the document to send. | -| `meta` | [Optional[models.DocumentSendDocumentMeta]](../models/documentsenddocumentmeta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentGetBadRequestIssue](../models/documentgetbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetbadrequestissue.md b/docs/models/documentgetbadrequestissue.md new file mode 100644 index 0000000..5fba889 --- /dev/null +++ b/docs/models/documentgetbadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentGetBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdirection.md b/docs/models/documentgetdirection.md new file mode 100644 index 0000000..fd15eea --- /dev/null +++ b/docs/models/documentgetdirection.md @@ -0,0 +1,9 @@ +# DocumentGetDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyiddistributionmethod.md b/docs/models/documentgetdistributionmethod.md similarity index 64% rename from docs/models/documentgetdocumentwithdetailsbyiddistributionmethod.md rename to docs/models/documentgetdistributionmethod.md index 5b82747..360c32d 100644 --- a/docs/models/documentgetdocumentwithdetailsbyiddistributionmethod.md +++ b/docs/models/documentgetdistributionmethod.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDDistributionMethod +# DocumentGetDistributionMethod ## Values diff --git a/docs/models/documentgetdocumentdata.md b/docs/models/documentgetdocumentdata.md new file mode 100644 index 0000000..864f02c --- /dev/null +++ b/docs/models/documentgetdocumentdata.md @@ -0,0 +1,12 @@ +# DocumentGetDocumentData + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `type` | [models.DocumentGetDocumentDataType](../models/documentgetdocumentdatatype.md) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | +| `initial_data` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatedocumentdatatype.md b/docs/models/documentgetdocumentdatatype.md similarity index 83% rename from docs/models/templatedocumentdatatype.md rename to docs/models/documentgetdocumentdatatype.md index 8e3161f..9683150 100644 --- a/docs/models/templatedocumentdatatype.md +++ b/docs/models/documentgetdocumentdatatype.md @@ -1,4 +1,4 @@ -# TemplateDocumentDataType +# DocumentGetDocumentDataType ## Values diff --git a/docs/models/documentgetdocumentmeta.md b/docs/models/documentgetdocumentmeta.md new file mode 100644 index 0000000..a5a7a2e --- /dev/null +++ b/docs/models/documentgetdocumentmeta.md @@ -0,0 +1,25 @@ +# DocumentGetDocumentMeta + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `signing_order` | [models.DocumentGetSigningOrder](../models/documentgetsigningorder.md) | :heavy_check_mark: | N/A | +| `distribution_method` | [models.DocumentGetDistributionMethod](../models/documentgetdistributionmethod.md) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `subject` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `message` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `timezone` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `date_format` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `redirect_url` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `typed_signature_enabled` | *bool* | :heavy_check_mark: | N/A | +| `upload_signature_enabled` | *bool* | :heavy_check_mark: | N/A | +| `draw_signature_enabled` | *bool* | :heavy_check_mark: | N/A | +| `allow_dictate_next_signer` | *bool* | :heavy_check_mark: | N/A | +| `language` | *str* | :heavy_check_mark: | N/A | +| `email_settings` | [Nullable[models.DocumentGetEmailSettings]](../models/documentgetemailsettings.md) | :heavy_check_mark: | N/A | +| `email_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `email_reply_to` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `document_id` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidaccessauth.md b/docs/models/documentgetdocumentwithdetailsbyidaccessauth.md deleted file mode 100644 index a7746b2..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidaccessauth.md +++ /dev/null @@ -1,10 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDAccessAuth - -The type of authentication required for the recipient to access the document. - - -## Values - -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidbadrequesterror.md b/docs/models/documentgetdocumentwithdetailsbyidbadrequesterror.md deleted file mode 100644 index 038bc4e..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidbadrequesterror.md +++ /dev/null @@ -1,12 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDBadRequestError - -Invalid input data - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentGetDocumentWithDetailsByIDBadRequestIssue](../models/documentgetdocumentwithdetailsbyidbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidbadrequestissue.md b/docs/models/documentgetdocumentwithdetailsbyidbadrequestissue.md deleted file mode 100644 index dfe6d62..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidbadrequestissue.md +++ /dev/null @@ -1,8 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDBadRequestIssue - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyiddocumentdata.md b/docs/models/documentgetdocumentwithdetailsbyiddocumentdata.md deleted file mode 100644 index 5e6eb55..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyiddocumentdata.md +++ /dev/null @@ -1,11 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDDocumentData - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `type` | [models.DocumentGetDocumentWithDetailsByIDDocumentDataType](../models/documentgetdocumentwithdetailsbyiddocumentdatatype.md) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `data` | *str* | :heavy_check_mark: | N/A | -| `initial_data` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyiddocumentmeta.md b/docs/models/documentgetdocumentwithdetailsbyiddocumentmeta.md deleted file mode 100644 index f8d11d9..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyiddocumentmeta.md +++ /dev/null @@ -1,23 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDDocumentMeta - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `signing_order` | [models.DocumentGetDocumentWithDetailsByIDSigningOrder](../models/documentgetdocumentwithdetailsbyidsigningorder.md) | :heavy_check_mark: | N/A | -| `distribution_method` | [models.DocumentGetDocumentWithDetailsByIDDistributionMethod](../models/documentgetdocumentwithdetailsbyiddistributionmethod.md) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `subject` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `message` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `timezone` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `password` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `date_format` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `document_id` | *float* | :heavy_check_mark: | N/A | -| `redirect_url` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `typed_signature_enabled` | *bool* | :heavy_check_mark: | N/A | -| `upload_signature_enabled` | *bool* | :heavy_check_mark: | N/A | -| `draw_signature_enabled` | *bool* | :heavy_check_mark: | N/A | -| `allow_dictate_next_signer` | *bool* | :heavy_check_mark: | N/A | -| `language` | *str* | :heavy_check_mark: | N/A | -| `email_settings` | [Nullable[models.DocumentGetDocumentWithDetailsByIDEmailSettings]](../models/documentgetdocumentwithdetailsbyidemailsettings.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfield.md b/docs/models/documentgetdocumentwithdetailsbyidfield.md deleted file mode 100644 index 0f0a1f4..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidfield.md +++ /dev/null @@ -1,21 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDField - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [models.DocumentGetDocumentWithDetailsByIDFieldType](../models/documentgetdocumentwithdetailsbyidfieldtype.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | -| `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | N/A | -| `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | -| `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `position_y` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `width` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `custom_text` | *str* | :heavy_check_mark: | N/A | -| `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.DocumentGetDocumentWithDetailsByIDFieldMetaUnion]](../models/documentgetdocumentwithdetailsbyidfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetadate.md b/docs/models/documentgetdocumentwithdetailsbyidfieldmetadate.md deleted file mode 100644 index 75a8b42..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetadate.md +++ /dev/null @@ -1,14 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaDate - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentGetDocumentWithDetailsByIDTypeDate](../models/documentgetdocumentwithdetailsbyidtypedate.md) | :heavy_check_mark: | N/A | -| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `text_align` | [Optional[models.DocumentGetDocumentWithDetailsByIDTextAlign4]](../models/documentgetdocumentwithdetailsbyidtextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaemail.md b/docs/models/documentgetdocumentwithdetailsbyidfieldmetaemail.md deleted file mode 100644 index c47f5e3..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaemail.md +++ /dev/null @@ -1,14 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaEmail - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentGetDocumentWithDetailsByIDTypeEmail](../models/documentgetdocumentwithdetailsbyidtypeemail.md) | :heavy_check_mark: | N/A | -| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `text_align` | [Optional[models.DocumentGetDocumentWithDetailsByIDTextAlign3]](../models/documentgetdocumentwithdetailsbyidtextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetainitials.md b/docs/models/documentgetdocumentwithdetailsbyidfieldmetainitials.md deleted file mode 100644 index b080691..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetainitials.md +++ /dev/null @@ -1,14 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaInitials - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentGetDocumentWithDetailsByIDTypeInitials](../models/documentgetdocumentwithdetailsbyidtypeinitials.md) | :heavy_check_mark: | N/A | -| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `text_align` | [Optional[models.DocumentGetDocumentWithDetailsByIDTextAlign1]](../models/documentgetdocumentwithdetailsbyidtextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaname.md b/docs/models/documentgetdocumentwithdetailsbyidfieldmetaname.md deleted file mode 100644 index d394d3d..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaname.md +++ /dev/null @@ -1,14 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaName - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentGetDocumentWithDetailsByIDTypeName](../models/documentgetdocumentwithdetailsbyidtypename.md) | :heavy_check_mark: | N/A | -| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `text_align` | [Optional[models.DocumentGetDocumentWithDetailsByIDTextAlign2]](../models/documentgetdocumentwithdetailsbyidtextalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetanumber.md b/docs/models/documentgetdocumentwithdetailsbyidfieldmetanumber.md deleted file mode 100644 index 369aa84..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetanumber.md +++ /dev/null @@ -1,18 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaNumber - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentGetDocumentWithDetailsByIDTypeNumber](../models/documentgetdocumentwithdetailsbyidtypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `text_align` | [Optional[models.DocumentGetDocumentWithDetailsByIDTextAlign6]](../models/documentgetdocumentwithdetailsbyidtextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetatext.md b/docs/models/documentgetdocumentwithdetailsbyidfieldmetatext.md deleted file mode 100644 index 9bb8610..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetatext.md +++ /dev/null @@ -1,16 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaText - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentGetDocumentWithDetailsByIDTypeText](../models/documentgetdocumentwithdetailsbyidtypetext.md) | :heavy_check_mark: | N/A | -| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `text_align` | [Optional[models.DocumentGetDocumentWithDetailsByIDTextAlign5]](../models/documentgetdocumentwithdetailsbyidtextalign5.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaunion.md b/docs/models/documentgetdocumentwithdetailsbyidfieldmetaunion.md deleted file mode 100644 index 29a4197..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaunion.md +++ /dev/null @@ -1,59 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaUnion - - -## Supported Types - -### `models.DocumentGetDocumentWithDetailsByIDFieldMetaInitials` - -```python -value: models.DocumentGetDocumentWithDetailsByIDFieldMetaInitials = /* values here */ -``` - -### `models.DocumentGetDocumentWithDetailsByIDFieldMetaName` - -```python -value: models.DocumentGetDocumentWithDetailsByIDFieldMetaName = /* values here */ -``` - -### `models.DocumentGetDocumentWithDetailsByIDFieldMetaEmail` - -```python -value: models.DocumentGetDocumentWithDetailsByIDFieldMetaEmail = /* values here */ -``` - -### `models.DocumentGetDocumentWithDetailsByIDFieldMetaDate` - -```python -value: models.DocumentGetDocumentWithDetailsByIDFieldMetaDate = /* values here */ -``` - -### `models.DocumentGetDocumentWithDetailsByIDFieldMetaText` - -```python -value: models.DocumentGetDocumentWithDetailsByIDFieldMetaText = /* values here */ -``` - -### `models.DocumentGetDocumentWithDetailsByIDFieldMetaNumber` - -```python -value: models.DocumentGetDocumentWithDetailsByIDFieldMetaNumber = /* values here */ -``` - -### `models.DocumentGetDocumentWithDetailsByIDFieldMetaRadio` - -```python -value: models.DocumentGetDocumentWithDetailsByIDFieldMetaRadio = /* values here */ -``` - -### `models.DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox` - -```python -value: models.DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox = /* values here */ -``` - -### `models.DocumentGetDocumentWithDetailsByIDFieldMetaDropdown` - -```python -value: models.DocumentGetDocumentWithDetailsByIDFieldMetaDropdown = /* values here */ -``` - diff --git a/docs/models/documentgetdocumentwithdetailsbyidfoldervisibility.md b/docs/models/documentgetdocumentwithdetailsbyidfoldervisibility.md deleted file mode 100644 index 6e745c0..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidfoldervisibility.md +++ /dev/null @@ -1,10 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDFolderVisibility - - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `EVERYONE` | EVERYONE | -| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | -| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidglobalaccessauth.md b/docs/models/documentgetdocumentwithdetailsbyidglobalaccessauth.md deleted file mode 100644 index 3019948..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidglobalaccessauth.md +++ /dev/null @@ -1,10 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDGlobalAccessAuth - -The type of authentication required for the recipient to access the document. - - -## Values - -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidinternalservererrorissue.md b/docs/models/documentgetdocumentwithdetailsbyidinternalservererrorissue.md deleted file mode 100644 index b6b2cb6..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidinternalservererrorissue.md +++ /dev/null @@ -1,8 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDInternalServerErrorIssue - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidnotfounderror.md b/docs/models/documentgetdocumentwithdetailsbyidnotfounderror.md deleted file mode 100644 index 4778e7d..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidnotfounderror.md +++ /dev/null @@ -1,12 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDNotFoundError - -Not found - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentGetDocumentWithDetailsByIDNotFoundIssue](../models/documentgetdocumentwithdetailsbyidnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidnotfoundissue.md b/docs/models/documentgetdocumentwithdetailsbyidnotfoundissue.md deleted file mode 100644 index bbef529..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidnotfoundissue.md +++ /dev/null @@ -1,8 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDNotFoundIssue - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidrecipientauthoptions.md b/docs/models/documentgetdocumentwithdetailsbyidrecipientauthoptions.md deleted file mode 100644 index df95a3a..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidrecipientauthoptions.md +++ /dev/null @@ -1,9 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDRecipientAuthOptions - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `access_auth` | List[[models.DocumentGetDocumentWithDetailsByIDAccessAuth](../models/documentgetdocumentwithdetailsbyidaccessauth.md)] | :heavy_check_mark: | N/A | -| `action_auth` | List[[models.DocumentGetDocumentWithDetailsByIDActionAuth](../models/documentgetdocumentwithdetailsbyidactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidrequest.md b/docs/models/documentgetdocumentwithdetailsbyidrequest.md deleted file mode 100644 index f237f41..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidrequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDRequest - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `document_id` | *float* | :heavy_check_mark: | N/A | -| `folder_id` | *Optional[str]* | :heavy_minus_sign: | Filter documents by folder ID | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtextalign5.md b/docs/models/documentgetdocumentwithdetailsbyidtextalign5.md deleted file mode 100644 index 6af7ace..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidtextalign5.md +++ /dev/null @@ -1,10 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDTextAlign5 - - -## Values - -| Name | Value | -| -------- | -------- | -| `LEFT` | left | -| `CENTER` | center | -| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtextalign6.md b/docs/models/documentgetdocumentwithdetailsbyidtextalign6.md deleted file mode 100644 index 528dc69..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidtextalign6.md +++ /dev/null @@ -1,10 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDTextAlign6 - - -## Values - -| Name | Value | -| -------- | -------- | -| `LEFT` | left | -| `CENTER` | center | -| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentemailsettings.md b/docs/models/documentgetemailsettings.md similarity index 99% rename from docs/models/documentupdatedocumentemailsettings.md rename to docs/models/documentgetemailsettings.md index c27f020..30eb9e5 100644 --- a/docs/models/documentupdatedocumentemailsettings.md +++ b/docs/models/documentgetemailsettings.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentEmailSettings +# DocumentGetEmailSettings ## Fields diff --git a/docs/models/documentgetfield.md b/docs/models/documentgetfield.md new file mode 100644 index 0000000..ab6b3f6 --- /dev/null +++ b/docs/models/documentgetfield.md @@ -0,0 +1,23 @@ +# DocumentGetField + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.DocumentGetFieldType](../models/documentgetfieldtype.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `secondary_id` | *str* | :heavy_check_mark: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | +| `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `custom_text` | *str* | :heavy_check_mark: | N/A | +| `inserted` | *bool* | :heavy_check_mark: | N/A | +| `field_meta` | [Nullable[models.DocumentGetFieldMetaUnion]](../models/documentgetfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfieldmetacheckbox.md b/docs/models/documentgetfieldmetacheckbox.md new file mode 100644 index 0000000..c9cb38f --- /dev/null +++ b/docs/models/documentgetfieldmetacheckbox.md @@ -0,0 +1,16 @@ +# DocumentGetFieldMetaCheckbox + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeCheckbox](../models/documentgettypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.DocumentGetValue2](../models/documentgetvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.DocumentGetDirection]](../models/documentgetdirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfieldmetadate.md b/docs/models/documentgetfieldmetadate.md new file mode 100644 index 0000000..663c011 --- /dev/null +++ b/docs/models/documentgetfieldmetadate.md @@ -0,0 +1,14 @@ +# DocumentGetFieldMetaDate + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeDate](../models/documentgettypedate.md) | :heavy_check_mark: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.DocumentGetTextAlign4]](../models/documentgettextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfieldmetadropdown.md b/docs/models/documentgetfieldmetadropdown.md new file mode 100644 index 0000000..c26c3a6 --- /dev/null +++ b/docs/models/documentgetfieldmetadropdown.md @@ -0,0 +1,14 @@ +# DocumentGetFieldMetaDropdown + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeDropdown](../models/documentgettypedropdown.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.DocumentGetValue3](../models/documentgetvalue3.md)] | :heavy_minus_sign: | N/A | +| `default_value` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfieldmetaemail.md b/docs/models/documentgetfieldmetaemail.md new file mode 100644 index 0000000..a6f1c4b --- /dev/null +++ b/docs/models/documentgetfieldmetaemail.md @@ -0,0 +1,14 @@ +# DocumentGetFieldMetaEmail + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeEmail](../models/documentgettypeemail.md) | :heavy_check_mark: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.DocumentGetTextAlign3]](../models/documentgettextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfieldmetainitials.md b/docs/models/documentgetfieldmetainitials.md new file mode 100644 index 0000000..2c7351d --- /dev/null +++ b/docs/models/documentgetfieldmetainitials.md @@ -0,0 +1,14 @@ +# DocumentGetFieldMetaInitials + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeInitials](../models/documentgettypeinitials.md) | :heavy_check_mark: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.DocumentGetTextAlign1]](../models/documentgettextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfieldmetaname.md b/docs/models/documentgetfieldmetaname.md new file mode 100644 index 0000000..88070b4 --- /dev/null +++ b/docs/models/documentgetfieldmetaname.md @@ -0,0 +1,14 @@ +# DocumentGetFieldMetaName + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeName](../models/documentgettypename.md) | :heavy_check_mark: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.DocumentGetTextAlign2]](../models/documentgettextalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfieldmetanumber.md b/docs/models/documentgetfieldmetanumber.md new file mode 100644 index 0000000..9fd62f8 --- /dev/null +++ b/docs/models/documentgetfieldmetanumber.md @@ -0,0 +1,18 @@ +# DocumentGetFieldMetaNumber + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeNumber](../models/documentgettypenumber.md) | :heavy_check_mark: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.DocumentGetTextAlign6]](../models/documentgettextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfieldmetaradio.md b/docs/models/documentgetfieldmetaradio.md new file mode 100644 index 0000000..07a584c --- /dev/null +++ b/docs/models/documentgetfieldmetaradio.md @@ -0,0 +1,13 @@ +# DocumentGetFieldMetaRadio + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeRadio](../models/documentgettyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.DocumentGetValue1](../models/documentgetvalue1.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfieldmetatext.md b/docs/models/documentgetfieldmetatext.md new file mode 100644 index 0000000..dee8ea0 --- /dev/null +++ b/docs/models/documentgetfieldmetatext.md @@ -0,0 +1,16 @@ +# DocumentGetFieldMetaText + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeText](../models/documentgettypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.DocumentGetTextAlign5]](../models/documentgettextalign5.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfieldmetaunion.md b/docs/models/documentgetfieldmetaunion.md new file mode 100644 index 0000000..db3895d --- /dev/null +++ b/docs/models/documentgetfieldmetaunion.md @@ -0,0 +1,59 @@ +# DocumentGetFieldMetaUnion + + +## Supported Types + +### `models.DocumentGetFieldMetaInitials` + +```python +value: models.DocumentGetFieldMetaInitials = /* values here */ +``` + +### `models.DocumentGetFieldMetaName` + +```python +value: models.DocumentGetFieldMetaName = /* values here */ +``` + +### `models.DocumentGetFieldMetaEmail` + +```python +value: models.DocumentGetFieldMetaEmail = /* values here */ +``` + +### `models.DocumentGetFieldMetaDate` + +```python +value: models.DocumentGetFieldMetaDate = /* values here */ +``` + +### `models.DocumentGetFieldMetaText` + +```python +value: models.DocumentGetFieldMetaText = /* values here */ +``` + +### `models.DocumentGetFieldMetaNumber` + +```python +value: models.DocumentGetFieldMetaNumber = /* values here */ +``` + +### `models.DocumentGetFieldMetaRadio` + +```python +value: models.DocumentGetFieldMetaRadio = /* values here */ +``` + +### `models.DocumentGetFieldMetaCheckbox` + +```python +value: models.DocumentGetFieldMetaCheckbox = /* values here */ +``` + +### `models.DocumentGetFieldMetaDropdown` + +```python +value: models.DocumentGetFieldMetaDropdown = /* values here */ +``` + diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldtype.md b/docs/models/documentgetfieldtype.md similarity index 92% rename from docs/models/documentgetdocumentwithdetailsbyidfieldtype.md rename to docs/models/documentgetfieldtype.md index c94c8db..63f631b 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldtype.md +++ b/docs/models/documentgetfieldtype.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFieldType +# DocumentGetFieldType ## Values diff --git a/docs/models/documentgetfolder.md b/docs/models/documentgetfolder.md new file mode 100644 index 0000000..63e0f39 --- /dev/null +++ b/docs/models/documentgetfolder.md @@ -0,0 +1,17 @@ +# DocumentGetFolder + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.DocumentGetFolderType](../models/documentgetfoldertype.md) | :heavy_check_mark: | N/A | +| `visibility` | [models.DocumentGetFolderVisibility](../models/documentgetfoldervisibility.md) | :heavy_check_mark: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `pinned` | *bool* | :heavy_check_mark: | N/A | +| `parent_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfoldertype.md b/docs/models/documentgetfoldertype.md similarity index 72% rename from docs/models/documentgetdocumentwithdetailsbyidfoldertype.md rename to docs/models/documentgetfoldertype.md index 9585048..92b171b 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfoldertype.md +++ b/docs/models/documentgetfoldertype.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFolderType +# DocumentGetFolderType ## Values diff --git a/docs/models/documentupdatedocumentvisibilityresponse.md b/docs/models/documentgetfoldervisibility.md similarity index 84% rename from docs/models/documentupdatedocumentvisibilityresponse.md rename to docs/models/documentgetfoldervisibility.md index 91b8a65..1f8db4d 100644 --- a/docs/models/documentupdatedocumentvisibilityresponse.md +++ b/docs/models/documentgetfoldervisibility.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentVisibilityResponse +# DocumentGetFolderVisibility ## Values diff --git a/docs/models/documentupdatedocumentformvalues.md b/docs/models/documentgetformvalues.md similarity index 85% rename from docs/models/documentupdatedocumentformvalues.md rename to docs/models/documentgetformvalues.md index 032d30c..d62993f 100644 --- a/docs/models/documentupdatedocumentformvalues.md +++ b/docs/models/documentgetformvalues.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentFormValues +# DocumentGetFormValues ## Supported Types diff --git a/docs/models/documentgetglobalaccessauth.md b/docs/models/documentgetglobalaccessauth.md new file mode 100644 index 0000000..bcdc4cf --- /dev/null +++ b/docs/models/documentgetglobalaccessauth.md @@ -0,0 +1,11 @@ +# DocumentGetGlobalAccessAuth + +The type of authentication required for the recipient to access the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentglobalactionauthrequest.md b/docs/models/documentgetglobalactionauth.md similarity index 89% rename from docs/models/documentupdatedocumentglobalactionauthrequest.md rename to docs/models/documentgetglobalactionauth.md index 3d25c65..1d3d924 100644 --- a/docs/models/documentupdatedocumentglobalactionauthrequest.md +++ b/docs/models/documentgetglobalactionauth.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentGlobalActionAuthRequest +# DocumentGetGlobalActionAuth The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. diff --git a/docs/models/documentgetinternalservererror.md b/docs/models/documentgetinternalservererror.md new file mode 100644 index 0000000..ef30c73 --- /dev/null +++ b/docs/models/documentgetinternalservererror.md @@ -0,0 +1,12 @@ +# DocumentGetInternalServerError + +Internal server error + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentGetInternalServerErrorIssue](../models/documentgetinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetinternalservererrorissue.md b/docs/models/documentgetinternalservererrorissue.md new file mode 100644 index 0000000..6fc22c3 --- /dev/null +++ b/docs/models/documentgetinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentGetInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetnotfounderror.md b/docs/models/documentgetnotfounderror.md new file mode 100644 index 0000000..3333c19 --- /dev/null +++ b/docs/models/documentgetnotfounderror.md @@ -0,0 +1,12 @@ +# DocumentGetNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentGetNotFoundIssue](../models/documentgetnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetnotfoundissue.md b/docs/models/documentgetnotfoundissue.md new file mode 100644 index 0000000..62225a4 --- /dev/null +++ b/docs/models/documentgetnotfoundissue.md @@ -0,0 +1,8 @@ +# DocumentGetNotFoundIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidreadstatus.md b/docs/models/documentgetreadstatus.md similarity index 74% rename from docs/models/documentgetdocumentwithdetailsbyidreadstatus.md rename to docs/models/documentgetreadstatus.md index 6c72f43..0bc58cf 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidreadstatus.md +++ b/docs/models/documentgetreadstatus.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDReadStatus +# DocumentGetReadStatus ## Values diff --git a/docs/models/documentgetrecipient.md b/docs/models/documentgetrecipient.md new file mode 100644 index 0000000..d1de2ab --- /dev/null +++ b/docs/models/documentgetrecipient.md @@ -0,0 +1,24 @@ +# DocumentGetRecipient + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `role` | [models.DocumentGetRole](../models/documentgetrole.md) | :heavy_check_mark: | N/A | +| `read_status` | [models.DocumentGetReadStatus](../models/documentgetreadstatus.md) | :heavy_check_mark: | N/A | +| `signing_status` | [models.DocumentGetSigningStatus](../models/documentgetsigningstatus.md) | :heavy_check_mark: | N/A | +| `send_status` | [models.DocumentGetSendStatus](../models/documentgetsendstatus.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `email` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | +| `document_deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `auth_options` | [Nullable[models.DocumentGetRecipientAuthOptions]](../models/documentgetrecipientauthoptions.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetrecipientauthoptions.md b/docs/models/documentgetrecipientauthoptions.md new file mode 100644 index 0000000..6007d4b --- /dev/null +++ b/docs/models/documentgetrecipientauthoptions.md @@ -0,0 +1,9 @@ +# DocumentGetRecipientAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `access_auth` | List[[models.DocumentGetAccessAuth](../models/documentgetaccessauth.md)] | :heavy_check_mark: | N/A | +| `action_auth` | List[[models.DocumentGetActionAuth](../models/documentgetactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicatedocumentresponse.md b/docs/models/documentgetrequest.md similarity index 82% rename from docs/models/documentduplicatedocumentresponse.md rename to docs/models/documentgetrequest.md index 468c3e1..f6959d8 100644 --- a/docs/models/documentduplicatedocumentresponse.md +++ b/docs/models/documentgetrequest.md @@ -1,6 +1,4 @@ -# DocumentDuplicateDocumentResponse - -Successful response +# DocumentGetRequest ## Fields diff --git a/docs/models/documentgetresponse.md b/docs/models/documentgetresponse.md new file mode 100644 index 0000000..9dd1071 --- /dev/null +++ b/docs/models/documentgetresponse.md @@ -0,0 +1,32 @@ +# DocumentGetResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `visibility` | [models.DocumentGetVisibility](../models/documentgetvisibility.md) | :heavy_check_mark: | N/A | +| `status` | [models.DocumentGetStatus](../models/documentgetstatus.md) | :heavy_check_mark: | N/A | +| `source` | [models.DocumentGetSource](../models/documentgetsource.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `external_id` | *Nullable[str]* | :heavy_check_mark: | A custom external ID you can use to identify the document. | +| `user_id` | *float* | :heavy_check_mark: | The ID of the user that created this document. | +| `auth_options` | [Nullable[models.DocumentGetAuthOptions]](../models/documentgetauthoptions.md) | :heavy_check_mark: | N/A | +| `form_values` | Dict[str, [models.DocumentGetFormValues](../models/documentgetformvalues.md)] | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | +| `document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `document_data` | [models.DocumentGetDocumentData](../models/documentgetdocumentdata.md) | :heavy_check_mark: | N/A | +| `document_meta` | [models.DocumentGetDocumentMeta](../models/documentgetdocumentmeta.md) | :heavy_check_mark: | N/A | +| `folder` | [Nullable[models.DocumentGetFolder]](../models/documentgetfolder.md) | :heavy_check_mark: | N/A | +| `recipients` | List[[models.DocumentGetRecipient](../models/documentgetrecipient.md)] | :heavy_check_mark: | N/A | +| `fields` | List[[models.DocumentGetField](../models/documentgetfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidrole.md b/docs/models/documentgetrole.md similarity index 84% rename from docs/models/documentgetdocumentwithdetailsbyidrole.md rename to docs/models/documentgetrole.md index e2a2a18..ad9427f 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidrole.md +++ b/docs/models/documentgetrole.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDRole +# DocumentGetRole ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidsendstatus.md b/docs/models/documentgetsendstatus.md similarity index 72% rename from docs/models/documentgetdocumentwithdetailsbyidsendstatus.md rename to docs/models/documentgetsendstatus.md index 00985bc..608912c 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidsendstatus.md +++ b/docs/models/documentgetsendstatus.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDSendStatus +# DocumentGetSendStatus ## Values diff --git a/docs/models/documentupdatedocumentsigningorder.md b/docs/models/documentgetsigningorder.md similarity index 79% rename from docs/models/documentupdatedocumentsigningorder.md rename to docs/models/documentgetsigningorder.md index e511d91..10f543e 100644 --- a/docs/models/documentupdatedocumentsigningorder.md +++ b/docs/models/documentgetsigningorder.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentSigningOrder +# DocumentGetSigningOrder ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidsigningstatus.md b/docs/models/documentgetsigningstatus.md similarity index 77% rename from docs/models/documentgetdocumentwithdetailsbyidsigningstatus.md rename to docs/models/documentgetsigningstatus.md index f23c961..406a994 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidsigningstatus.md +++ b/docs/models/documentgetsigningstatus.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDSigningStatus +# DocumentGetSigningStatus ## Values diff --git a/docs/models/documentupdatedocumentsource.md b/docs/models/documentgetsource.md similarity index 89% rename from docs/models/documentupdatedocumentsource.md rename to docs/models/documentgetsource.md index 3f24f53..808896a 100644 --- a/docs/models/documentupdatedocumentsource.md +++ b/docs/models/documentgetsource.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentSource +# DocumentGetSource ## Values diff --git a/docs/models/documentupdatedocumentstatus.md b/docs/models/documentgetstatus.md similarity index 86% rename from docs/models/documentupdatedocumentstatus.md rename to docs/models/documentgetstatus.md index 54096c1..176fc3b 100644 --- a/docs/models/documentupdatedocumentstatus.md +++ b/docs/models/documentgetstatus.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentStatus +# DocumentGetStatus ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtextalign1.md b/docs/models/documentgettextalign1.md similarity index 73% rename from docs/models/documentgetdocumentwithdetailsbyidtextalign1.md rename to docs/models/documentgettextalign1.md index 24f132a..4ec28b0 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtextalign1.md +++ b/docs/models/documentgettextalign1.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTextAlign1 +# DocumentGetTextAlign1 ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtextalign4.md b/docs/models/documentgettextalign2.md similarity index 73% rename from docs/models/documentgetdocumentwithdetailsbyidtextalign4.md rename to docs/models/documentgettextalign2.md index d240edb..58feabc 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtextalign4.md +++ b/docs/models/documentgettextalign2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTextAlign4 +# DocumentGetTextAlign2 ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtextalign3.md b/docs/models/documentgettextalign3.md similarity index 73% rename from docs/models/documentgetdocumentwithdetailsbyidtextalign3.md rename to docs/models/documentgettextalign3.md index 3e16a6c..f276fdc 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtextalign3.md +++ b/docs/models/documentgettextalign3.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTextAlign3 +# DocumentGetTextAlign3 ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtextalign2.md b/docs/models/documentgettextalign4.md similarity index 73% rename from docs/models/documentgetdocumentwithdetailsbyidtextalign2.md rename to docs/models/documentgettextalign4.md index 2bf9687..7199904 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtextalign2.md +++ b/docs/models/documentgettextalign4.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTextAlign2 +# DocumentGetTextAlign4 ## Values diff --git a/docs/models/documentgettextalign5.md b/docs/models/documentgettextalign5.md new file mode 100644 index 0000000..aebbafd --- /dev/null +++ b/docs/models/documentgettextalign5.md @@ -0,0 +1,10 @@ +# DocumentGetTextAlign5 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/documentgettextalign6.md b/docs/models/documentgettextalign6.md new file mode 100644 index 0000000..779e798 --- /dev/null +++ b/docs/models/documentgettextalign6.md @@ -0,0 +1,10 @@ +# DocumentGetTextAlign6 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypecheckbox.md b/docs/models/documentgettypecheckbox.md similarity index 66% rename from docs/models/documentgetdocumentwithdetailsbyidtypecheckbox.md rename to docs/models/documentgettypecheckbox.md index 0b6ffdb..1d98f1c 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypecheckbox.md +++ b/docs/models/documentgettypecheckbox.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeCheckbox +# DocumentGetTypeCheckbox ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypedate.md b/docs/models/documentgettypedate.md similarity index 61% rename from docs/models/documentgetdocumentwithdetailsbyidtypedate.md rename to docs/models/documentgettypedate.md index da257a8..e3d1806 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypedate.md +++ b/docs/models/documentgettypedate.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeDate +# DocumentGetTypeDate ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypedropdown.md b/docs/models/documentgettypedropdown.md similarity index 66% rename from docs/models/documentgetdocumentwithdetailsbyidtypedropdown.md rename to docs/models/documentgettypedropdown.md index e5f4fcc..1e413db 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypedropdown.md +++ b/docs/models/documentgettypedropdown.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeDropdown +# DocumentGetTypeDropdown ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypeemail.md b/docs/models/documentgettypeemail.md similarity index 62% rename from docs/models/documentgetdocumentwithdetailsbyidtypeemail.md rename to docs/models/documentgettypeemail.md index b9ee442..d2605a4 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypeemail.md +++ b/docs/models/documentgettypeemail.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeEmail +# DocumentGetTypeEmail ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypeinitials.md b/docs/models/documentgettypeinitials.md similarity index 66% rename from docs/models/documentgetdocumentwithdetailsbyidtypeinitials.md rename to docs/models/documentgettypeinitials.md index 2f18bc6..b71e258 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypeinitials.md +++ b/docs/models/documentgettypeinitials.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeInitials +# DocumentGetTypeInitials ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypename.md b/docs/models/documentgettypename.md similarity index 61% rename from docs/models/documentgetdocumentwithdetailsbyidtypename.md rename to docs/models/documentgettypename.md index 89b3c20..f2141b0 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypename.md +++ b/docs/models/documentgettypename.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeName +# DocumentGetTypeName ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypenumber.md b/docs/models/documentgettypenumber.md similarity index 64% rename from docs/models/documentgetdocumentwithdetailsbyidtypenumber.md rename to docs/models/documentgettypenumber.md index 1c3d574..e97e248 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypenumber.md +++ b/docs/models/documentgettypenumber.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeNumber +# DocumentGetTypeNumber ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtyperadio.md b/docs/models/documentgettyperadio.md similarity index 62% rename from docs/models/documentgetdocumentwithdetailsbyidtyperadio.md rename to docs/models/documentgettyperadio.md index c87bd57..c7719d0 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtyperadio.md +++ b/docs/models/documentgettyperadio.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeRadio +# DocumentGetTypeRadio ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypetext.md b/docs/models/documentgettypetext.md similarity index 61% rename from docs/models/documentgetdocumentwithdetailsbyidtypetext.md rename to docs/models/documentgettypetext.md index a14aa20..a9a1535 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypetext.md +++ b/docs/models/documentgettypetext.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeText +# DocumentGetTypeText ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidvalue1.md b/docs/models/documentgetvalue1.md similarity index 91% rename from docs/models/documentgetdocumentwithdetailsbyidvalue1.md rename to docs/models/documentgetvalue1.md index 721e323..6e46545 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidvalue1.md +++ b/docs/models/documentgetvalue1.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDValue1 +# DocumentGetValue1 ## Fields diff --git a/docs/models/documentgetdocumentwithdetailsbyidvalue2.md b/docs/models/documentgetvalue2.md similarity index 91% rename from docs/models/documentgetdocumentwithdetailsbyidvalue2.md rename to docs/models/documentgetvalue2.md index a207698..b670807 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidvalue2.md +++ b/docs/models/documentgetvalue2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDValue2 +# DocumentGetValue2 ## Fields diff --git a/docs/models/documentgetdocumentwithdetailsbyidvalue3.md b/docs/models/documentgetvalue3.md similarity index 86% rename from docs/models/documentgetdocumentwithdetailsbyidvalue3.md rename to docs/models/documentgetvalue3.md index 75a5ef7..ba0d0ce 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidvalue3.md +++ b/docs/models/documentgetvalue3.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDValue3 +# DocumentGetValue3 ## Fields diff --git a/docs/models/documentgetdocumentwithdetailsbyidvisibility.md b/docs/models/documentgetvisibility.md similarity index 83% rename from docs/models/documentgetdocumentwithdetailsbyidvisibility.md rename to docs/models/documentgetvisibility.md index 0c58c0a..4e16931 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidvisibility.md +++ b/docs/models/documentgetvisibility.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDVisibility +# DocumentGetVisibility ## Values diff --git a/docs/models/documentglobalaccessauth.md b/docs/models/documentglobalaccessauth.md index 6575b4d..8b26e90 100644 --- a/docs/models/documentglobalaccessauth.md +++ b/docs/models/documentglobalaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentrecipient.md b/docs/models/documentrecipient.md index 9d10fd6..5ddc17c 100644 --- a/docs/models/documentrecipient.md +++ b/docs/models/documentrecipient.md @@ -5,13 +5,12 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.DocumentRole](../models/documentrole.md) | :heavy_check_mark: | N/A | | `read_status` | [models.DocumentCreateDocumentTemporaryReadStatus](../models/documentcreatedocumenttemporaryreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.DocumentCreateDocumentTemporarySigningStatus](../models/documentcreatedocumenttemporarysigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.DocumentCreateDocumentTemporarySendStatus](../models/documentcreatedocumenttemporarysendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -20,4 +19,6 @@ | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.DocumentCreateDocumentTemporaryRecipientAuthOptions]](../models/documentcreatedocumenttemporaryrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentbadrequesterror.md b/docs/models/documentredistributebadrequesterror.md similarity index 92% rename from docs/models/documentsenddocumentbadrequesterror.md rename to docs/models/documentredistributebadrequesterror.md index e054b88..d78c4b0 100644 --- a/docs/models/documentsenddocumentbadrequesterror.md +++ b/docs/models/documentredistributebadrequesterror.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentBadRequestError +# DocumentRedistributeBadRequestError Invalid input data @@ -9,4 +9,4 @@ Invalid input data | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `message` | *str* | :heavy_check_mark: | N/A | | `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentSendDocumentBadRequestIssue](../models/documentsenddocumentbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.DocumentRedistributeBadRequestIssue](../models/documentredistributebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentredistributebadrequestissue.md b/docs/models/documentredistributebadrequestissue.md new file mode 100644 index 0000000..ea1314c --- /dev/null +++ b/docs/models/documentredistributebadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentRedistributeBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentinternalservererror.md b/docs/models/documentredistributeinternalservererror.md similarity index 93% rename from docs/models/documentsenddocumentinternalservererror.md rename to docs/models/documentredistributeinternalservererror.md index 6fb4300..9f7db1a 100644 --- a/docs/models/documentsenddocumentinternalservererror.md +++ b/docs/models/documentredistributeinternalservererror.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentInternalServerError +# DocumentRedistributeInternalServerError Internal server error @@ -9,4 +9,4 @@ Internal server error | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `message` | *str* | :heavy_check_mark: | N/A | | `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentSendDocumentInternalServerErrorIssue](../models/documentsenddocumentinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.DocumentRedistributeInternalServerErrorIssue](../models/documentredistributeinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentredistributeinternalservererrorissue.md b/docs/models/documentredistributeinternalservererrorissue.md new file mode 100644 index 0000000..8de3392 --- /dev/null +++ b/docs/models/documentredistributeinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentRedistributeInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentresenddocumentrequest.md b/docs/models/documentredistributerequest.md similarity index 96% rename from docs/models/documentresenddocumentrequest.md rename to docs/models/documentredistributerequest.md index bb2aadc..0b2e4d1 100644 --- a/docs/models/documentresenddocumentrequest.md +++ b/docs/models/documentredistributerequest.md @@ -1,4 +1,4 @@ -# DocumentResendDocumentRequest +# DocumentRedistributeRequest ## Fields diff --git a/docs/models/documentdeletedocumentresponse.md b/docs/models/documentredistributeresponse.md similarity index 89% rename from docs/models/documentdeletedocumentresponse.md rename to docs/models/documentredistributeresponse.md index f61a0d7..576294c 100644 --- a/docs/models/documentdeletedocumentresponse.md +++ b/docs/models/documentredistributeresponse.md @@ -1,4 +1,4 @@ -# DocumentDeleteDocumentResponse +# DocumentRedistributeResponse Successful response diff --git a/docs/models/documentresenddocumentbadrequesterror.md b/docs/models/documentresenddocumentbadrequesterror.md deleted file mode 100644 index b308703..0000000 --- a/docs/models/documentresenddocumentbadrequesterror.md +++ /dev/null @@ -1,12 +0,0 @@ -# DocumentResendDocumentBadRequestError - -Invalid input data - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentResendDocumentBadRequestIssue](../models/documentresenddocumentbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentresenddocumentinternalservererrorissue.md b/docs/models/documentresenddocumentinternalservererrorissue.md deleted file mode 100644 index 1b8d9eb..0000000 --- a/docs/models/documentresenddocumentinternalservererrorissue.md +++ /dev/null @@ -1,8 +0,0 @@ -# DocumentResendDocumentInternalServerErrorIssue - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentdateformat.md b/docs/models/documentsenddocumentdateformat.md deleted file mode 100644 index 4c735e1..0000000 --- a/docs/models/documentsenddocumentdateformat.md +++ /dev/null @@ -1,19 +0,0 @@ -# DocumentSendDocumentDateFormat - -The date format to use for date fields and signing the document. - - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `YYYY_MM_DD_HH_MM_A` | yyyy-MM-dd hh:mm a | -| `YYYY_MM_DD` | yyyy-MM-dd | -| `DD_MM_YYYY_HH_MM_A` | dd/MM/yyyy hh:mm a | -| `MM_DD_YYYY_HH_MM_A` | MM/dd/yyyy hh:mm a | -| `YYYY_MM_DD_HH_MM` | yyyy-MM-dd HH:mm | -| `YY_MM_DD_HH_MM_A` | yy-MM-dd hh:mm a | -| `YYYY_MM_DD_HH_MM_SS` | yyyy-MM-dd HH:mm:ss | -| `MMMM_DD_YYYY_HH_MM_A` | MMMM dd, yyyy hh:mm a | -| `EEEE_MMMM_DD_YYYY_HH_MM_A` | EEEE, MMMM dd, yyyy hh:mm a | -| `YYYY_MM_DD_T_HH_MM_SS_SSSXXX` | yyyy-MM-dd'T'HH:mm:ss.SSSXXX | \ No newline at end of file diff --git a/docs/models/documentsenddocumentglobalaccessauth.md b/docs/models/documentsenddocumentglobalaccessauth.md deleted file mode 100644 index d29e682..0000000 --- a/docs/models/documentsenddocumentglobalaccessauth.md +++ /dev/null @@ -1,10 +0,0 @@ -# DocumentSendDocumentGlobalAccessAuth - -The type of authentication required for the recipient to access the document. - - -## Values - -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file diff --git a/docs/models/documentsenddocumentinternalservererrorissue.md b/docs/models/documentsenddocumentinternalservererrorissue.md deleted file mode 100644 index 6704a92..0000000 --- a/docs/models/documentsenddocumentinternalservererrorissue.md +++ /dev/null @@ -1,8 +0,0 @@ -# DocumentSendDocumentInternalServerErrorIssue - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentmeta.md b/docs/models/documentsenddocumentmeta.md deleted file mode 100644 index 9273328..0000000 --- a/docs/models/documentsenddocumentmeta.md +++ /dev/null @@ -1,15 +0,0 @@ -# DocumentSendDocumentMeta - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `subject` | *Optional[str]* | :heavy_minus_sign: | The subject of the email that will be sent to the recipients. | -| `message` | *Optional[str]* | :heavy_minus_sign: | The message of the email that will be sent to the recipients. | -| `timezone` | *Optional[str]* | :heavy_minus_sign: | The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne | -| `date_format` | [Optional[models.DocumentSendDocumentDateFormat]](../models/documentsenddocumentdateformat.md) | :heavy_minus_sign: | The date format to use for date fields and signing the document. | -| `distribution_method` | [Optional[models.DocumentSendDocumentDistributionMethod]](../models/documentsenddocumentdistributionmethod.md) | :heavy_minus_sign: | The distribution method to use when sending the document to the recipients. | -| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | The URL to which the recipient should be redirected after signing the document. | -| `language` | [Optional[models.DocumentSendDocumentLanguage]](../models/documentsenddocumentlanguage.md) | :heavy_minus_sign: | The language to use for email communications with recipients. | -| `email_settings` | [Optional[models.DocumentSendDocumentEmailSettings]](../models/documentsenddocumentemailsettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentresponse.md b/docs/models/documentsenddocumentresponse.md deleted file mode 100644 index 2a209e1..0000000 --- a/docs/models/documentsenddocumentresponse.md +++ /dev/null @@ -1,27 +0,0 @@ -# DocumentSendDocumentResponse - -Successful response - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `visibility` | [models.DocumentSendDocumentVisibility](../models/documentsenddocumentvisibility.md) | :heavy_check_mark: | N/A | -| `status` | [models.DocumentSendDocumentStatus](../models/documentsenddocumentstatus.md) | :heavy_check_mark: | N/A | -| `source` | [models.DocumentSendDocumentSource](../models/documentsenddocumentsource.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | -| `external_id` | *Nullable[str]* | :heavy_check_mark: | A custom external ID you can use to identify the document. | -| `user_id` | *float* | :heavy_check_mark: | The ID of the user that created this document. | -| `auth_options` | [Nullable[models.DocumentSendDocumentAuthOptions]](../models/documentsenddocumentauthoptions.md) | :heavy_check_mark: | N/A | -| `form_values` | Dict[str, [models.DocumentSendDocumentFormValues](../models/documentsenddocumentformvalues.md)] | :heavy_check_mark: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `document_data_id` | *str* | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `updated_at` | *str* | :heavy_check_mark: | N/A | -| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `team_id` | *float* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdateauthoptions.md b/docs/models/documentupdateauthoptions.md new file mode 100644 index 0000000..7c23eb4 --- /dev/null +++ b/docs/models/documentupdateauthoptions.md @@ -0,0 +1,9 @@ +# DocumentUpdateAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `global_access_auth` | List[[models.DocumentUpdateGlobalAccessAuthResponse](../models/documentupdateglobalaccessauthresponse.md)] | :heavy_check_mark: | N/A | +| `global_action_auth` | List[[models.DocumentUpdateGlobalActionAuthResponse](../models/documentupdateglobalactionauthresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatebadrequesterror.md b/docs/models/documentupdatebadrequesterror.md new file mode 100644 index 0000000..faf19c7 --- /dev/null +++ b/docs/models/documentupdatebadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentUpdateBadRequestError + +Invalid input data + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentUpdateBadRequestIssue](../models/documentupdatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatebadrequestissue.md b/docs/models/documentupdatebadrequestissue.md new file mode 100644 index 0000000..51fb84b --- /dev/null +++ b/docs/models/documentupdatebadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentUpdateBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedata.md b/docs/models/documentupdatedata.md new file mode 100644 index 0000000..6dca818 --- /dev/null +++ b/docs/models/documentupdatedata.md @@ -0,0 +1,14 @@ +# DocumentUpdateData + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `title` | *Optional[str]* | :heavy_minus_sign: | The title of the document. | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The external ID of the document. | +| `visibility` | [Optional[models.DocumentUpdateVisibilityRequest]](../models/documentupdatevisibilityrequest.md) | :heavy_minus_sign: | The visibility of the document. | +| `global_access_auth` | List[[models.DocumentUpdateGlobalAccessAuthRequest](../models/documentupdateglobalaccessauthrequest.md)] | :heavy_minus_sign: | N/A | +| `global_action_auth` | List[[models.DocumentUpdateGlobalActionAuthRequest](../models/documentupdateglobalactionauthrequest.md)] | :heavy_minus_sign: | N/A | +| `use_legacy_field_insertion` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `folder_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedateformat.md b/docs/models/documentupdatedateformat.md new file mode 100644 index 0000000..d557d49 --- /dev/null +++ b/docs/models/documentupdatedateformat.md @@ -0,0 +1,31 @@ +# DocumentUpdateDateFormat + +The date format to use for date fields and signing the document. + + +## Values + +| Name | Value | +| --------------------------------- | --------------------------------- | +| `YYYY_M_MDD_HH_MM_A` | yyyy-MM-dd hh:mm a | +| `YYYY_M_MDD` | yyyy-MM-dd | +| `DD_MM_SLASH_YYYY` | dd/MM/yyyy | +| `MM_DD_SLASH_YYYY` | MM/dd/yyyy | +| `YY_M_MDD` | yy-MM-dd | +| `MMMM_DD_COMMA_YYYY` | MMMM dd, yyyy | +| `EEEE_MMMM_DD_COMMA_YYYY` | EEEE, MMMM dd, yyyy | +| `DD_MM_SLASH_YYYY_HH_MM_A` | dd/MM/yyyy hh:mm a | +| `DD_MM_SLASH_YYYY_H_HMM` | dd/MM/yyyy HH:mm | +| `MM_DD_SLASH_YYYY_HH_MM_A` | MM/dd/yyyy hh:mm a | +| `MM_DD_SLASH_YYYY_H_HMM` | MM/dd/yyyy HH:mm | +| `DD_DOT_MM_DOT_YYYY` | dd.MM.yyyy | +| `DD_DOT_MM_DOT_YYYY_H_HMM` | dd.MM.yyyy HH:mm | +| `YYYY_M_MDD_H_HMM` | yyyy-MM-dd HH:mm | +| `YY_M_MDD_HH_MM_A` | yy-MM-dd hh:mm a | +| `YY_M_MDD_H_HMM` | yy-MM-dd HH:mm | +| `YYYY_M_MDD_H_HMMSS` | yyyy-MM-dd HH:mm:ss | +| `MMMM_DD_COMMA_YYYY_HH_MM_A` | MMMM dd, yyyy hh:mm a | +| `MMMM_DD_COMMA_YYYY_H_HMM` | MMMM dd, yyyy HH:mm | +| `EEEE_MMMM_DD_COMMA_YYYY_HH_MM_A` | EEEE, MMMM dd, yyyy hh:mm a | +| `EEEE_MMMM_DD_COMMA_YYYY_H_HMM` | EEEE, MMMM dd, yyyy HH:mm | +| `ISO8601_FULL` | yyyy-MM-dd'T'HH:mm:ss.SSSXXX | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentdistributionmethod.md b/docs/models/documentupdatedistributionmethod.md similarity index 80% rename from docs/models/documentupdatedocumentdistributionmethod.md rename to docs/models/documentupdatedistributionmethod.md index 2c7158f..34e991f 100644 --- a/docs/models/documentupdatedocumentdistributionmethod.md +++ b/docs/models/documentupdatedistributionmethod.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentDistributionMethod +# DocumentUpdateDistributionMethod The distribution method to use when sending the document to the recipients. diff --git a/docs/models/documentupdatedocumentauthoptions.md b/docs/models/documentupdatedocumentauthoptions.md deleted file mode 100644 index c849633..0000000 --- a/docs/models/documentupdatedocumentauthoptions.md +++ /dev/null @@ -1,9 +0,0 @@ -# DocumentUpdateDocumentAuthOptions - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `global_access_auth` | List[[models.DocumentUpdateDocumentGlobalAccessAuthResponse](../models/documentupdatedocumentglobalaccessauthresponse.md)] | :heavy_check_mark: | N/A | -| `global_action_auth` | List[[models.DocumentUpdateDocumentGlobalActionAuthResponse](../models/documentupdatedocumentglobalactionauthresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentbadrequesterror.md b/docs/models/documentupdatedocumentbadrequesterror.md deleted file mode 100644 index 9a7dd10..0000000 --- a/docs/models/documentupdatedocumentbadrequesterror.md +++ /dev/null @@ -1,12 +0,0 @@ -# DocumentUpdateDocumentBadRequestError - -Invalid input data - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentUpdateDocumentBadRequestIssue](../models/documentupdatedocumentbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentbadrequestissue.md b/docs/models/documentupdatedocumentbadrequestissue.md deleted file mode 100644 index d2c1692..0000000 --- a/docs/models/documentupdatedocumentbadrequestissue.md +++ /dev/null @@ -1,8 +0,0 @@ -# DocumentUpdateDocumentBadRequestIssue - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentdata.md b/docs/models/documentupdatedocumentdata.md deleted file mode 100644 index 34331cd..0000000 --- a/docs/models/documentupdatedocumentdata.md +++ /dev/null @@ -1,13 +0,0 @@ -# DocumentUpdateDocumentData - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `title` | *Optional[str]* | :heavy_minus_sign: | The title of the document. | -| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The external ID of the document. | -| `visibility` | [Optional[models.DocumentUpdateDocumentVisibilityRequest]](../models/documentupdatedocumentvisibilityrequest.md) | :heavy_minus_sign: | The visibility of the document. | -| `global_access_auth` | List[[models.DocumentUpdateDocumentGlobalAccessAuthRequest](../models/documentupdatedocumentglobalaccessauthrequest.md)] | :heavy_minus_sign: | N/A | -| `global_action_auth` | List[[models.DocumentUpdateDocumentGlobalActionAuthRequest](../models/documentupdatedocumentglobalactionauthrequest.md)] | :heavy_minus_sign: | N/A | -| `use_legacy_field_insertion` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentdateformat.md b/docs/models/documentupdatedocumentdateformat.md deleted file mode 100644 index 46f9218..0000000 --- a/docs/models/documentupdatedocumentdateformat.md +++ /dev/null @@ -1,19 +0,0 @@ -# DocumentUpdateDocumentDateFormat - -The date format to use for date fields and signing the document. - - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `YYYY_MM_DD_HH_MM_A` | yyyy-MM-dd hh:mm a | -| `YYYY_MM_DD` | yyyy-MM-dd | -| `DD_MM_YYYY_HH_MM_A` | dd/MM/yyyy hh:mm a | -| `MM_DD_YYYY_HH_MM_A` | MM/dd/yyyy hh:mm a | -| `YYYY_MM_DD_HH_MM` | yyyy-MM-dd HH:mm | -| `YY_MM_DD_HH_MM_A` | yy-MM-dd hh:mm a | -| `YYYY_MM_DD_HH_MM_SS` | yyyy-MM-dd HH:mm:ss | -| `MMMM_DD_YYYY_HH_MM_A` | MMMM dd, yyyy hh:mm a | -| `EEEE_MMMM_DD_YYYY_HH_MM_A` | EEEE, MMMM dd, yyyy hh:mm a | -| `YYYY_MM_DD_T_HH_MM_SS_SSSXXX` | yyyy-MM-dd'T'HH:mm:ss.SSSXXX | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentglobalaccessauthrequest.md b/docs/models/documentupdatedocumentglobalaccessauthrequest.md deleted file mode 100644 index 2c3753c..0000000 --- a/docs/models/documentupdatedocumentglobalaccessauthrequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# DocumentUpdateDocumentGlobalAccessAuthRequest - -The type of authentication required for the recipient to access the document. - - -## Values - -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentglobalaccessauthresponse.md b/docs/models/documentupdatedocumentglobalaccessauthresponse.md deleted file mode 100644 index 69f3fdf..0000000 --- a/docs/models/documentupdatedocumentglobalaccessauthresponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# DocumentUpdateDocumentGlobalAccessAuthResponse - -The type of authentication required for the recipient to access the document. - - -## Values - -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentinternalservererror.md b/docs/models/documentupdatedocumentinternalservererror.md deleted file mode 100644 index cf88241..0000000 --- a/docs/models/documentupdatedocumentinternalservererror.md +++ /dev/null @@ -1,12 +0,0 @@ -# DocumentUpdateDocumentInternalServerError - -Internal server error - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentUpdateDocumentInternalServerErrorIssue](../models/documentupdatedocumentinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentinternalservererrorissue.md b/docs/models/documentupdatedocumentinternalservererrorissue.md deleted file mode 100644 index 75077b4..0000000 --- a/docs/models/documentupdatedocumentinternalservererrorissue.md +++ /dev/null @@ -1,8 +0,0 @@ -# DocumentUpdateDocumentInternalServerErrorIssue - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentmeta.md b/docs/models/documentupdatedocumentmeta.md deleted file mode 100644 index fe1c92a..0000000 --- a/docs/models/documentupdatedocumentmeta.md +++ /dev/null @@ -1,20 +0,0 @@ -# DocumentUpdateDocumentMeta - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `subject` | *Optional[str]* | :heavy_minus_sign: | The subject of the email that will be sent to the recipients. | -| `message` | *Optional[str]* | :heavy_minus_sign: | The message of the email that will be sent to the recipients. | -| `timezone` | *Optional[str]* | :heavy_minus_sign: | The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne | -| `date_format` | [Optional[models.DocumentUpdateDocumentDateFormat]](../models/documentupdatedocumentdateformat.md) | :heavy_minus_sign: | The date format to use for date fields and signing the document. | -| `distribution_method` | [Optional[models.DocumentUpdateDocumentDistributionMethod]](../models/documentupdatedocumentdistributionmethod.md) | :heavy_minus_sign: | The distribution method to use when sending the document to the recipients. | -| `signing_order` | [Optional[models.DocumentUpdateDocumentSigningOrder]](../models/documentupdatedocumentsigningorder.md) | :heavy_minus_sign: | N/A | -| `allow_dictate_next_signer` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | The URL to which the recipient should be redirected after signing the document. | -| `language` | [Optional[models.DocumentUpdateDocumentLanguage]](../models/documentupdatedocumentlanguage.md) | :heavy_minus_sign: | The language to use for email communications with recipients. | -| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using a typed signature. | -| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using an uploaded signature. | -| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using a draw signature. | -| `email_settings` | [Optional[models.DocumentUpdateDocumentEmailSettings]](../models/documentupdatedocumentemailsettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentresponse.md b/docs/models/documentupdatedocumentresponse.md deleted file mode 100644 index 88e3ef5..0000000 --- a/docs/models/documentupdatedocumentresponse.md +++ /dev/null @@ -1,27 +0,0 @@ -# DocumentUpdateDocumentResponse - -Successful response - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `visibility` | [models.DocumentUpdateDocumentVisibilityResponse](../models/documentupdatedocumentvisibilityresponse.md) | :heavy_check_mark: | N/A | -| `status` | [models.DocumentUpdateDocumentStatus](../models/documentupdatedocumentstatus.md) | :heavy_check_mark: | N/A | -| `source` | [models.DocumentUpdateDocumentSource](../models/documentupdatedocumentsource.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | -| `external_id` | *Nullable[str]* | :heavy_check_mark: | A custom external ID you can use to identify the document. | -| `user_id` | *float* | :heavy_check_mark: | The ID of the user that created this document. | -| `auth_options` | [Nullable[models.DocumentUpdateDocumentAuthOptions]](../models/documentupdatedocumentauthoptions.md) | :heavy_check_mark: | N/A | -| `form_values` | Dict[str, [models.DocumentUpdateDocumentFormValues](../models/documentupdatedocumentformvalues.md)] | :heavy_check_mark: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `document_data_id` | *str* | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `updated_at` | *str* | :heavy_check_mark: | N/A | -| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `team_id` | *float* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidemailsettings.md b/docs/models/documentupdateemailsettings.md similarity index 99% rename from docs/models/documentgetdocumentwithdetailsbyidemailsettings.md rename to docs/models/documentupdateemailsettings.md index deefd32..c0d1b0b 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidemailsettings.md +++ b/docs/models/documentupdateemailsettings.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDEmailSettings +# DocumentUpdateEmailSettings ## Fields diff --git a/docs/models/documentgetdocumentwithdetailsbyidformvalues.md b/docs/models/documentupdateformvalues.md similarity index 80% rename from docs/models/documentgetdocumentwithdetailsbyidformvalues.md rename to docs/models/documentupdateformvalues.md index 4252bea..4cf4117 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidformvalues.md +++ b/docs/models/documentupdateformvalues.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFormValues +# DocumentUpdateFormValues ## Supported Types diff --git a/docs/models/documentupdateglobalaccessauthrequest.md b/docs/models/documentupdateglobalaccessauthrequest.md new file mode 100644 index 0000000..1eae8da --- /dev/null +++ b/docs/models/documentupdateglobalaccessauthrequest.md @@ -0,0 +1,11 @@ +# DocumentUpdateGlobalAccessAuthRequest + +The type of authentication required for the recipient to access the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentupdateglobalaccessauthresponse.md b/docs/models/documentupdateglobalaccessauthresponse.md new file mode 100644 index 0000000..56a7806 --- /dev/null +++ b/docs/models/documentupdateglobalaccessauthresponse.md @@ -0,0 +1,11 @@ +# DocumentUpdateGlobalAccessAuthResponse + +The type of authentication required for the recipient to access the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentglobalactionauthresponse.md b/docs/models/documentupdateglobalactionauthrequest.md similarity index 89% rename from docs/models/documentupdatedocumentglobalactionauthresponse.md rename to docs/models/documentupdateglobalactionauthrequest.md index 52b8794..b42c67c 100644 --- a/docs/models/documentupdatedocumentglobalactionauthresponse.md +++ b/docs/models/documentupdateglobalactionauthrequest.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentGlobalActionAuthResponse +# DocumentUpdateGlobalActionAuthRequest The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. diff --git a/docs/models/documentupdateglobalactionauthresponse.md b/docs/models/documentupdateglobalactionauthresponse.md new file mode 100644 index 0000000..e516706 --- /dev/null +++ b/docs/models/documentupdateglobalactionauthresponse.md @@ -0,0 +1,13 @@ +# DocumentUpdateGlobalActionAuthResponse + +The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `PASSKEY` | PASSKEY | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | +| `PASSWORD` | PASSWORD | \ No newline at end of file diff --git a/docs/models/documentupdateinternalservererror.md b/docs/models/documentupdateinternalservererror.md new file mode 100644 index 0000000..9f670f7 --- /dev/null +++ b/docs/models/documentupdateinternalservererror.md @@ -0,0 +1,12 @@ +# DocumentUpdateInternalServerError + +Internal server error + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentUpdateInternalServerErrorIssue](../models/documentupdateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdateinternalservererrorissue.md b/docs/models/documentupdateinternalservererrorissue.md new file mode 100644 index 0000000..ade19df --- /dev/null +++ b/docs/models/documentupdateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentUpdateInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentlanguage.md b/docs/models/documentupdatelanguage.md similarity index 86% rename from docs/models/documentupdatedocumentlanguage.md rename to docs/models/documentupdatelanguage.md index 41ddc89..54dc348 100644 --- a/docs/models/documentupdatedocumentlanguage.md +++ b/docs/models/documentupdatelanguage.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentLanguage +# DocumentUpdateLanguage The language to use for email communications with recipients. diff --git a/docs/models/documentupdatemeta.md b/docs/models/documentupdatemeta.md new file mode 100644 index 0000000..ac3934e --- /dev/null +++ b/docs/models/documentupdatemeta.md @@ -0,0 +1,22 @@ +# DocumentUpdateMeta + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | The subject of the email that will be sent to the recipients. | +| `message` | *Optional[str]* | :heavy_minus_sign: | The message of the email that will be sent to the recipients. | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne | +| `date_format` | [Optional[models.DocumentUpdateDateFormat]](../models/documentupdatedateformat.md) | :heavy_minus_sign: | The date format to use for date fields and signing the document. | +| `distribution_method` | [Optional[models.DocumentUpdateDistributionMethod]](../models/documentupdatedistributionmethod.md) | :heavy_minus_sign: | The distribution method to use when sending the document to the recipients. | +| `signing_order` | [Optional[models.DocumentUpdateSigningOrder]](../models/documentupdatesigningorder.md) | :heavy_minus_sign: | N/A | +| `allow_dictate_next_signer` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | The URL to which the recipient should be redirected after signing the document. | +| `language` | [Optional[models.DocumentUpdateLanguage]](../models/documentupdatelanguage.md) | :heavy_minus_sign: | The language to use for email communications with recipients. | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using a typed signature. | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using an uploaded signature. | +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using a draw signature. | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [OptionalNullable[models.DocumentUpdateEmailSettings]](../models/documentupdateemailsettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdaterequest.md b/docs/models/documentupdaterequest.md new file mode 100644 index 0000000..d2b7858 --- /dev/null +++ b/docs/models/documentupdaterequest.md @@ -0,0 +1,10 @@ +# DocumentUpdateRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | N/A | +| `data` | [Optional[models.DocumentUpdateData]](../models/documentupdatedata.md) | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.DocumentUpdateMeta]](../models/documentupdatemeta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdateresponse.md b/docs/models/documentupdateresponse.md new file mode 100644 index 0000000..b199edb --- /dev/null +++ b/docs/models/documentupdateresponse.md @@ -0,0 +1,28 @@ +# DocumentUpdateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `visibility` | [models.DocumentUpdateVisibilityResponse](../models/documentupdatevisibilityresponse.md) | :heavy_check_mark: | N/A | +| `status` | [models.DocumentUpdateStatus](../models/documentupdatestatus.md) | :heavy_check_mark: | N/A | +| `source` | [models.DocumentUpdateSource](../models/documentupdatesource.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `external_id` | *Nullable[str]* | :heavy_check_mark: | A custom external ID you can use to identify the document. | +| `user_id` | *float* | :heavy_check_mark: | The ID of the user that created this document. | +| `auth_options` | [Nullable[models.DocumentUpdateAuthOptions]](../models/documentupdateauthoptions.md) | :heavy_check_mark: | N/A | +| `form_values` | Dict[str, [models.DocumentUpdateFormValues](../models/documentupdateformvalues.md)] | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidsigningorder.md b/docs/models/documentupdatesigningorder.md similarity index 74% rename from docs/models/documentgetdocumentwithdetailsbyidsigningorder.md rename to docs/models/documentupdatesigningorder.md index 98dd22d..7c2d794 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidsigningorder.md +++ b/docs/models/documentupdatesigningorder.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDSigningOrder +# DocumentUpdateSigningOrder ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidsource.md b/docs/models/documentupdatesource.md similarity index 86% rename from docs/models/documentgetdocumentwithdetailsbyidsource.md rename to docs/models/documentupdatesource.md index f0af6a0..5223902 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidsource.md +++ b/docs/models/documentupdatesource.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDSource +# DocumentUpdateSource ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidstatus.md b/docs/models/documentupdatestatus.md similarity index 81% rename from docs/models/documentgetdocumentwithdetailsbyidstatus.md rename to docs/models/documentupdatestatus.md index 70f44d2..fc36eeb 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidstatus.md +++ b/docs/models/documentupdatestatus.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDStatus +# DocumentUpdateStatus ## Values diff --git a/docs/models/documentupdatedocumentvisibilityrequest.md b/docs/models/documentupdatevisibilityrequest.md similarity index 86% rename from docs/models/documentupdatedocumentvisibilityrequest.md rename to docs/models/documentupdatevisibilityrequest.md index 7b31c26..352f08c 100644 --- a/docs/models/documentupdatedocumentvisibilityrequest.md +++ b/docs/models/documentupdatevisibilityrequest.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentVisibilityRequest +# DocumentUpdateVisibilityRequest The visibility of the document. diff --git a/docs/models/documentupdatevisibilityresponse.md b/docs/models/documentupdatevisibilityresponse.md new file mode 100644 index 0000000..f936c6d --- /dev/null +++ b/docs/models/documentupdatevisibilityresponse.md @@ -0,0 +1,10 @@ +# DocumentUpdateVisibilityResponse + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfielddirectionrequest.md b/docs/models/fieldcreatedocumentfielddirectionrequest.md new file mode 100644 index 0000000..55e1b27 --- /dev/null +++ b/docs/models/fieldcreatedocumentfielddirectionrequest.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldDirectionRequest + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfielddirectionresponse.md b/docs/models/fieldcreatedocumentfielddirectionresponse.md new file mode 100644 index 0000000..8624c6b --- /dev/null +++ b/docs/models/fieldcreatedocumentfielddirectionresponse.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldDirectionResponse + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetacheckboxrequest.md b/docs/models/fieldcreatedocumentfieldfieldmetacheckboxrequest.md index cf32579..e71173a 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetacheckboxrequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetacheckboxrequest.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldCreateDocumentFieldTypeCheckboxRequest2](../models/fieldcreatedocumentfieldtypecheckboxrequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateDocumentFieldValueCheckbox](../models/fieldcreatedocumentfieldvaluecheckbox.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldTypeCheckboxRequest2](../models/fieldcreatedocumentfieldtypecheckboxrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateDocumentFieldValueCheckbox](../models/fieldcreatedocumentfieldvaluecheckbox.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateDocumentFieldDirectionRequest]](../models/fieldcreatedocumentfielddirectionrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetacheckboxresponse.md b/docs/models/fieldcreatedocumentfieldfieldmetacheckboxresponse.md index 1fc8a1a..a81e0ca 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetacheckboxresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetacheckboxresponse.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldCreateDocumentFieldFieldMetaTypeCheckbox](../models/fieldcreatedocumentfieldfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateDocumentFieldValueResponse2](../models/fieldcreatedocumentfieldvalueresponse2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldFieldMetaTypeCheckbox](../models/fieldcreatedocumentfieldfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateDocumentFieldValueResponse2](../models/fieldcreatedocumentfieldvalueresponse2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateDocumentFieldDirectionResponse]](../models/fieldcreatedocumentfielddirectionresponse.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetanumberrequest.md b/docs/models/fieldcreatedocumentfieldfieldmetanumberrequest.md index 60a5dfb..a52a82b 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetanumberrequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetanumberrequest.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateDocumentFieldTypeNumberRequest2](../models/fieldcreatedocumentfieldtypenumberrequest2.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignNumber]](../models/fieldcreatedocumentfieldtextalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetanumberresponse.md b/docs/models/fieldcreatedocumentfieldfieldmetanumberresponse.md index 9e277cf..08130c3 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetanumberresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetanumberresponse.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateDocumentFieldFieldMetaTypeNumber](../models/fieldcreatedocumentfieldfieldmetatypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignResponse6]](../models/fieldcreatedocumentfieldtextalignresponse6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldresponse.md b/docs/models/fieldcreatedocumentfieldresponse.md index 04eeec3..065dbd8 100644 --- a/docs/models/fieldcreatedocumentfieldresponse.md +++ b/docs/models/fieldcreatedocumentfieldresponse.md @@ -7,11 +7,11 @@ Successful response | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.FieldCreateDocumentFieldTypeResponse](../models/fieldcreatedocumentfieldtyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -20,4 +20,6 @@ Successful response | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.FieldCreateDocumentFieldFieldMetaUnion]](../models/fieldcreatedocumentfieldfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.FieldCreateDocumentFieldFieldMetaUnion]](../models/fieldcreatedocumentfieldfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsdirectionrequest.md b/docs/models/fieldcreatedocumentfieldsdirectionrequest.md new file mode 100644 index 0000000..52966bc --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsdirectionrequest.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldsDirectionRequest + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsdirectionresponse.md b/docs/models/fieldcreatedocumentfieldsdirectionresponse.md new file mode 100644 index 0000000..8717e31 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsdirectionresponse.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldsDirectionResponse + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxrequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxrequest.md index cc3ed43..e7f5836 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxrequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxrequest.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldCreateDocumentFieldsTypeCheckboxRequest2](../models/fieldcreatedocumentfieldstypecheckboxrequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateDocumentFieldsValueCheckbox](../models/fieldcreatedocumentfieldsvaluecheckbox.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsTypeCheckboxRequest2](../models/fieldcreatedocumentfieldstypecheckboxrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateDocumentFieldsValueCheckbox](../models/fieldcreatedocumentfieldsvaluecheckbox.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateDocumentFieldsDirectionRequest]](../models/fieldcreatedocumentfieldsdirectionrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxresponse.md b/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxresponse.md index b1ab185..b16a6e1 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxresponse.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeCheckbox](../models/fieldcreatedocumentfieldsfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateDocumentFieldsValueResponse2](../models/fieldcreatedocumentfieldsvalueresponse2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeCheckbox](../models/fieldcreatedocumentfieldsfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateDocumentFieldsValueResponse2](../models/fieldcreatedocumentfieldsvalueresponse2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateDocumentFieldsDirectionResponse]](../models/fieldcreatedocumentfieldsdirectionresponse.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetanumberrequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetanumberrequest.md index d7c8aea..2201541 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetanumberrequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetanumberrequest.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateDocumentFieldsTypeNumberRequest2](../models/fieldcreatedocumentfieldstypenumberrequest2.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignNumber]](../models/fieldcreatedocumentfieldstextalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetanumberresponse.md b/docs/models/fieldcreatedocumentfieldsfieldmetanumberresponse.md index 41d92cc..587fda1 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetanumberresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetanumberresponse.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeNumber](../models/fieldcreatedocumentfieldsfieldmetatypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignResponse6]](../models/fieldcreatedocumentfieldstextalignresponse6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldresponse.md b/docs/models/fieldcreatedocumentfieldsfieldresponse.md index d44fb2e..16275b2 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldresponse.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.FieldCreateDocumentFieldsTypeResponse](../models/fieldcreatedocumentfieldstyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.FieldCreateDocumentFieldsFieldMetaUnion]](../models/fieldcreatedocumentfieldsfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.FieldCreateDocumentFieldsFieldMetaUnion]](../models/fieldcreatedocumentfieldsfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefielddirectionrequest.md b/docs/models/fieldcreatetemplatefielddirectionrequest.md new file mode 100644 index 0000000..f1d8c16 --- /dev/null +++ b/docs/models/fieldcreatetemplatefielddirectionrequest.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldDirectionRequest + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefielddirectionresponse.md b/docs/models/fieldcreatetemplatefielddirectionresponse.md new file mode 100644 index 0000000..1973ca5 --- /dev/null +++ b/docs/models/fieldcreatetemplatefielddirectionresponse.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldDirectionResponse + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetacheckboxrequest.md b/docs/models/fieldcreatetemplatefieldfieldmetacheckboxrequest.md index a255ab9..ba8b30e 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetacheckboxrequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetacheckboxrequest.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldCreateTemplateFieldTypeCheckboxRequest2](../models/fieldcreatetemplatefieldtypecheckboxrequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateTemplateFieldValueCheckbox](../models/fieldcreatetemplatefieldvaluecheckbox.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldTypeCheckboxRequest2](../models/fieldcreatetemplatefieldtypecheckboxrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateTemplateFieldValueCheckbox](../models/fieldcreatetemplatefieldvaluecheckbox.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateTemplateFieldDirectionRequest]](../models/fieldcreatetemplatefielddirectionrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetacheckboxresponse.md b/docs/models/fieldcreatetemplatefieldfieldmetacheckboxresponse.md index 1696320..11475f0 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetacheckboxresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetacheckboxresponse.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldCreateTemplateFieldFieldMetaTypeCheckbox](../models/fieldcreatetemplatefieldfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateTemplateFieldValueResponse2](../models/fieldcreatetemplatefieldvalueresponse2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldFieldMetaTypeCheckbox](../models/fieldcreatetemplatefieldfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateTemplateFieldValueResponse2](../models/fieldcreatetemplatefieldvalueresponse2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateTemplateFieldDirectionResponse]](../models/fieldcreatetemplatefielddirectionresponse.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetanumberrequest.md b/docs/models/fieldcreatetemplatefieldfieldmetanumberrequest.md index 66b73a5..762da7c 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetanumberrequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetanumberrequest.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateTemplateFieldTypeNumberRequest2](../models/fieldcreatetemplatefieldtypenumberrequest2.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignNumber]](../models/fieldcreatetemplatefieldtextalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetanumberresponse.md b/docs/models/fieldcreatetemplatefieldfieldmetanumberresponse.md index d25ef37..da81c27 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetanumberresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetanumberresponse.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateTemplateFieldFieldMetaTypeNumber](../models/fieldcreatetemplatefieldfieldmetatypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignResponse6]](../models/fieldcreatetemplatefieldtextalignresponse6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldresponse.md b/docs/models/fieldcreatetemplatefieldresponse.md index 7aa96f7..81de51e 100644 --- a/docs/models/fieldcreatetemplatefieldresponse.md +++ b/docs/models/fieldcreatetemplatefieldresponse.md @@ -7,11 +7,11 @@ Successful response | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.FieldCreateTemplateFieldTypeResponse](../models/fieldcreatetemplatefieldtyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -20,4 +20,6 @@ Successful response | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.FieldCreateTemplateFieldFieldMetaUnion]](../models/fieldcreatetemplatefieldfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.FieldCreateTemplateFieldFieldMetaUnion]](../models/fieldcreatetemplatefieldfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsdirectionrequest.md b/docs/models/fieldcreatetemplatefieldsdirectionrequest.md new file mode 100644 index 0000000..ab1c864 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsdirectionrequest.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldsDirectionRequest + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsdirectionresponse.md b/docs/models/fieldcreatetemplatefieldsdirectionresponse.md new file mode 100644 index 0000000..8154c1f --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsdirectionresponse.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldsDirectionResponse + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxrequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxrequest.md index 8e4daa2..c3ead16 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxrequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxrequest.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldCreateTemplateFieldsTypeCheckboxRequest2](../models/fieldcreatetemplatefieldstypecheckboxrequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateTemplateFieldsValueCheckbox](../models/fieldcreatetemplatefieldsvaluecheckbox.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsTypeCheckboxRequest2](../models/fieldcreatetemplatefieldstypecheckboxrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateTemplateFieldsValueCheckbox](../models/fieldcreatetemplatefieldsvaluecheckbox.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateTemplateFieldsDirectionRequest]](../models/fieldcreatetemplatefieldsdirectionrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxresponse.md b/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxresponse.md index 9603ff2..d050470 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxresponse.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeCheckbox](../models/fieldcreatetemplatefieldsfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateTemplateFieldsValueResponse2](../models/fieldcreatetemplatefieldsvalueresponse2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeCheckbox](../models/fieldcreatetemplatefieldsfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateTemplateFieldsValueResponse2](../models/fieldcreatetemplatefieldsvalueresponse2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateTemplateFieldsDirectionResponse]](../models/fieldcreatetemplatefieldsdirectionresponse.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetanumberrequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetanumberrequest.md index 4fafe76..7a1e91c 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetanumberrequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetanumberrequest.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateTemplateFieldsTypeNumberRequest2](../models/fieldcreatetemplatefieldstypenumberrequest2.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignNumber]](../models/fieldcreatetemplatefieldstextalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetanumberresponse.md b/docs/models/fieldcreatetemplatefieldsfieldmetanumberresponse.md index bef2e82..a02b50c 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetanumberresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetanumberresponse.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeNumber](../models/fieldcreatetemplatefieldsfieldmetatypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignResponse6]](../models/fieldcreatetemplatefieldstextalignresponse6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldresponse.md b/docs/models/fieldcreatetemplatefieldsfieldresponse.md index b03cfc9..3571d2d 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldresponse.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.FieldCreateTemplateFieldsTypeResponse](../models/fieldcreatetemplatefieldstyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.FieldCreateTemplateFieldsFieldMetaUnion]](../models/fieldcreatetemplatefieldsfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.FieldCreateTemplateFieldsFieldMetaUnion]](../models/fieldcreatetemplatefieldsfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfielddirection.md b/docs/models/fieldgetdocumentfielddirection.md new file mode 100644 index 0000000..394e6a6 --- /dev/null +++ b/docs/models/fieldgetdocumentfielddirection.md @@ -0,0 +1,9 @@ +# FieldGetDocumentFieldDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldfieldmetacheckbox.md b/docs/models/fieldgetdocumentfieldfieldmetacheckbox.md index bed9e5d..631c087 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetacheckbox.md +++ b/docs/models/fieldgetdocumentfieldfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldGetDocumentFieldTypeCheckbox](../models/fieldgetdocumentfieldtypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldGetDocumentFieldValue2](../models/fieldgetdocumentfieldvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetDocumentFieldTypeCheckbox](../models/fieldgetdocumentfieldtypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldGetDocumentFieldValue2](../models/fieldgetdocumentfieldvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldGetDocumentFieldDirection]](../models/fieldgetdocumentfielddirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldfieldmetanumber.md b/docs/models/fieldgetdocumentfieldfieldmetanumber.md index f82a358..8e60d37 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetanumber.md +++ b/docs/models/fieldgetdocumentfieldfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldGetDocumentFieldTypeNumber](../models/fieldgetdocumentfieldtypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldGetDocumentFieldTextAlign6]](../models/fieldgetdocumentfieldtextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldresponse.md b/docs/models/fieldgetdocumentfieldresponse.md index 4c592a7..90b9412 100644 --- a/docs/models/fieldgetdocumentfieldresponse.md +++ b/docs/models/fieldgetdocumentfieldresponse.md @@ -7,11 +7,11 @@ Successful response | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.FieldGetDocumentFieldType](../models/fieldgetdocumentfieldtype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -20,4 +20,6 @@ Successful response | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.FieldGetDocumentFieldFieldMetaUnion]](../models/fieldgetdocumentfieldfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.FieldGetDocumentFieldFieldMetaUnion]](../models/fieldgetdocumentfieldfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefielddirection.md b/docs/models/fieldgettemplatefielddirection.md new file mode 100644 index 0000000..a0e72d1 --- /dev/null +++ b/docs/models/fieldgettemplatefielddirection.md @@ -0,0 +1,9 @@ +# FieldGetTemplateFieldDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldfieldmetacheckbox.md b/docs/models/fieldgettemplatefieldfieldmetacheckbox.md index c451b23..726c625 100644 --- a/docs/models/fieldgettemplatefieldfieldmetacheckbox.md +++ b/docs/models/fieldgettemplatefieldfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldGetTemplateFieldTypeCheckbox](../models/fieldgettemplatefieldtypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldGetTemplateFieldValue2](../models/fieldgettemplatefieldvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetTemplateFieldTypeCheckbox](../models/fieldgettemplatefieldtypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldGetTemplateFieldValue2](../models/fieldgettemplatefieldvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldGetTemplateFieldDirection]](../models/fieldgettemplatefielddirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldfieldmetanumber.md b/docs/models/fieldgettemplatefieldfieldmetanumber.md index 583b6a0..c969688 100644 --- a/docs/models/fieldgettemplatefieldfieldmetanumber.md +++ b/docs/models/fieldgettemplatefieldfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldGetTemplateFieldTypeNumber](../models/fieldgettemplatefieldtypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldGetTemplateFieldTextAlign6]](../models/fieldgettemplatefieldtextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldresponse.md b/docs/models/fieldgettemplatefieldresponse.md index 567fc7f..06c6aa5 100644 --- a/docs/models/fieldgettemplatefieldresponse.md +++ b/docs/models/fieldgettemplatefieldresponse.md @@ -7,11 +7,11 @@ Successful response | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.FieldGetTemplateFieldType](../models/fieldgettemplatefieldtype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -20,4 +20,6 @@ Successful response | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.FieldGetTemplateFieldFieldMetaUnion]](../models/fieldgettemplatefieldfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.FieldGetTemplateFieldFieldMetaUnion]](../models/fieldgettemplatefieldfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldmetadocumentcheckbox.md b/docs/models/fieldmetadocumentcheckbox.md index ec72577..d4e1951 100644 --- a/docs/models/fieldmetadocumentcheckbox.md +++ b/docs/models/fieldmetadocumentcheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentTypeCheckbox](../models/documenttypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.DocumentValue2](../models/documentvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentTypeCheckbox](../models/documenttypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.DocumentValue2](../models/documentvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.DocumentDirection]](../models/documentdirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldmetadocumentnumber.md b/docs/models/fieldmetadocumentnumber.md index 4e0ffd6..64cba22 100644 --- a/docs/models/fieldmetadocumentnumber.md +++ b/docs/models/fieldmetadocumentnumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.DocumentTypeNumber](../models/documenttypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.DocumentTextAlign6]](../models/documenttextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfielddirectionrequest.md b/docs/models/fieldupdatedocumentfielddirectionrequest.md new file mode 100644 index 0000000..4ae83e7 --- /dev/null +++ b/docs/models/fieldupdatedocumentfielddirectionrequest.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldDirectionRequest + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfielddirectionresponse.md b/docs/models/fieldupdatedocumentfielddirectionresponse.md new file mode 100644 index 0000000..24e7edb --- /dev/null +++ b/docs/models/fieldupdatedocumentfielddirectionresponse.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldDirectionResponse + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetacheckboxrequest.md b/docs/models/fieldupdatedocumentfieldfieldmetacheckboxrequest.md index 56c2b7c..3474c5a 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetacheckboxrequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetacheckboxrequest.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldUpdateDocumentFieldTypeCheckboxRequest2](../models/fieldupdatedocumentfieldtypecheckboxrequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateDocumentFieldValueCheckbox](../models/fieldupdatedocumentfieldvaluecheckbox.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldTypeCheckboxRequest2](../models/fieldupdatedocumentfieldtypecheckboxrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateDocumentFieldValueCheckbox](../models/fieldupdatedocumentfieldvaluecheckbox.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateDocumentFieldDirectionRequest]](../models/fieldupdatedocumentfielddirectionrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetacheckboxresponse.md b/docs/models/fieldupdatedocumentfieldfieldmetacheckboxresponse.md index ebb00dc..4835a6b 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetacheckboxresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetacheckboxresponse.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeCheckbox](../models/fieldupdatedocumentfieldfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateDocumentFieldValueResponse2](../models/fieldupdatedocumentfieldvalueresponse2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeCheckbox](../models/fieldupdatedocumentfieldfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateDocumentFieldValueResponse2](../models/fieldupdatedocumentfieldvalueresponse2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateDocumentFieldDirectionResponse]](../models/fieldupdatedocumentfielddirectionresponse.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetanumberrequest.md b/docs/models/fieldupdatedocumentfieldfieldmetanumberrequest.md index 9778062..802b678 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetanumberrequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetanumberrequest.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateDocumentFieldTypeNumberRequest2](../models/fieldupdatedocumentfieldtypenumberrequest2.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignNumber]](../models/fieldupdatedocumentfieldtextalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetanumberresponse.md b/docs/models/fieldupdatedocumentfieldfieldmetanumberresponse.md index e497b9c..eb9c1ca 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetanumberresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetanumberresponse.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeNumber](../models/fieldupdatedocumentfieldfieldmetatypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignResponse6]](../models/fieldupdatedocumentfieldtextalignresponse6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldresponse.md b/docs/models/fieldupdatedocumentfieldresponse.md index a866bdf..2bd13a5 100644 --- a/docs/models/fieldupdatedocumentfieldresponse.md +++ b/docs/models/fieldupdatedocumentfieldresponse.md @@ -7,11 +7,11 @@ Successful response | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.FieldUpdateDocumentFieldTypeResponse](../models/fieldupdatedocumentfieldtyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -20,4 +20,6 @@ Successful response | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.FieldUpdateDocumentFieldFieldMetaUnion]](../models/fieldupdatedocumentfieldfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.FieldUpdateDocumentFieldFieldMetaUnion]](../models/fieldupdatedocumentfieldfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsdirectionrequest.md b/docs/models/fieldupdatedocumentfieldsdirectionrequest.md new file mode 100644 index 0000000..60202a4 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsdirectionrequest.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldsDirectionRequest + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsdirectionresponse.md b/docs/models/fieldupdatedocumentfieldsdirectionresponse.md new file mode 100644 index 0000000..c88bbb4 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsdirectionresponse.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldsDirectionResponse + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxrequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxrequest.md index 20da435..c1b4f3c 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxrequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxrequest.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldUpdateDocumentFieldsTypeCheckboxRequest2](../models/fieldupdatedocumentfieldstypecheckboxrequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateDocumentFieldsValueCheckbox](../models/fieldupdatedocumentfieldsvaluecheckbox.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsTypeCheckboxRequest2](../models/fieldupdatedocumentfieldstypecheckboxrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateDocumentFieldsValueCheckbox](../models/fieldupdatedocumentfieldsvaluecheckbox.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateDocumentFieldsDirectionRequest]](../models/fieldupdatedocumentfieldsdirectionrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxresponse.md b/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxresponse.md index aebb4c1..2a927b4 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxresponse.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeCheckbox](../models/fieldupdatedocumentfieldsfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateDocumentFieldsValueResponse2](../models/fieldupdatedocumentfieldsvalueresponse2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeCheckbox](../models/fieldupdatedocumentfieldsfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateDocumentFieldsValueResponse2](../models/fieldupdatedocumentfieldsvalueresponse2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateDocumentFieldsDirectionResponse]](../models/fieldupdatedocumentfieldsdirectionresponse.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetanumberrequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetanumberrequest.md index c763bed..53080bf 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetanumberrequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetanumberrequest.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateDocumentFieldsTypeNumberRequest2](../models/fieldupdatedocumentfieldstypenumberrequest2.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignNumber]](../models/fieldupdatedocumentfieldstextalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetanumberresponse.md b/docs/models/fieldupdatedocumentfieldsfieldmetanumberresponse.md index 33ad2e5..8b9c2dd 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetanumberresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetanumberresponse.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeNumber](../models/fieldupdatedocumentfieldsfieldmetatypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignResponse6]](../models/fieldupdatedocumentfieldstextalignresponse6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldresponse.md b/docs/models/fieldupdatedocumentfieldsfieldresponse.md index ffad43b..e62e3b1 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldresponse.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.FieldUpdateDocumentFieldsTypeResponse](../models/fieldupdatedocumentfieldstyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.FieldUpdateDocumentFieldsFieldMetaUnion]](../models/fieldupdatedocumentfieldsfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.FieldUpdateDocumentFieldsFieldMetaUnion]](../models/fieldupdatedocumentfieldsfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefielddirectionrequest.md b/docs/models/fieldupdatetemplatefielddirectionrequest.md new file mode 100644 index 0000000..bce6b84 --- /dev/null +++ b/docs/models/fieldupdatetemplatefielddirectionrequest.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldDirectionRequest + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefielddirectionresponse.md b/docs/models/fieldupdatetemplatefielddirectionresponse.md new file mode 100644 index 0000000..c536e0e --- /dev/null +++ b/docs/models/fieldupdatetemplatefielddirectionresponse.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldDirectionResponse + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetacheckboxrequest.md b/docs/models/fieldupdatetemplatefieldfieldmetacheckboxrequest.md index 9e9a4bd..ba95f84 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetacheckboxrequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetacheckboxrequest.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldUpdateTemplateFieldTypeCheckboxRequest2](../models/fieldupdatetemplatefieldtypecheckboxrequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateTemplateFieldValueCheckbox](../models/fieldupdatetemplatefieldvaluecheckbox.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldTypeCheckboxRequest2](../models/fieldupdatetemplatefieldtypecheckboxrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateTemplateFieldValueCheckbox](../models/fieldupdatetemplatefieldvaluecheckbox.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateTemplateFieldDirectionRequest]](../models/fieldupdatetemplatefielddirectionrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetacheckboxresponse.md b/docs/models/fieldupdatetemplatefieldfieldmetacheckboxresponse.md index 0d9cd22..3473bb4 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetacheckboxresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetacheckboxresponse.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeCheckbox](../models/fieldupdatetemplatefieldfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateTemplateFieldValueResponse2](../models/fieldupdatetemplatefieldvalueresponse2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeCheckbox](../models/fieldupdatetemplatefieldfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateTemplateFieldValueResponse2](../models/fieldupdatetemplatefieldvalueresponse2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateTemplateFieldDirectionResponse]](../models/fieldupdatetemplatefielddirectionresponse.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetanumberrequest.md b/docs/models/fieldupdatetemplatefieldfieldmetanumberrequest.md index b8b92fb..06bcd3a 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetanumberrequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetanumberrequest.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateTemplateFieldTypeNumberRequest2](../models/fieldupdatetemplatefieldtypenumberrequest2.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignNumber]](../models/fieldupdatetemplatefieldtextalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetanumberresponse.md b/docs/models/fieldupdatetemplatefieldfieldmetanumberresponse.md index 796d5c2..e3356ac 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetanumberresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetanumberresponse.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeNumber](../models/fieldupdatetemplatefieldfieldmetatypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignResponse6]](../models/fieldupdatetemplatefieldtextalignresponse6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldresponse.md b/docs/models/fieldupdatetemplatefieldresponse.md index 43e81a7..5bedf85 100644 --- a/docs/models/fieldupdatetemplatefieldresponse.md +++ b/docs/models/fieldupdatetemplatefieldresponse.md @@ -7,11 +7,11 @@ Successful response | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.FieldUpdateTemplateFieldTypeResponse](../models/fieldupdatetemplatefieldtyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -20,4 +20,6 @@ Successful response | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.FieldUpdateTemplateFieldFieldMetaUnion]](../models/fieldupdatetemplatefieldfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.FieldUpdateTemplateFieldFieldMetaUnion]](../models/fieldupdatetemplatefieldfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsdirectionrequest.md b/docs/models/fieldupdatetemplatefieldsdirectionrequest.md new file mode 100644 index 0000000..4f7e909 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsdirectionrequest.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldsDirectionRequest + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsdirectionresponse.md b/docs/models/fieldupdatetemplatefieldsdirectionresponse.md new file mode 100644 index 0000000..ea7998c --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsdirectionresponse.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldsDirectionResponse + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxrequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxrequest.md index d7e9686..e78de29 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxrequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxrequest.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldUpdateTemplateFieldsTypeCheckboxRequest2](../models/fieldupdatetemplatefieldstypecheckboxrequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateTemplateFieldsValueCheckbox](../models/fieldupdatetemplatefieldsvaluecheckbox.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsTypeCheckboxRequest2](../models/fieldupdatetemplatefieldstypecheckboxrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateTemplateFieldsValueCheckbox](../models/fieldupdatetemplatefieldsvaluecheckbox.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateTemplateFieldsDirectionRequest]](../models/fieldupdatetemplatefieldsdirectionrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxresponse.md b/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxresponse.md index d74c343..e68b92c 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxresponse.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeCheckbox](../models/fieldupdatetemplatefieldsfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateTemplateFieldsValueResponse2](../models/fieldupdatetemplatefieldsvalueresponse2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeCheckbox](../models/fieldupdatetemplatefieldsfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateTemplateFieldsValueResponse2](../models/fieldupdatetemplatefieldsvalueresponse2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateTemplateFieldsDirectionResponse]](../models/fieldupdatetemplatefieldsdirectionresponse.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetanumberrequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetanumberrequest.md index 3114b5f..ceb8c93 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetanumberrequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetanumberrequest.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateTemplateFieldsTypeNumberRequest2](../models/fieldupdatetemplatefieldstypenumberrequest2.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignNumber]](../models/fieldupdatetemplatefieldstextalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetanumberresponse.md b/docs/models/fieldupdatetemplatefieldsfieldmetanumberresponse.md index 349c9db..201a1b5 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetanumberresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetanumberresponse.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeNumber](../models/fieldupdatetemplatefieldsfieldmetatypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignResponse6]](../models/fieldupdatetemplatefieldstextalignresponse6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldresponse.md b/docs/models/fieldupdatetemplatefieldsfieldresponse.md index 106e288..d947080 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldresponse.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.FieldUpdateTemplateFieldsTypeResponse](../models/fieldupdatetemplatefieldstyperesponse.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.FieldUpdateTemplateFieldsFieldMetaUnion]](../models/fieldupdatetemplatefieldsfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.FieldUpdateTemplateFieldsFieldMetaUnion]](../models/fieldupdatetemplatefieldsfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientaccessauthrequest.md b/docs/models/recipientcreatedocumentrecipientaccessauthrequest.md index f238fed..2e3e498 100644 --- a/docs/models/recipientcreatedocumentrecipientaccessauthrequest.md +++ b/docs/models/recipientcreatedocumentrecipientaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientaccessauthresponse.md b/docs/models/recipientcreatedocumentrecipientaccessauthresponse.md index eba6d3e..6e03c17 100644 --- a/docs/models/recipientcreatedocumentrecipientaccessauthresponse.md +++ b/docs/models/recipientcreatedocumentrecipientaccessauthresponse.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientresponse.md b/docs/models/recipientcreatedocumentrecipientresponse.md index 76753f6..942a6a0 100644 --- a/docs/models/recipientcreatedocumentrecipientresponse.md +++ b/docs/models/recipientcreatedocumentrecipientresponse.md @@ -7,13 +7,12 @@ Successful response | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.RecipientCreateDocumentRecipientRoleResponse](../models/recipientcreatedocumentrecipientroleresponse.md) | :heavy_check_mark: | N/A | | `read_status` | [models.RecipientCreateDocumentRecipientReadStatus](../models/recipientcreatedocumentrecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.RecipientCreateDocumentRecipientSigningStatus](../models/recipientcreatedocumentrecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.RecipientCreateDocumentRecipientSendStatus](../models/recipientcreatedocumentrecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -22,4 +21,6 @@ Successful response | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.RecipientCreateDocumentRecipientAuthOptions]](../models/recipientcreatedocumentrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientsaccessauthrequest.md b/docs/models/recipientcreatedocumentrecipientsaccessauthrequest.md index 41bae82..71b7731 100644 --- a/docs/models/recipientcreatedocumentrecipientsaccessauthrequest.md +++ b/docs/models/recipientcreatedocumentrecipientsaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientsaccessauthresponse.md b/docs/models/recipientcreatedocumentrecipientsaccessauthresponse.md index 5ab5652..e1e5b33 100644 --- a/docs/models/recipientcreatedocumentrecipientsaccessauthresponse.md +++ b/docs/models/recipientcreatedocumentrecipientsaccessauthresponse.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientsrecipientresponse.md b/docs/models/recipientcreatedocumentrecipientsrecipientresponse.md index 4613443..e283a70 100644 --- a/docs/models/recipientcreatedocumentrecipientsrecipientresponse.md +++ b/docs/models/recipientcreatedocumentrecipientsrecipientresponse.md @@ -5,13 +5,12 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.RecipientCreateDocumentRecipientsRoleResponse](../models/recipientcreatedocumentrecipientsroleresponse.md) | :heavy_check_mark: | N/A | | `read_status` | [models.RecipientCreateDocumentRecipientsReadStatus](../models/recipientcreatedocumentrecipientsreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.RecipientCreateDocumentRecipientsSigningStatus](../models/recipientcreatedocumentrecipientssigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.RecipientCreateDocumentRecipientsSendStatus](../models/recipientcreatedocumentrecipientssendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -20,4 +19,6 @@ | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.RecipientCreateDocumentRecipientsAuthOptions]](../models/recipientcreatedocumentrecipientsauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientaccessauthrequest.md b/docs/models/recipientcreatetemplaterecipientaccessauthrequest.md index 75e315d..86db3b0 100644 --- a/docs/models/recipientcreatetemplaterecipientaccessauthrequest.md +++ b/docs/models/recipientcreatetemplaterecipientaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientaccessauthresponse.md b/docs/models/recipientcreatetemplaterecipientaccessauthresponse.md index 67d139c..5c283da 100644 --- a/docs/models/recipientcreatetemplaterecipientaccessauthresponse.md +++ b/docs/models/recipientcreatetemplaterecipientaccessauthresponse.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientresponse.md b/docs/models/recipientcreatetemplaterecipientresponse.md index 32ae203..1513b68 100644 --- a/docs/models/recipientcreatetemplaterecipientresponse.md +++ b/docs/models/recipientcreatetemplaterecipientresponse.md @@ -7,13 +7,12 @@ Successful response | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.RecipientCreateTemplateRecipientRoleResponse](../models/recipientcreatetemplaterecipientroleresponse.md) | :heavy_check_mark: | N/A | | `read_status` | [models.RecipientCreateTemplateRecipientReadStatus](../models/recipientcreatetemplaterecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.RecipientCreateTemplateRecipientSigningStatus](../models/recipientcreatetemplaterecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.RecipientCreateTemplateRecipientSendStatus](../models/recipientcreatetemplaterecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -22,4 +21,6 @@ Successful response | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.RecipientCreateTemplateRecipientAuthOptions]](../models/recipientcreatetemplaterecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientsaccessauthrequest.md b/docs/models/recipientcreatetemplaterecipientsaccessauthrequest.md index 176b1c6..5359109 100644 --- a/docs/models/recipientcreatetemplaterecipientsaccessauthrequest.md +++ b/docs/models/recipientcreatetemplaterecipientsaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientsaccessauthresponse.md b/docs/models/recipientcreatetemplaterecipientsaccessauthresponse.md index dd1dbd5..e82ad34 100644 --- a/docs/models/recipientcreatetemplaterecipientsaccessauthresponse.md +++ b/docs/models/recipientcreatetemplaterecipientsaccessauthresponse.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientsrecipientresponse.md b/docs/models/recipientcreatetemplaterecipientsrecipientresponse.md index 3eb8df2..8c544c3 100644 --- a/docs/models/recipientcreatetemplaterecipientsrecipientresponse.md +++ b/docs/models/recipientcreatetemplaterecipientsrecipientresponse.md @@ -5,13 +5,12 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.RecipientCreateTemplateRecipientsRoleResponse](../models/recipientcreatetemplaterecipientsroleresponse.md) | :heavy_check_mark: | N/A | | `read_status` | [models.RecipientCreateTemplateRecipientsReadStatus](../models/recipientcreatetemplaterecipientsreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.RecipientCreateTemplateRecipientsSigningStatus](../models/recipientcreatetemplaterecipientssigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.RecipientCreateTemplateRecipientsSendStatus](../models/recipientcreatetemplaterecipientssendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -20,4 +19,6 @@ | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.RecipientCreateTemplateRecipientsAuthOptions]](../models/recipientcreatetemplaterecipientsauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientaccessauth.md b/docs/models/recipientgetdocumentrecipientaccessauth.md index 18c72b2..20a40a4 100644 --- a/docs/models/recipientgetdocumentrecipientaccessauth.md +++ b/docs/models/recipientgetdocumentrecipientaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientdirection.md b/docs/models/recipientgetdocumentrecipientdirection.md new file mode 100644 index 0000000..f758a6f --- /dev/null +++ b/docs/models/recipientgetdocumentrecipientdirection.md @@ -0,0 +1,9 @@ +# RecipientGetDocumentRecipientDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfield.md b/docs/models/recipientgetdocumentrecipientfield.md index 1d5128f..c8b009f 100644 --- a/docs/models/recipientgetdocumentrecipientfield.md +++ b/docs/models/recipientgetdocumentrecipientfield.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.RecipientGetDocumentRecipientType](../models/recipientgetdocumentrecipienttype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.RecipientGetDocumentRecipientFieldMetaUnion]](../models/recipientgetdocumentrecipientfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.RecipientGetDocumentRecipientFieldMetaUnion]](../models/recipientgetdocumentrecipientfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfieldmetacheckbox.md b/docs/models/recipientgetdocumentrecipientfieldmetacheckbox.md index 81abc5e..d538643 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetacheckbox.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.RecipientGetDocumentRecipientTypeCheckbox](../models/recipientgetdocumentrecipienttypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientGetDocumentRecipientValue2](../models/recipientgetdocumentrecipientvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetDocumentRecipientTypeCheckbox](../models/recipientgetdocumentrecipienttypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientGetDocumentRecipientValue2](../models/recipientgetdocumentrecipientvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientGetDocumentRecipientDirection]](../models/recipientgetdocumentrecipientdirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfieldmetanumber.md b/docs/models/recipientgetdocumentrecipientfieldmetanumber.md index 5c85670..b6e5d4a 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetanumber.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientGetDocumentRecipientTypeNumber](../models/recipientgetdocumentrecipienttypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.RecipientGetDocumentRecipientTextAlign6]](../models/recipientgetdocumentrecipienttextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientresponse.md b/docs/models/recipientgetdocumentrecipientresponse.md index 9c76081..187c64c 100644 --- a/docs/models/recipientgetdocumentrecipientresponse.md +++ b/docs/models/recipientgetdocumentrecipientresponse.md @@ -7,13 +7,12 @@ Successful response | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.RecipientGetDocumentRecipientRole](../models/recipientgetdocumentrecipientrole.md) | :heavy_check_mark: | N/A | | `read_status` | [models.RecipientGetDocumentRecipientReadStatus](../models/recipientgetdocumentrecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.RecipientGetDocumentRecipientSigningStatus](../models/recipientgetdocumentrecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.RecipientGetDocumentRecipientSendStatus](../models/recipientgetdocumentrecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -23,4 +22,6 @@ Successful response | `auth_options` | [Nullable[models.RecipientGetDocumentRecipientAuthOptions]](../models/recipientgetdocumentrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `fields` | List[[models.RecipientGetDocumentRecipientField](../models/recipientgetdocumentrecipientfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | List[[models.RecipientGetDocumentRecipientField](../models/recipientgetdocumentrecipientfield.md)] | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientaccessauth.md b/docs/models/recipientgettemplaterecipientaccessauth.md index d1ceb74..d03444b 100644 --- a/docs/models/recipientgettemplaterecipientaccessauth.md +++ b/docs/models/recipientgettemplaterecipientaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientdirection.md b/docs/models/recipientgettemplaterecipientdirection.md new file mode 100644 index 0000000..1aac6d9 --- /dev/null +++ b/docs/models/recipientgettemplaterecipientdirection.md @@ -0,0 +1,9 @@ +# RecipientGetTemplateRecipientDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfield.md b/docs/models/recipientgettemplaterecipientfield.md index 53bea9a..07796a3 100644 --- a/docs/models/recipientgettemplaterecipientfield.md +++ b/docs/models/recipientgettemplaterecipientfield.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.RecipientGetTemplateRecipientType](../models/recipientgettemplaterecipienttype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.RecipientGetTemplateRecipientFieldMetaUnion]](../models/recipientgettemplaterecipientfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.RecipientGetTemplateRecipientFieldMetaUnion]](../models/recipientgettemplaterecipientfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfieldmetacheckbox.md b/docs/models/recipientgettemplaterecipientfieldmetacheckbox.md index e5a6478..f8ad419 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetacheckbox.md +++ b/docs/models/recipientgettemplaterecipientfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.RecipientGetTemplateRecipientTypeCheckbox](../models/recipientgettemplaterecipienttypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientGetTemplateRecipientValue2](../models/recipientgettemplaterecipientvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetTemplateRecipientTypeCheckbox](../models/recipientgettemplaterecipienttypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientGetTemplateRecipientValue2](../models/recipientgettemplaterecipientvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientGetTemplateRecipientDirection]](../models/recipientgettemplaterecipientdirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfieldmetanumber.md b/docs/models/recipientgettemplaterecipientfieldmetanumber.md index ec47845..3b2c303 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetanumber.md +++ b/docs/models/recipientgettemplaterecipientfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientGetTemplateRecipientTypeNumber](../models/recipientgettemplaterecipienttypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.RecipientGetTemplateRecipientTextAlign6]](../models/recipientgettemplaterecipienttextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientresponse.md b/docs/models/recipientgettemplaterecipientresponse.md index d04e7c3..b656b47 100644 --- a/docs/models/recipientgettemplaterecipientresponse.md +++ b/docs/models/recipientgettemplaterecipientresponse.md @@ -7,13 +7,12 @@ Successful response | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.RecipientGetTemplateRecipientRole](../models/recipientgettemplaterecipientrole.md) | :heavy_check_mark: | N/A | | `read_status` | [models.RecipientGetTemplateRecipientReadStatus](../models/recipientgettemplaterecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.RecipientGetTemplateRecipientSigningStatus](../models/recipientgettemplaterecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.RecipientGetTemplateRecipientSendStatus](../models/recipientgettemplaterecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -23,4 +22,6 @@ Successful response | `auth_options` | [Nullable[models.RecipientGetTemplateRecipientAuthOptions]](../models/recipientgettemplaterecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `fields` | List[[models.RecipientGetTemplateRecipientField](../models/recipientgettemplaterecipientfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | List[[models.RecipientGetTemplateRecipientField](../models/recipientgettemplaterecipientfield.md)] | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientaccessauthrequest.md b/docs/models/recipientupdatedocumentrecipientaccessauthrequest.md index 0c48261..455eefc 100644 --- a/docs/models/recipientupdatedocumentrecipientaccessauthrequest.md +++ b/docs/models/recipientupdatedocumentrecipientaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientaccessauthresponse.md b/docs/models/recipientupdatedocumentrecipientaccessauthresponse.md index b4a143f..b3e7282 100644 --- a/docs/models/recipientupdatedocumentrecipientaccessauthresponse.md +++ b/docs/models/recipientupdatedocumentrecipientaccessauthresponse.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientdirection.md b/docs/models/recipientupdatedocumentrecipientdirection.md new file mode 100644 index 0000000..09e5809 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientdirection.md @@ -0,0 +1,9 @@ +# RecipientUpdateDocumentRecipientDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfield.md b/docs/models/recipientupdatedocumentrecipientfield.md index 20454d7..55bf764 100644 --- a/docs/models/recipientupdatedocumentrecipientfield.md +++ b/docs/models/recipientupdatedocumentrecipientfield.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.RecipientUpdateDocumentRecipientType](../models/recipientupdatedocumentrecipienttype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.RecipientUpdateDocumentRecipientFieldMetaUnion]](../models/recipientupdatedocumentrecipientfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.RecipientUpdateDocumentRecipientFieldMetaUnion]](../models/recipientupdatedocumentrecipientfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfieldmetacheckbox.md b/docs/models/recipientupdatedocumentrecipientfieldmetacheckbox.md index 5c2e689..525affb 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetacheckbox.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.RecipientUpdateDocumentRecipientTypeCheckbox](../models/recipientupdatedocumentrecipienttypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientUpdateDocumentRecipientValue2](../models/recipientupdatedocumentrecipientvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientTypeCheckbox](../models/recipientupdatedocumentrecipienttypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientUpdateDocumentRecipientValue2](../models/recipientupdatedocumentrecipientvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientUpdateDocumentRecipientDirection]](../models/recipientupdatedocumentrecipientdirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfieldmetanumber.md b/docs/models/recipientupdatedocumentrecipientfieldmetanumber.md index b5356f2..a0301ec 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetanumber.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientUpdateDocumentRecipientTypeNumber](../models/recipientupdatedocumentrecipienttypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.RecipientUpdateDocumentRecipientTextAlign6]](../models/recipientupdatedocumentrecipienttextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientresponse.md b/docs/models/recipientupdatedocumentrecipientresponse.md index 226bfa4..76eb18d 100644 --- a/docs/models/recipientupdatedocumentrecipientresponse.md +++ b/docs/models/recipientupdatedocumentrecipientresponse.md @@ -7,13 +7,12 @@ Successful response | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.RecipientUpdateDocumentRecipientRoleResponse](../models/recipientupdatedocumentrecipientroleresponse.md) | :heavy_check_mark: | N/A | | `read_status` | [models.RecipientUpdateDocumentRecipientReadStatus](../models/recipientupdatedocumentrecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.RecipientUpdateDocumentRecipientSigningStatus](../models/recipientupdatedocumentrecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.RecipientUpdateDocumentRecipientSendStatus](../models/recipientupdatedocumentrecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -23,4 +22,6 @@ Successful response | `auth_options` | [Nullable[models.RecipientUpdateDocumentRecipientAuthOptions]](../models/recipientupdatedocumentrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `fields` | List[[models.RecipientUpdateDocumentRecipientField](../models/recipientupdatedocumentrecipientfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | List[[models.RecipientUpdateDocumentRecipientField](../models/recipientupdatedocumentrecipientfield.md)] | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsaccessauthrequest.md b/docs/models/recipientupdatedocumentrecipientsaccessauthrequest.md index ee35ec4..8e8e612 100644 --- a/docs/models/recipientupdatedocumentrecipientsaccessauthrequest.md +++ b/docs/models/recipientupdatedocumentrecipientsaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsaccessauthresponse.md b/docs/models/recipientupdatedocumentrecipientsaccessauthresponse.md index e7ae86c..9964763 100644 --- a/docs/models/recipientupdatedocumentrecipientsaccessauthresponse.md +++ b/docs/models/recipientupdatedocumentrecipientsaccessauthresponse.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsdirection.md b/docs/models/recipientupdatedocumentrecipientsdirection.md new file mode 100644 index 0000000..9b7f380 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientsdirection.md @@ -0,0 +1,9 @@ +# RecipientUpdateDocumentRecipientsDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfield.md b/docs/models/recipientupdatedocumentrecipientsfield.md index 3c2ab12..8636399 100644 --- a/docs/models/recipientupdatedocumentrecipientsfield.md +++ b/docs/models/recipientupdatedocumentrecipientsfield.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.RecipientUpdateDocumentRecipientsType](../models/recipientupdatedocumentrecipientstype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.RecipientUpdateDocumentRecipientsFieldMetaUnion]](../models/recipientupdatedocumentrecipientsfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.RecipientUpdateDocumentRecipientsFieldMetaUnion]](../models/recipientupdatedocumentrecipientsfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfieldmetacheckbox.md b/docs/models/recipientupdatedocumentrecipientsfieldmetacheckbox.md index 3c7c626..d10995b 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetacheckbox.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.RecipientUpdateDocumentRecipientsTypeCheckbox](../models/recipientupdatedocumentrecipientstypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientUpdateDocumentRecipientsValue2](../models/recipientupdatedocumentrecipientsvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientsTypeCheckbox](../models/recipientupdatedocumentrecipientstypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientUpdateDocumentRecipientsValue2](../models/recipientupdatedocumentrecipientsvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientUpdateDocumentRecipientsDirection]](../models/recipientupdatedocumentrecipientsdirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfieldmetanumber.md b/docs/models/recipientupdatedocumentrecipientsfieldmetanumber.md index 7fc867f..cce49fd 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetanumber.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientUpdateDocumentRecipientsTypeNumber](../models/recipientupdatedocumentrecipientstypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.RecipientUpdateDocumentRecipientsTextAlign6]](../models/recipientupdatedocumentrecipientstextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsrecipientresponse.md b/docs/models/recipientupdatedocumentrecipientsrecipientresponse.md index 9b11321..9ee0b92 100644 --- a/docs/models/recipientupdatedocumentrecipientsrecipientresponse.md +++ b/docs/models/recipientupdatedocumentrecipientsrecipientresponse.md @@ -5,13 +5,12 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.RecipientUpdateDocumentRecipientsRoleResponse](../models/recipientupdatedocumentrecipientsroleresponse.md) | :heavy_check_mark: | N/A | | `read_status` | [models.RecipientUpdateDocumentRecipientsReadStatus](../models/recipientupdatedocumentrecipientsreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.RecipientUpdateDocumentRecipientsSigningStatus](../models/recipientupdatedocumentrecipientssigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.RecipientUpdateDocumentRecipientsSendStatus](../models/recipientupdatedocumentrecipientssendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -21,4 +20,6 @@ | `auth_options` | [Nullable[models.RecipientUpdateDocumentRecipientsAuthOptions]](../models/recipientupdatedocumentrecipientsauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `fields` | List[[models.RecipientUpdateDocumentRecipientsField](../models/recipientupdatedocumentrecipientsfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | List[[models.RecipientUpdateDocumentRecipientsField](../models/recipientupdatedocumentrecipientsfield.md)] | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientaccessauthrequest.md b/docs/models/recipientupdatetemplaterecipientaccessauthrequest.md index 3f14986..a700216 100644 --- a/docs/models/recipientupdatetemplaterecipientaccessauthrequest.md +++ b/docs/models/recipientupdatetemplaterecipientaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientaccessauthresponse.md b/docs/models/recipientupdatetemplaterecipientaccessauthresponse.md index 08069bf..308b278 100644 --- a/docs/models/recipientupdatetemplaterecipientaccessauthresponse.md +++ b/docs/models/recipientupdatetemplaterecipientaccessauthresponse.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientdirection.md b/docs/models/recipientupdatetemplaterecipientdirection.md new file mode 100644 index 0000000..fd65aa6 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientdirection.md @@ -0,0 +1,9 @@ +# RecipientUpdateTemplateRecipientDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfield.md b/docs/models/recipientupdatetemplaterecipientfield.md index 2f10f27..b96e3b8 100644 --- a/docs/models/recipientupdatetemplaterecipientfield.md +++ b/docs/models/recipientupdatetemplaterecipientfield.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.RecipientUpdateTemplateRecipientType](../models/recipientupdatetemplaterecipienttype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.RecipientUpdateTemplateRecipientFieldMetaUnion]](../models/recipientupdatetemplaterecipientfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.RecipientUpdateTemplateRecipientFieldMetaUnion]](../models/recipientupdatetemplaterecipientfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfieldmetacheckbox.md b/docs/models/recipientupdatetemplaterecipientfieldmetacheckbox.md index 540a78d..26cd4ce 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetacheckbox.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.RecipientUpdateTemplateRecipientTypeCheckbox](../models/recipientupdatetemplaterecipienttypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientUpdateTemplateRecipientValue2](../models/recipientupdatetemplaterecipientvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientTypeCheckbox](../models/recipientupdatetemplaterecipienttypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientUpdateTemplateRecipientValue2](../models/recipientupdatetemplaterecipientvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientUpdateTemplateRecipientDirection]](../models/recipientupdatetemplaterecipientdirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfieldmetanumber.md b/docs/models/recipientupdatetemplaterecipientfieldmetanumber.md index a2de85a..9ca70c3 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetanumber.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientUpdateTemplateRecipientTypeNumber](../models/recipientupdatetemplaterecipienttypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.RecipientUpdateTemplateRecipientTextAlign6]](../models/recipientupdatetemplaterecipienttextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientresponse.md b/docs/models/recipientupdatetemplaterecipientresponse.md index 8f94790..5d62ac2 100644 --- a/docs/models/recipientupdatetemplaterecipientresponse.md +++ b/docs/models/recipientupdatetemplaterecipientresponse.md @@ -7,13 +7,12 @@ Successful response | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.RecipientUpdateTemplateRecipientRoleResponse](../models/recipientupdatetemplaterecipientroleresponse.md) | :heavy_check_mark: | N/A | | `read_status` | [models.RecipientUpdateTemplateRecipientReadStatus](../models/recipientupdatetemplaterecipientreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.RecipientUpdateTemplateRecipientSigningStatus](../models/recipientupdatetemplaterecipientsigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.RecipientUpdateTemplateRecipientSendStatus](../models/recipientupdatetemplaterecipientsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -23,4 +22,6 @@ Successful response | `auth_options` | [Nullable[models.RecipientUpdateTemplateRecipientAuthOptions]](../models/recipientupdatetemplaterecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `fields` | List[[models.RecipientUpdateTemplateRecipientField](../models/recipientupdatetemplaterecipientfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | List[[models.RecipientUpdateTemplateRecipientField](../models/recipientupdatetemplaterecipientfield.md)] | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsaccessauthrequest.md b/docs/models/recipientupdatetemplaterecipientsaccessauthrequest.md index 3e694a6..10d2a22 100644 --- a/docs/models/recipientupdatetemplaterecipientsaccessauthrequest.md +++ b/docs/models/recipientupdatetemplaterecipientsaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsaccessauthresponse.md b/docs/models/recipientupdatetemplaterecipientsaccessauthresponse.md index 9e2bd2a..2d6ce7d 100644 --- a/docs/models/recipientupdatetemplaterecipientsaccessauthresponse.md +++ b/docs/models/recipientupdatetemplaterecipientsaccessauthresponse.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsdirection.md b/docs/models/recipientupdatetemplaterecipientsdirection.md new file mode 100644 index 0000000..6200c50 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientsdirection.md @@ -0,0 +1,9 @@ +# RecipientUpdateTemplateRecipientsDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfield.md b/docs/models/recipientupdatetemplaterecipientsfield.md index 8e5b041..8a1b4a2 100644 --- a/docs/models/recipientupdatetemplaterecipientsfield.md +++ b/docs/models/recipientupdatetemplaterecipientsfield.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.RecipientUpdateTemplateRecipientsType](../models/recipientupdatetemplaterecipientstype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.RecipientUpdateTemplateRecipientsFieldMetaUnion]](../models/recipientupdatetemplaterecipientsfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.RecipientUpdateTemplateRecipientsFieldMetaUnion]](../models/recipientupdatetemplaterecipientsfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfieldmetacheckbox.md b/docs/models/recipientupdatetemplaterecipientsfieldmetacheckbox.md index 88e862b..ce2fec0 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetacheckbox.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.RecipientUpdateTemplateRecipientsTypeCheckbox](../models/recipientupdatetemplaterecipientstypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientUpdateTemplateRecipientsValue2](../models/recipientupdatetemplaterecipientsvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientsTypeCheckbox](../models/recipientupdatetemplaterecipientstypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientUpdateTemplateRecipientsValue2](../models/recipientupdatetemplaterecipientsvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientUpdateTemplateRecipientsDirection]](../models/recipientupdatetemplaterecipientsdirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfieldmetanumber.md b/docs/models/recipientupdatetemplaterecipientsfieldmetanumber.md index 517eef3..276d7e9 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetanumber.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientUpdateTemplateRecipientsTypeNumber](../models/recipientupdatetemplaterecipientstypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.RecipientUpdateTemplateRecipientsTextAlign6]](../models/recipientupdatetemplaterecipientstextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsrecipientresponse.md b/docs/models/recipientupdatetemplaterecipientsrecipientresponse.md index b7561cb..7c3e9b3 100644 --- a/docs/models/recipientupdatetemplaterecipientsrecipientresponse.md +++ b/docs/models/recipientupdatetemplaterecipientsrecipientresponse.md @@ -5,13 +5,12 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.RecipientUpdateTemplateRecipientsRoleResponse](../models/recipientupdatetemplaterecipientsroleresponse.md) | :heavy_check_mark: | N/A | | `read_status` | [models.RecipientUpdateTemplateRecipientsReadStatus](../models/recipientupdatetemplaterecipientsreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.RecipientUpdateTemplateRecipientsSigningStatus](../models/recipientupdatetemplaterecipientssigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.RecipientUpdateTemplateRecipientsSendStatus](../models/recipientupdatetemplaterecipientssendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -21,4 +20,6 @@ | `auth_options` | [Nullable[models.RecipientUpdateTemplateRecipientsAuthOptions]](../models/recipientupdatetemplaterecipientsauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | | `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `fields` | List[[models.RecipientUpdateTemplateRecipientsField](../models/recipientupdatetemplaterecipientsfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `fields` | List[[models.RecipientUpdateTemplateRecipientsField](../models/recipientupdatetemplaterecipientsfield.md)] | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateaccessauth.md b/docs/models/templatecreatedocumentfromtemplateaccessauth.md index e8405e8..2033ac2 100644 --- a/docs/models/templatecreatedocumentfromtemplateaccessauth.md +++ b/docs/models/templatecreatedocumentfromtemplateaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatedirection.md b/docs/models/templatecreatedocumentfromtemplatedirection.md new file mode 100644 index 0000000..ac61684 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplatedirection.md @@ -0,0 +1,9 @@ +# TemplateCreateDocumentFromTemplateDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatedocumentdata.md b/docs/models/templatecreatedocumentfromtemplatedocumentdata.md index 0949500..dcf80ba 100644 --- a/docs/models/templatecreatedocumentfromtemplatedocumentdata.md +++ b/docs/models/templatecreatedocumentfromtemplatedocumentdata.md @@ -8,4 +8,5 @@ | `type` | [models.TemplateCreateDocumentFromTemplateDocumentDataType](../models/templatecreatedocumentfromtemplatedocumentdatatype.md) | :heavy_check_mark: | N/A | | `id` | *str* | :heavy_check_mark: | N/A | | `data` | *str* | :heavy_check_mark: | N/A | -| `initial_data` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `initial_data` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatedocumentmeta.md b/docs/models/templatecreatedocumentfromtemplatedocumentmeta.md index 1f16651..e52c168 100644 --- a/docs/models/templatecreatedocumentfromtemplatedocumentmeta.md +++ b/docs/models/templatecreatedocumentfromtemplatedocumentmeta.md @@ -11,13 +11,15 @@ | `subject` | *Nullable[str]* | :heavy_check_mark: | N/A | | `message` | *Nullable[str]* | :heavy_check_mark: | N/A | | `timezone` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `password` | *Nullable[str]* | :heavy_check_mark: | N/A | | `date_format` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `document_id` | *float* | :heavy_check_mark: | N/A | | `redirect_url` | *Nullable[str]* | :heavy_check_mark: | N/A | | `typed_signature_enabled` | *bool* | :heavy_check_mark: | N/A | | `upload_signature_enabled` | *bool* | :heavy_check_mark: | N/A | | `draw_signature_enabled` | *bool* | :heavy_check_mark: | N/A | | `allow_dictate_next_signer` | *bool* | :heavy_check_mark: | N/A | | `language` | *str* | :heavy_check_mark: | N/A | -| `email_settings` | [Nullable[models.TemplateCreateDocumentFromTemplateEmailSettings]](../models/templatecreatedocumentfromtemplateemailsettings.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `email_settings` | [Nullable[models.TemplateCreateDocumentFromTemplateEmailSettings]](../models/templatecreatedocumentfromtemplateemailsettings.md) | :heavy_check_mark: | N/A | +| `email_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `email_reply_to` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `password` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `document_id` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefield.md b/docs/models/templatecreatedocumentfromtemplatefield.md index 9864607..0ee20aa 100644 --- a/docs/models/templatecreatedocumentfromtemplatefield.md +++ b/docs/models/templatecreatedocumentfromtemplatefield.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.TemplateCreateDocumentFromTemplateFieldType](../models/templatecreatedocumentfromtemplatefieldtype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.TemplateCreateDocumentFromTemplateFieldMetaUnion]](../models/templatecreatedocumentfromtemplatefieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.TemplateCreateDocumentFromTemplateFieldMetaUnion]](../models/templatecreatedocumentfromtemplatefieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefieldmetacheckbox.md b/docs/models/templatecreatedocumentfromtemplatefieldmetacheckbox.md index 80171a1..54a24d1 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetacheckbox.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetacheckbox.md @@ -12,4 +12,5 @@ | `type` | [models.TemplateCreateDocumentFromTemplateFieldMetaTypeCheckbox](../models/templatecreatedocumentfromtemplatefieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | | `values` | List[[models.TemplateCreateDocumentFromTemplateValue2](../models/templatecreatedocumentfromtemplatevalue2.md)] | :heavy_minus_sign: | N/A | | `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.TemplateCreateDocumentFromTemplateDirection]](../models/templatecreatedocumentfromtemplatedirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefieldmetanumber.md b/docs/models/templatecreatedocumentfromtemplatefieldmetanumber.md index 3d651f5..eba6c15 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetanumber.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.TemplateCreateDocumentFromTemplateFieldMetaTypeNumber](../models/templatecreatedocumentfromtemplatefieldmetatypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.TemplateCreateDocumentFromTemplateTextAlign6]](../models/templatecreatedocumentfromtemplatetextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateglobalaccessauth.md b/docs/models/templatecreatedocumentfromtemplateglobalaccessauth.md index 81de543..d1f6dc4 100644 --- a/docs/models/templatecreatedocumentfromtemplateglobalaccessauth.md +++ b/docs/models/templatecreatedocumentfromtemplateglobalaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplaterecipientresponse.md b/docs/models/templatecreatedocumentfromtemplaterecipientresponse.md index 5f421a2..18ec1c9 100644 --- a/docs/models/templatecreatedocumentfromtemplaterecipientresponse.md +++ b/docs/models/templatecreatedocumentfromtemplaterecipientresponse.md @@ -5,13 +5,12 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.TemplateCreateDocumentFromTemplateRole](../models/templatecreatedocumentfromtemplaterole.md) | :heavy_check_mark: | N/A | | `read_status` | [models.TemplateCreateDocumentFromTemplateReadStatus](../models/templatecreatedocumentfromtemplatereadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.TemplateCreateDocumentFromTemplateSigningStatus](../models/templatecreatedocumentfromtemplatesigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.TemplateCreateDocumentFromTemplateSendStatus](../models/templatecreatedocumentfromtemplatesendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -20,4 +19,6 @@ | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.TemplateCreateDocumentFromTemplateRecipientAuthOptions]](../models/templatecreatedocumentfromtemplaterecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplaterequest.md b/docs/models/templatecreatedocumentfromtemplaterequest.md index 8486ff9..1dc3451 100644 --- a/docs/models/templatecreatedocumentfromtemplaterequest.md +++ b/docs/models/templatecreatedocumentfromtemplaterequest.md @@ -3,10 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `template_id` | *float* | :heavy_check_mark: | N/A | -| `recipients` | List[[models.TemplateCreateDocumentFromTemplateRecipientRequest](../models/templatecreatedocumentfromtemplaterecipientrequest.md)] | :heavy_check_mark: | The information of the recipients to create the document with. | -| `distribute_document` | *Optional[bool]* | :heavy_minus_sign: | Whether to create the document as pending and distribute it to recipients. | -| `custom_document_data_id` | *Optional[str]* | :heavy_minus_sign: | The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. | -| `prefill_fields` | List[[models.PrefillField](../models/prefillfield.md)] | :heavy_minus_sign: | The fields to prefill on the document before sending it out. Useful when you want to create a document from an existing template and pre-fill the fields with specific values. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `template_id` | *float* | :heavy_check_mark: | N/A | +| `recipients` | List[[models.TemplateCreateDocumentFromTemplateRecipientRequest](../models/templatecreatedocumentfromtemplaterecipientrequest.md)] | :heavy_check_mark: | The information of the recipients to create the document with. | +| `distribute_document` | *Optional[bool]* | :heavy_minus_sign: | Whether to create the document as pending and distribute it to recipients. | +| `custom_document_data_id` | *Optional[str]* | :heavy_minus_sign: | [DEPRECATED] - Use customDocumentData instead. The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. | +| `custom_document_data` | List[[models.CustomDocumentDatum](../models/customdocumentdatum.md)] | :heavy_minus_sign: | The data IDs of alternative PDFs to use when creating the document. If not provided, the PDF attached to the template will be used. | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the folder to create the document in. If not provided, the document will be created in the root folder. | +| `prefill_fields` | List[[models.PrefillField](../models/prefillfield.md)] | :heavy_minus_sign: | The fields to prefill on the document before sending it out. Useful when you want to create a document from an existing template and pre-fill the fields with specific values. | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateresponse.md b/docs/models/templatecreatedocumentfromtemplateresponse.md index 909b578..a96632c 100644 --- a/docs/models/templatecreatedocumentfromtemplateresponse.md +++ b/docs/models/templatecreatedocumentfromtemplateresponse.md @@ -16,16 +16,17 @@ Successful response | `auth_options` | [Nullable[models.TemplateCreateDocumentFromTemplateAuthOptions]](../models/templatecreatedocumentfromtemplateauthoptions.md) | :heavy_check_mark: | N/A | | `form_values` | Dict[str, [models.TemplateCreateDocumentFromTemplateFormValues](../models/templatecreatedocumentfromtemplateformvalues.md)] | :heavy_check_mark: | N/A | | `title` | *str* | :heavy_check_mark: | N/A | -| `document_data_id` | *str* | :heavy_check_mark: | N/A | | `created_at` | *str* | :heavy_check_mark: | N/A | | `updated_at` | *str* | :heavy_check_mark: | N/A | | `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `team_id` | *float* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | The ID of the template that the document was created from, if any. | +| `document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | `document_data` | [models.TemplateCreateDocumentFromTemplateDocumentData](../models/templatecreatedocumentfromtemplatedocumentdata.md) | :heavy_check_mark: | N/A | -| `document_meta` | [Nullable[models.TemplateCreateDocumentFromTemplateDocumentMeta]](../models/templatecreatedocumentfromtemplatedocumentmeta.md) | :heavy_check_mark: | N/A | +| `document_meta` | [models.TemplateCreateDocumentFromTemplateDocumentMeta](../models/templatecreatedocumentfromtemplatedocumentmeta.md) | :heavy_check_mark: | N/A | | `folder` | [Nullable[models.TemplateCreateDocumentFromTemplateFolder]](../models/templatecreatedocumentfromtemplatefolder.md) | :heavy_check_mark: | N/A | | `recipients` | List[[models.TemplateCreateDocumentFromTemplateRecipientResponse](../models/templatecreatedocumentfromtemplaterecipientresponse.md)] | :heavy_check_mark: | N/A | | `fields` | List[[models.TemplateCreateDocumentFromTemplateField](../models/templatecreatedocumentfromtemplatefield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatedirectlinkresponse.md b/docs/models/templatecreatetemplatedirectlinkresponse.md index 4a4d2a8..c2db406 100644 --- a/docs/models/templatecreatetemplatedirectlinkresponse.md +++ b/docs/models/templatecreatetemplatedirectlinkresponse.md @@ -8,8 +8,9 @@ Successful response | Field | Type | Required | Description | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | | `id` | *str* | :heavy_check_mark: | N/A | -| `template_id` | *float* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | | `created_at` | *str* | :heavy_check_mark: | N/A | | `enabled` | *bool* | :heavy_check_mark: | N/A | -| `direct_template_recipient_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file +| `direct_template_recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `template_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryaccessauth.md b/docs/models/templatecreatetemplatetemporaryaccessauth.md new file mode 100644 index 0000000..b3b0855 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryaccessauth.md @@ -0,0 +1,11 @@ +# TemplateCreateTemplateTemporaryAccessAuth + +The type of authentication required for the recipient to access the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryactionauth.md b/docs/models/templatecreatetemplatetemporaryactionauth.md new file mode 100644 index 0000000..12a81cf --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryactionauth.md @@ -0,0 +1,14 @@ +# TemplateCreateTemplateTemporaryActionAuth + +The type of authentication required for the recipient to sign the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `PASSKEY` | PASSKEY | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | +| `PASSWORD` | PASSWORD | +| `EXPLICIT_NONE` | EXPLICIT_NONE | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidauthoptions.md b/docs/models/templatecreatetemplatetemporaryauthoptions.md similarity index 52% rename from docs/models/documentgetdocumentwithdetailsbyidauthoptions.md rename to docs/models/templatecreatetemplatetemporaryauthoptions.md index 7b67703..fd331e9 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidauthoptions.md +++ b/docs/models/templatecreatetemplatetemporaryauthoptions.md @@ -1,9 +1,9 @@ -# DocumentGetDocumentWithDetailsByIDAuthOptions +# TemplateCreateTemplateTemporaryAuthOptions ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `global_access_auth` | List[[models.DocumentGetDocumentWithDetailsByIDGlobalAccessAuth](../models/documentgetdocumentwithdetailsbyidglobalaccessauth.md)] | :heavy_check_mark: | N/A | -| `global_action_auth` | List[[models.DocumentGetDocumentWithDetailsByIDGlobalActionAuth](../models/documentgetdocumentwithdetailsbyidglobalactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `global_access_auth` | List[[models.TemplateCreateTemplateTemporaryGlobalAccessAuthResponse](../models/templatecreatetemplatetemporaryglobalaccessauthresponse.md)] | :heavy_check_mark: | N/A | +| `global_action_auth` | List[[models.TemplateCreateTemplateTemporaryGlobalActionAuthResponse](../models/templatecreatetemplatetemporaryglobalactionauthresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentresenddocumentinternalservererror.md b/docs/models/templatecreatetemplatetemporarybadrequesterror.md similarity index 92% rename from docs/models/documentresenddocumentinternalservererror.md rename to docs/models/templatecreatetemplatetemporarybadrequesterror.md index 4c586ed..be1c8ac 100644 --- a/docs/models/documentresenddocumentinternalservererror.md +++ b/docs/models/templatecreatetemplatetemporarybadrequesterror.md @@ -1,6 +1,6 @@ -# DocumentResendDocumentInternalServerError +# TemplateCreateTemplateTemporaryBadRequestError -Internal server error +Invalid input data ## Fields @@ -9,4 +9,4 @@ Internal server error | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `message` | *str* | :heavy_check_mark: | N/A | | `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentResendDocumentInternalServerErrorIssue](../models/documentresenddocumentinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.TemplateCreateTemplateTemporaryBadRequestIssue](../models/templatecreatetemplatetemporarybadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdeletedocumentinternalservererrorissue.md b/docs/models/templatecreatetemplatetemporarybadrequestissue.md similarity index 84% rename from docs/models/documentdeletedocumentinternalservererrorissue.md rename to docs/models/templatecreatetemplatetemporarybadrequestissue.md index 5f72583..0dffa60 100644 --- a/docs/models/documentdeletedocumentinternalservererrorissue.md +++ b/docs/models/templatecreatetemplatetemporarybadrequestissue.md @@ -1,4 +1,4 @@ -# DocumentDeleteDocumentInternalServerErrorIssue +# TemplateCreateTemplateTemporaryBadRequestIssue ## Fields diff --git a/docs/models/templatecreatetemplatetemporarydateformat.md b/docs/models/templatecreatetemplatetemporarydateformat.md new file mode 100644 index 0000000..e4c0911 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarydateformat.md @@ -0,0 +1,31 @@ +# TemplateCreateTemplateTemporaryDateFormat + +The date format to use for date fields and signing the document. + + +## Values + +| Name | Value | +| --------------------------------- | --------------------------------- | +| `YYYY_M_MDD_HH_MM_A` | yyyy-MM-dd hh:mm a | +| `YYYY_M_MDD` | yyyy-MM-dd | +| `DD_MM_SLASH_YYYY` | dd/MM/yyyy | +| `MM_DD_SLASH_YYYY` | MM/dd/yyyy | +| `YY_M_MDD` | yy-MM-dd | +| `MMMM_DD_COMMA_YYYY` | MMMM dd, yyyy | +| `EEEE_MMMM_DD_COMMA_YYYY` | EEEE, MMMM dd, yyyy | +| `DD_MM_SLASH_YYYY_HH_MM_A` | dd/MM/yyyy hh:mm a | +| `DD_MM_SLASH_YYYY_H_HMM` | dd/MM/yyyy HH:mm | +| `MM_DD_SLASH_YYYY_HH_MM_A` | MM/dd/yyyy hh:mm a | +| `MM_DD_SLASH_YYYY_H_HMM` | MM/dd/yyyy HH:mm | +| `DD_DOT_MM_DOT_YYYY` | dd.MM.yyyy | +| `DD_DOT_MM_DOT_YYYY_H_HMM` | dd.MM.yyyy HH:mm | +| `YYYY_M_MDD_H_HMM` | yyyy-MM-dd HH:mm | +| `YY_M_MDD_HH_MM_A` | yy-MM-dd hh:mm a | +| `YY_M_MDD_H_HMM` | yy-MM-dd HH:mm | +| `YYYY_M_MDD_H_HMMSS` | yyyy-MM-dd HH:mm:ss | +| `MMMM_DD_COMMA_YYYY_HH_MM_A` | MMMM dd, yyyy hh:mm a | +| `MMMM_DD_COMMA_YYYY_H_HMM` | MMMM dd, yyyy HH:mm | +| `EEEE_MMMM_DD_COMMA_YYYY_HH_MM_A` | EEEE, MMMM dd, yyyy hh:mm a | +| `EEEE_MMMM_DD_COMMA_YYYY_H_HMM` | EEEE, MMMM dd, yyyy HH:mm | +| `ISO8601_FULL` | yyyy-MM-dd'T'HH:mm:ss.SSSXXX | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarydirection.md b/docs/models/templatecreatetemplatetemporarydirection.md new file mode 100644 index 0000000..b31f234 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarydirection.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarydirectlink.md b/docs/models/templatecreatetemplatetemporarydirectlink.md new file mode 100644 index 0000000..78824db --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarydirectlink.md @@ -0,0 +1,14 @@ +# TemplateCreateTemplateTemporaryDirectLink + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `enabled` | *bool* | :heavy_check_mark: | N/A | +| `direct_template_recipient_id` | *float* | :heavy_check_mark: | N/A | +| `template_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarydistributionmethodrequest.md b/docs/models/templatecreatetemplatetemporarydistributionmethodrequest.md new file mode 100644 index 0000000..dba74f0 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarydistributionmethodrequest.md @@ -0,0 +1,11 @@ +# TemplateCreateTemplateTemporaryDistributionMethodRequest + +The distribution method to use when sending the document to the recipients. + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryemailsettingsrequest.md b/docs/models/templatecreatetemplatetemporaryemailsettingsrequest.md new file mode 100644 index 0000000..12e9ef3 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryemailsettingsrequest.md @@ -0,0 +1,14 @@ +# TemplateCreateTemplateTemporaryEmailSettingsRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to all recipients that the document is ready for them to sign. | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to the recipient who was removed from a pending document. | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to the document owner when a recipient has signed the document. | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to the recipient who has just signed the document indicating that there are still other recipients who need to sign the document. This will only be sent if the document is still pending after the recipient has signed. | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to all recipients when the document is complete. | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to all recipients if a pending document has been deleted. | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to the document owner when the document is complete. | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfolder.md b/docs/models/templatecreatetemplatetemporaryfield.md similarity index 57% rename from docs/models/documentgetdocumentwithdetailsbyidfolder.md rename to docs/models/templatecreatetemplatetemporaryfield.md index 226e017..af1c7de 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfolder.md +++ b/docs/models/templatecreatetemplatetemporaryfield.md @@ -1,17 +1,23 @@ -# DocumentGetDocumentWithDetailsByIDFolder +# TemplateCreateTemplateTemporaryField ## Fields | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `type` | [models.DocumentGetDocumentWithDetailsByIDFolderType](../models/documentgetdocumentwithdetailsbyidfoldertype.md) | :heavy_check_mark: | N/A | -| `visibility` | [models.DocumentGetDocumentWithDetailsByIDFolderVisibility](../models/documentgetdocumentwithdetailsbyidfoldervisibility.md) | :heavy_check_mark: | N/A | -| `user_id` | *float* | :heavy_check_mark: | N/A | -| `team_id` | *float* | :heavy_check_mark: | N/A | -| `pinned` | *bool* | :heavy_check_mark: | N/A | -| `parent_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `updated_at` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryFieldType](../models/templatecreatetemplatetemporaryfieldtype.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `secondary_id` | *str* | :heavy_check_mark: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | +| `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `custom_text` | *str* | :heavy_check_mark: | N/A | +| `inserted` | *bool* | :heavy_check_mark: | N/A | +| `field_meta` | [Nullable[models.TemplateCreateTemplateTemporaryFieldMetaUnion]](../models/templatecreatetemplatetemporaryfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfieldmetacheckbox.md b/docs/models/templatecreatetemplatetemporaryfieldmetacheckbox.md new file mode 100644 index 0000000..9920324 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetacheckbox.md @@ -0,0 +1,16 @@ +# TemplateCreateTemplateTemporaryFieldMetaCheckbox + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeCheckbox](../models/templatecreatetemplatetemporarytypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.TemplateCreateTemplateTemporaryValue2](../models/templatecreatetemplatetemporaryvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.TemplateCreateTemplateTemporaryDirection]](../models/templatecreatetemplatetemporarydirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetadropdown.md b/docs/models/templatecreatetemplatetemporaryfieldmetadate.md similarity index 87% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetadropdown.md rename to docs/models/templatecreatetemplatetemporaryfieldmetadate.md index b0adae8..7344203 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetadropdown.md +++ b/docs/models/templatecreatetemplatetemporaryfieldmetadate.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaDropdown +# TemplateCreateTemplateTemporaryFieldMetaDate ## Fields @@ -9,6 +9,6 @@ | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentGetDocumentWithDetailsByIDTypeDropdown](../models/documentgetdocumentwithdetailsbyidtypedropdown.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.DocumentGetDocumentWithDetailsByIDValue3](../models/documentgetdocumentwithdetailsbyidvalue3.md)] | :heavy_minus_sign: | N/A | -| `default_value` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [models.TemplateCreateTemplateTemporaryTypeDate](../models/templatecreatetemplatetemporarytypedate.md) | :heavy_check_mark: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.TemplateCreateTemplateTemporaryTextAlign4]](../models/templatecreatetemplatetemporarytextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaradio.md b/docs/models/templatecreatetemplatetemporaryfieldmetadropdown.md similarity index 80% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetaradio.md rename to docs/models/templatecreatetemplatetemporaryfieldmetadropdown.md index b01c606..b13fc7b 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaradio.md +++ b/docs/models/templatecreatetemplatetemporaryfieldmetadropdown.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaRadio +# TemplateCreateTemplateTemporaryFieldMetaDropdown ## Fields @@ -9,5 +9,6 @@ | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentGetDocumentWithDetailsByIDTypeRadio](../models/documentgetdocumentwithdetailsbyidtyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.DocumentGetDocumentWithDetailsByIDValue1](../models/documentgetdocumentwithdetailsbyidvalue1.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [models.TemplateCreateTemplateTemporaryTypeDropdown](../models/templatecreatetemplatetemporarytypedropdown.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.TemplateCreateTemplateTemporaryValue3](../models/templatecreatetemplatetemporaryvalue3.md)] | :heavy_minus_sign: | N/A | +| `default_value` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfieldmetaemail.md b/docs/models/templatecreatetemplatetemporaryfieldmetaemail.md new file mode 100644 index 0000000..dab44b6 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetaemail.md @@ -0,0 +1,14 @@ +# TemplateCreateTemplateTemporaryFieldMetaEmail + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeEmail](../models/templatecreatetemplatetemporarytypeemail.md) | :heavy_check_mark: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.TemplateCreateTemplateTemporaryTextAlign3]](../models/templatecreatetemplatetemporarytextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfieldmetainitials.md b/docs/models/templatecreatetemplatetemporaryfieldmetainitials.md new file mode 100644 index 0000000..bd52d76 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetainitials.md @@ -0,0 +1,14 @@ +# TemplateCreateTemplateTemporaryFieldMetaInitials + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeInitials](../models/templatecreatetemplatetemporarytypeinitials.md) | :heavy_check_mark: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.TemplateCreateTemplateTemporaryTextAlign1]](../models/templatecreatetemplatetemporarytextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfieldmetaname.md b/docs/models/templatecreatetemplatetemporaryfieldmetaname.md new file mode 100644 index 0000000..6757cc2 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetaname.md @@ -0,0 +1,14 @@ +# TemplateCreateTemplateTemporaryFieldMetaName + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeName](../models/templatecreatetemplatetemporarytypename.md) | :heavy_check_mark: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.TemplateCreateTemplateTemporaryTextAlign2]](../models/templatecreatetemplatetemporarytextalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfieldmetanumber.md b/docs/models/templatecreatetemplatetemporaryfieldmetanumber.md new file mode 100644 index 0000000..a38535a --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetanumber.md @@ -0,0 +1,18 @@ +# TemplateCreateTemplateTemporaryFieldMetaNumber + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeNumber](../models/templatecreatetemplatetemporarytypenumber.md) | :heavy_check_mark: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.TemplateCreateTemplateTemporaryTextAlign6]](../models/templatecreatetemplatetemporarytextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfieldmetaradio.md b/docs/models/templatecreatetemplatetemporaryfieldmetaradio.md new file mode 100644 index 0000000..536f4f6 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetaradio.md @@ -0,0 +1,13 @@ +# TemplateCreateTemplateTemporaryFieldMetaRadio + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeRadio](../models/templatecreatetemplatetemporarytyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.TemplateCreateTemplateTemporaryValue1](../models/templatecreatetemplatetemporaryvalue1.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetacheckbox.md b/docs/models/templatecreatetemplatetemporaryfieldmetatext.md similarity index 80% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetacheckbox.md rename to docs/models/templatecreatetemplatetemporaryfieldmetatext.md index 767b5af..975aab0 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetacheckbox.md +++ b/docs/models/templatecreatetemplatetemporaryfieldmetatext.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox +# TemplateCreateTemplateTemporaryFieldMetaText ## Fields @@ -9,7 +9,8 @@ | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.DocumentGetDocumentWithDetailsByIDTypeCheckbox](../models/documentgetdocumentwithdetailsbyidtypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.DocumentGetDocumentWithDetailsByIDValue2](../models/documentgetdocumentwithdetailsbyidvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [models.TemplateCreateTemplateTemporaryTypeText](../models/templatecreatetemplatetemporarytypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.TemplateCreateTemplateTemporaryTextAlign5]](../models/templatecreatetemplatetemporarytextalign5.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfieldmetaunion.md b/docs/models/templatecreatetemplatetemporaryfieldmetaunion.md new file mode 100644 index 0000000..ce05e79 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetaunion.md @@ -0,0 +1,59 @@ +# TemplateCreateTemplateTemporaryFieldMetaUnion + + +## Supported Types + +### `models.TemplateCreateTemplateTemporaryFieldMetaInitials` + +```python +value: models.TemplateCreateTemplateTemporaryFieldMetaInitials = /* values here */ +``` + +### `models.TemplateCreateTemplateTemporaryFieldMetaName` + +```python +value: models.TemplateCreateTemplateTemporaryFieldMetaName = /* values here */ +``` + +### `models.TemplateCreateTemplateTemporaryFieldMetaEmail` + +```python +value: models.TemplateCreateTemplateTemporaryFieldMetaEmail = /* values here */ +``` + +### `models.TemplateCreateTemplateTemporaryFieldMetaDate` + +```python +value: models.TemplateCreateTemplateTemporaryFieldMetaDate = /* values here */ +``` + +### `models.TemplateCreateTemplateTemporaryFieldMetaText` + +```python +value: models.TemplateCreateTemplateTemporaryFieldMetaText = /* values here */ +``` + +### `models.TemplateCreateTemplateTemporaryFieldMetaNumber` + +```python +value: models.TemplateCreateTemplateTemporaryFieldMetaNumber = /* values here */ +``` + +### `models.TemplateCreateTemplateTemporaryFieldMetaRadio` + +```python +value: models.TemplateCreateTemplateTemporaryFieldMetaRadio = /* values here */ +``` + +### `models.TemplateCreateTemplateTemporaryFieldMetaCheckbox` + +```python +value: models.TemplateCreateTemplateTemporaryFieldMetaCheckbox = /* values here */ +``` + +### `models.TemplateCreateTemplateTemporaryFieldMetaDropdown` + +```python +value: models.TemplateCreateTemplateTemporaryFieldMetaDropdown = /* values here */ +``` + diff --git a/docs/models/templatecreatetemplatetemporaryfieldtype.md b/docs/models/templatecreatetemplatetemporaryfieldtype.md new file mode 100644 index 0000000..8c94508 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldtype.md @@ -0,0 +1,18 @@ +# TemplateCreateTemplateTemporaryFieldType + + +## Values + +| Name | Value | +| ---------------- | ---------------- | +| `SIGNATURE` | SIGNATURE | +| `FREE_SIGNATURE` | FREE_SIGNATURE | +| `INITIALS` | INITIALS | +| `NAME` | NAME | +| `EMAIL` | EMAIL | +| `DATE` | DATE | +| `TEXT` | TEXT | +| `NUMBER` | NUMBER | +| `RADIO` | RADIO | +| `CHECKBOX` | CHECKBOX | +| `DROPDOWN` | DROPDOWN | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfolder.md b/docs/models/templatecreatetemplatetemporaryfolder.md new file mode 100644 index 0000000..89d0453 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfolder.md @@ -0,0 +1,17 @@ +# TemplateCreateTemplateTemporaryFolder + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryFolderType](../models/templatecreatetemplatetemporaryfoldertype.md) | :heavy_check_mark: | N/A | +| `visibility` | [models.TemplateCreateTemplateTemporaryFolderVisibility](../models/templatecreatetemplatetemporaryfoldervisibility.md) | :heavy_check_mark: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `pinned` | *bool* | :heavy_check_mark: | N/A | +| `parent_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfoldertype.md b/docs/models/templatecreatetemplatetemporaryfoldertype.md new file mode 100644 index 0000000..d8f10fa --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfoldertype.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryFolderType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfoldervisibility.md b/docs/models/templatecreatetemplatetemporaryfoldervisibility.md new file mode 100644 index 0000000..722aeb2 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfoldervisibility.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryFolderVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryglobalaccessauthrequest.md b/docs/models/templatecreatetemplatetemporaryglobalaccessauthrequest.md new file mode 100644 index 0000000..902486b --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryglobalaccessauthrequest.md @@ -0,0 +1,11 @@ +# TemplateCreateTemplateTemporaryGlobalAccessAuthRequest + +The type of authentication required for the recipient to access the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryglobalaccessauthresponse.md b/docs/models/templatecreatetemplatetemporaryglobalaccessauthresponse.md new file mode 100644 index 0000000..b85a29f --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryglobalaccessauthresponse.md @@ -0,0 +1,11 @@ +# TemplateCreateTemplateTemporaryGlobalAccessAuthResponse + +The type of authentication required for the recipient to access the document. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidglobalactionauth.md b/docs/models/templatecreatetemplatetemporaryglobalactionauthrequest.md similarity index 87% rename from docs/models/documentgetdocumentwithdetailsbyidglobalactionauth.md rename to docs/models/templatecreatetemplatetemporaryglobalactionauthrequest.md index e96885c..91ab7bb 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidglobalactionauth.md +++ b/docs/models/templatecreatetemplatetemporaryglobalactionauthrequest.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDGlobalActionAuth +# TemplateCreateTemplateTemporaryGlobalActionAuthRequest The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. diff --git a/docs/models/templatecreatetemplatetemporaryglobalactionauthresponse.md b/docs/models/templatecreatetemplatetemporaryglobalactionauthresponse.md new file mode 100644 index 0000000..7c66164 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryglobalactionauthresponse.md @@ -0,0 +1,13 @@ +# TemplateCreateTemplateTemporaryGlobalActionAuthResponse + +The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `PASSKEY` | PASSKEY | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | +| `PASSWORD` | PASSWORD | \ No newline at end of file diff --git a/docs/models/documentduplicatedocumentinternalservererror.md b/docs/models/templatecreatetemplatetemporaryinternalservererror.md similarity index 53% rename from docs/models/documentduplicatedocumentinternalservererror.md rename to docs/models/templatecreatetemplatetemporaryinternalservererror.md index 9f22233..12ce456 100644 --- a/docs/models/documentduplicatedocumentinternalservererror.md +++ b/docs/models/templatecreatetemplatetemporaryinternalservererror.md @@ -1,12 +1,12 @@ -# DocumentDuplicateDocumentInternalServerError +# TemplateCreateTemplateTemporaryInternalServerError Internal server error ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *str* | :heavy_check_mark: | N/A | -| `issues` | List[[models.DocumentDuplicateDocumentInternalServerErrorIssue](../models/documentduplicatedocumentinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateCreateTemplateTemporaryInternalServerErrorIssue](../models/templatecreatetemplatetemporaryinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicatedocumentinternalservererrorissue.md b/docs/models/templatecreatetemplatetemporaryinternalservererrorissue.md similarity index 82% rename from docs/models/documentduplicatedocumentinternalservererrorissue.md rename to docs/models/templatecreatetemplatetemporaryinternalservererrorissue.md index b18f734..2bf65ee 100644 --- a/docs/models/documentduplicatedocumentinternalservererrorissue.md +++ b/docs/models/templatecreatetemplatetemporaryinternalservererrorissue.md @@ -1,4 +1,4 @@ -# DocumentDuplicateDocumentInternalServerErrorIssue +# TemplateCreateTemplateTemporaryInternalServerErrorIssue ## Fields diff --git a/docs/models/templatecreatetemplatetemporarylanguage.md b/docs/models/templatecreatetemplatetemporarylanguage.md new file mode 100644 index 0000000..f5d0f8d --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarylanguage.md @@ -0,0 +1,15 @@ +# TemplateCreateTemplateTemporaryLanguage + +The language to use for email communications with recipients. + + +## Values + +| Name | Value | +| ----- | ----- | +| `DE` | de | +| `EN` | en | +| `FR` | fr | +| `ES` | es | +| `IT` | it | +| `PL` | pl | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarymeta.md b/docs/models/templatecreatetemplatetemporarymeta.md new file mode 100644 index 0000000..cead086 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarymeta.md @@ -0,0 +1,22 @@ +# TemplateCreateTemplateTemporaryMeta + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | The subject of the email that will be sent to the recipients. | +| `message` | *Optional[str]* | :heavy_minus_sign: | The message of the email that will be sent to the recipients. | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne | +| `date_format` | [Optional[models.TemplateCreateTemplateTemporaryDateFormat]](../models/templatecreatetemplatetemporarydateformat.md) | :heavy_minus_sign: | The date format to use for date fields and signing the document. | +| `distribution_method` | [Optional[models.TemplateCreateTemplateTemporaryDistributionMethodRequest]](../models/templatecreatetemplatetemporarydistributionmethodrequest.md) | :heavy_minus_sign: | The distribution method to use when sending the document to the recipients. | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [Optional[models.TemplateCreateTemplateTemporaryEmailSettingsRequest]](../models/templatecreatetemplatetemporaryemailsettingsrequest.md) | :heavy_minus_sign: | N/A | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | The URL to which the recipient should be redirected after signing the document. | +| `language` | [Optional[models.TemplateCreateTemplateTemporaryLanguage]](../models/templatecreatetemplatetemporarylanguage.md) | :heavy_minus_sign: | The language to use for email communications with recipients. | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using a typed signature. | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using an uploaded signature. | +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow recipients to sign using a draw signature. | +| `signing_order` | [Optional[models.TemplateCreateTemplateTemporarySigningOrderRequest]](../models/templatecreatetemplatetemporarysigningorderrequest.md) | :heavy_minus_sign: | N/A | +| `allow_dictate_next_signer` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryreadstatus.md b/docs/models/templatecreatetemplatetemporaryreadstatus.md new file mode 100644 index 0000000..032d2e6 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryreadstatus.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryReadStatus + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `NOT_OPENED` | NOT_OPENED | +| `OPENED` | OPENED | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidrecipient.md b/docs/models/templatecreatetemplatetemporaryrecipient.md similarity index 52% rename from docs/models/documentgetdocumentwithdetailsbyidrecipient.md rename to docs/models/templatecreatetemplatetemporaryrecipient.md index 4d301e0..46e14cc 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidrecipient.md +++ b/docs/models/templatecreatetemplatetemporaryrecipient.md @@ -1,23 +1,24 @@ -# DocumentGetDocumentWithDetailsByIDRecipient +# TemplateCreateTemplateTemporaryRecipient ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `role` | [models.DocumentGetDocumentWithDetailsByIDRole](../models/documentgetdocumentwithdetailsbyidrole.md) | :heavy_check_mark: | N/A | -| `read_status` | [models.DocumentGetDocumentWithDetailsByIDReadStatus](../models/documentgetdocumentwithdetailsbyidreadstatus.md) | :heavy_check_mark: | N/A | -| `signing_status` | [models.DocumentGetDocumentWithDetailsByIDSigningStatus](../models/documentgetdocumentwithdetailsbyidsigningstatus.md) | :heavy_check_mark: | N/A | -| `send_status` | [models.DocumentGetDocumentWithDetailsByIDSendStatus](../models/documentgetdocumentwithdetailsbyidsendstatus.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `email` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `document_deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `auth_options` | [Nullable[models.DocumentGetDocumentWithDetailsByIDRecipientAuthOptions]](../models/documentgetdocumentwithdetailsbyidrecipientauthoptions.md) | :heavy_check_mark: | N/A | -| `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `role` | [models.TemplateCreateTemplateTemporaryRole](../models/templatecreatetemplatetemporaryrole.md) | :heavy_check_mark: | N/A | +| `read_status` | [models.TemplateCreateTemplateTemporaryReadStatus](../models/templatecreatetemplatetemporaryreadstatus.md) | :heavy_check_mark: | N/A | +| `signing_status` | [models.TemplateCreateTemplateTemporarySigningStatus](../models/templatecreatetemplatetemporarysigningstatus.md) | :heavy_check_mark: | N/A | +| `send_status` | [models.TemplateCreateTemplateTemporarySendStatus](../models/templatecreatetemplatetemporarysendstatus.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `email` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | +| `document_deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `auth_options` | [Nullable[models.TemplateCreateTemplateTemporaryRecipientAuthOptions]](../models/templatecreatetemplatetemporaryrecipientauthoptions.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryrecipientauthoptions.md b/docs/models/templatecreatetemplatetemporaryrecipientauthoptions.md new file mode 100644 index 0000000..4b328be --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryrecipientauthoptions.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryRecipientAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `access_auth` | List[[models.TemplateCreateTemplateTemporaryAccessAuth](../models/templatecreatetemplatetemporaryaccessauth.md)] | :heavy_check_mark: | N/A | +| `action_auth` | List[[models.TemplateCreateTemplateTemporaryActionAuth](../models/templatecreatetemplatetemporaryactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryrequest.md b/docs/models/templatecreatetemplatetemporaryrequest.md new file mode 100644 index 0000000..eb28379 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryrequest.md @@ -0,0 +1,17 @@ +# TemplateCreateTemplateTemporaryRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `title` | *str* | :heavy_check_mark: | The title of the document. | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.TemplateCreateTemplateTemporaryVisibilityRequest]](../models/templatecreatetemplatetemporaryvisibilityrequest.md) | :heavy_minus_sign: | N/A | +| `global_access_auth` | List[[models.TemplateCreateTemplateTemporaryGlobalAccessAuthRequest](../models/templatecreatetemplatetemporaryglobalaccessauthrequest.md)] | :heavy_minus_sign: | N/A | +| `global_action_auth` | List[[models.TemplateCreateTemplateTemporaryGlobalActionAuthRequest](../models/templatecreatetemplatetemporaryglobalactionauthrequest.md)] | :heavy_minus_sign: | N/A | +| `public_title` | *Optional[str]* | :heavy_minus_sign: | The title of the template that will be displayed to the public. Only applicable for public templates. | +| `public_description` | *Optional[str]* | :heavy_minus_sign: | The description of the template that will be displayed to the public. Only applicable for public templates. | +| `type` | [Optional[models.TemplateCreateTemplateTemporaryTypeRequest]](../models/templatecreatetemplatetemporarytyperequest.md) | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.TemplateCreateTemplateTemporaryMeta]](../models/templatecreatetemplatetemporarymeta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentauthoptions.md b/docs/models/templatecreatetemplatetemporaryresponse.md similarity index 67% rename from docs/models/documentsenddocumentauthoptions.md rename to docs/models/templatecreatetemplatetemporaryresponse.md index 1de00af..70ebc61 100644 --- a/docs/models/documentsenddocumentauthoptions.md +++ b/docs/models/templatecreatetemplatetemporaryresponse.md @@ -1,9 +1,11 @@ -# DocumentSendDocumentAuthOptions +# TemplateCreateTemplateTemporaryResponse + +Successful response ## Fields | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `global_access_auth` | List[[models.DocumentSendDocumentGlobalAccessAuth](../models/documentsenddocumentglobalaccessauth.md)] | :heavy_check_mark: | N/A | -| `global_action_auth` | List[[models.DocumentSendDocumentGlobalActionAuth](../models/documentsenddocumentglobalactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `template` | [models.TemplateCreateTemplateTemporaryTemplate](../models/templatecreatetemplatetemporarytemplate.md) | :heavy_check_mark: | N/A | +| `upload_url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryrole.md b/docs/models/templatecreatetemplatetemporaryrole.md new file mode 100644 index 0000000..03cf61e --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryrole.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateTemporaryRole + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `CC` | CC | +| `SIGNER` | SIGNER | +| `VIEWER` | VIEWER | +| `APPROVER` | APPROVER | +| `ASSISTANT` | ASSISTANT | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarysendstatus.md b/docs/models/templatecreatetemplatetemporarysendstatus.md new file mode 100644 index 0000000..c9aaeb4 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarysendstatus.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporarySendStatus + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `NOT_SENT` | NOT_SENT | +| `SENT` | SENT | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarysigningorderrequest.md b/docs/models/templatecreatetemplatetemporarysigningorderrequest.md new file mode 100644 index 0000000..a426c6c --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarysigningorderrequest.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporarySigningOrderRequest + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `PARALLEL` | PARALLEL | +| `SEQUENTIAL` | SEQUENTIAL | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarysigningstatus.md b/docs/models/templatecreatetemplatetemporarysigningstatus.md new file mode 100644 index 0000000..4bfc19e --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarysigningstatus.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporarySigningStatus + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `NOT_SIGNED` | NOT_SIGNED | +| `SIGNED` | SIGNED | +| `REJECTED` | REJECTED | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidresponse.md b/docs/models/templatecreatetemplatetemporarytemplate.md similarity index 81% rename from docs/models/documentgetdocumentwithdetailsbyidresponse.md rename to docs/models/templatecreatetemplatetemporarytemplate.md index ccc1a58..dea7f4c 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidresponse.md +++ b/docs/models/templatecreatetemplatetemporarytemplate.md @@ -1,31 +1,29 @@ -# DocumentGetDocumentWithDetailsByIDResponse - -Successful response +# TemplateCreateTemplateTemporaryTemplate ## Fields | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `visibility` | [models.DocumentGetDocumentWithDetailsByIDVisibility](../models/documentgetdocumentwithdetailsbyidvisibility.md) | :heavy_check_mark: | N/A | -| `status` | [models.DocumentGetDocumentWithDetailsByIDStatus](../models/documentgetdocumentwithdetailsbyidstatus.md) | :heavy_check_mark: | N/A | -| `source` | [models.DocumentGetDocumentWithDetailsByIDSource](../models/documentgetdocumentwithdetailsbyidsource.md) | :heavy_check_mark: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeResponse](../models/templatecreatetemplatetemporarytyperesponse.md) | :heavy_check_mark: | N/A | +| `visibility` | [models.TemplateCreateTemplateTemporaryVisibilityResponse](../models/templatecreatetemplatetemporaryvisibilityresponse.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `external_id` | *Nullable[str]* | :heavy_check_mark: | A custom external ID you can use to identify the document. | -| `user_id` | *float* | :heavy_check_mark: | The ID of the user that created this document. | -| `auth_options` | [Nullable[models.DocumentGetDocumentWithDetailsByIDAuthOptions]](../models/documentgetdocumentwithdetailsbyidauthoptions.md) | :heavy_check_mark: | N/A | -| `form_values` | Dict[str, [models.DocumentGetDocumentWithDetailsByIDFormValues](../models/documentgetdocumentwithdetailsbyidformvalues.md)] | :heavy_check_mark: | N/A | +| `external_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | `title` | *str* | :heavy_check_mark: | N/A | -| `document_data_id` | *str* | :heavy_check_mark: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `auth_options` | [Nullable[models.TemplateCreateTemplateTemporaryAuthOptions]](../models/templatecreatetemplatetemporaryauthoptions.md) | :heavy_check_mark: | N/A | | `created_at` | *str* | :heavy_check_mark: | N/A | | `updated_at` | *str* | :heavy_check_mark: | N/A | -| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `team_id` | *float* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `public_title` | *str* | :heavy_check_mark: | N/A | +| `public_description` | *str* | :heavy_check_mark: | N/A | | `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `document_data` | [models.DocumentGetDocumentWithDetailsByIDDocumentData](../models/documentgetdocumentwithdetailsbyiddocumentdata.md) | :heavy_check_mark: | N/A | -| `document_meta` | [Nullable[models.DocumentGetDocumentWithDetailsByIDDocumentMeta]](../models/documentgetdocumentwithdetailsbyiddocumentmeta.md) | :heavy_check_mark: | N/A | -| `folder` | [Nullable[models.DocumentGetDocumentWithDetailsByIDFolder]](../models/documentgetdocumentwithdetailsbyidfolder.md) | :heavy_check_mark: | N/A | -| `recipients` | List[[models.DocumentGetDocumentWithDetailsByIDRecipient](../models/documentgetdocumentwithdetailsbyidrecipient.md)] | :heavy_check_mark: | N/A | -| `fields` | List[[models.DocumentGetDocumentWithDetailsByIDField](../models/documentgetdocumentwithdetailsbyidfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `template_document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `template_document_data` | [models.TemplateCreateTemplateTemporaryTemplateDocumentData](../models/templatecreatetemplatetemporarytemplatedocumentdata.md) | :heavy_check_mark: | N/A | +| `template_meta` | [models.TemplateCreateTemplateTemporaryTemplateMeta](../models/templatecreatetemplatetemporarytemplatemeta.md) | :heavy_check_mark: | N/A | +| `direct_link` | [Nullable[models.TemplateCreateTemplateTemporaryDirectLink]](../models/templatecreatetemplatetemporarydirectlink.md) | :heavy_check_mark: | N/A | +| `user` | [models.TemplateCreateTemplateTemporaryUser](../models/templatecreatetemplatetemporaryuser.md) | :heavy_check_mark: | N/A | +| `recipients` | List[[models.TemplateCreateTemplateTemporaryRecipient](../models/templatecreatetemplatetemporaryrecipient.md)] | :heavy_check_mark: | N/A | +| `fields` | List[[models.TemplateCreateTemplateTemporaryField](../models/templatecreatetemplatetemporaryfield.md)] | :heavy_check_mark: | N/A | +| `folder` | [Nullable[models.TemplateCreateTemplateTemporaryFolder]](../models/templatecreatetemplatetemporaryfolder.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytemplatedocumentdata.md b/docs/models/templatecreatetemplatetemporarytemplatedocumentdata.md new file mode 100644 index 0000000..0d14391 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytemplatedocumentdata.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateTemporaryTemplateDocumentData + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.TemplateCreateTemplateTemporaryTemplateDocumentDataType](../models/templatecreatetemplatetemporarytemplatedocumentdatatype.md) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | +| `initial_data` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytemplatedocumentdatatype.md b/docs/models/templatecreatetemplatetemporarytemplatedocumentdatatype.md new file mode 100644 index 0000000..34205b6 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytemplatedocumentdatatype.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryTemplateDocumentDataType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `S3_PATH` | S3_PATH | +| `BYTES` | BYTES | +| `BYTES_64` | BYTES_64 | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytemplatemeta.md b/docs/models/templatecreatetemplatetemporarytemplatemeta.md new file mode 100644 index 0000000..f520eca --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytemplatemeta.md @@ -0,0 +1,24 @@ +# TemplateCreateTemplateTemporaryTemplateMeta + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | N/A | +| `subject` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `message` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `timezone` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `date_format` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `signing_order` | [models.TemplateCreateTemplateTemporaryTemplateMetaSigningOrder](../models/templatecreatetemplatetemporarytemplatemetasigningorder.md) | :heavy_check_mark: | N/A | +| `typed_signature_enabled` | *bool* | :heavy_check_mark: | N/A | +| `upload_signature_enabled` | *bool* | :heavy_check_mark: | N/A | +| `draw_signature_enabled` | *bool* | :heavy_check_mark: | N/A | +| `allow_dictate_next_signer` | *bool* | :heavy_check_mark: | N/A | +| `distribution_method` | [models.TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod](../models/templatecreatetemplatetemporarytemplatemetadistributionmethod.md) | :heavy_check_mark: | N/A | +| `redirect_url` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `language` | *str* | :heavy_check_mark: | N/A | +| `email_settings` | [Nullable[models.TemplateCreateTemplateTemporaryTemplateMetaEmailSettings]](../models/templatecreatetemplatetemporarytemplatemetaemailsettings.md) | :heavy_check_mark: | N/A | +| `email_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `email_reply_to` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytemplatemetadistributionmethod.md b/docs/models/templatecreatetemplatetemporarytemplatemetadistributionmethod.md new file mode 100644 index 0000000..66feada --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytemplatemetadistributionmethod.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytemplatemetaemailsettings.md b/docs/models/templatecreatetemplatetemporarytemplatemetaemailsettings.md new file mode 100644 index 0000000..7d15c32 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytemplatemetaemailsettings.md @@ -0,0 +1,14 @@ +# TemplateCreateTemplateTemporaryTemplateMetaEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to all recipients that the document is ready for them to sign. | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to the recipient who was removed from a pending document. | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to the document owner when a recipient has signed the document. | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to the recipient who has just signed the document indicating that there are still other recipients who need to sign the document. This will only be sent if the document is still pending after the recipient has signed. | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to all recipients when the document is complete. | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to all recipients if a pending document has been deleted. | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | Whether to send an email to the document owner when the document is complete. | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytemplatemetasigningorder.md b/docs/models/templatecreatetemplatetemporarytemplatemetasigningorder.md new file mode 100644 index 0000000..670d3ff --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytemplatemetasigningorder.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryTemplateMetaSigningOrder + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `PARALLEL` | PARALLEL | +| `SEQUENTIAL` | SEQUENTIAL | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytextalign1.md b/docs/models/templatecreatetemplatetemporarytextalign1.md new file mode 100644 index 0000000..796a7c8 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytextalign1.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryTextAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytextalign2.md b/docs/models/templatecreatetemplatetemporarytextalign2.md new file mode 100644 index 0000000..596f515 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytextalign2.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryTextAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytextalign3.md b/docs/models/templatecreatetemplatetemporarytextalign3.md new file mode 100644 index 0000000..2e01a38 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytextalign3.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryTextAlign3 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytextalign4.md b/docs/models/templatecreatetemplatetemporarytextalign4.md new file mode 100644 index 0000000..b6c4c62 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytextalign4.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryTextAlign4 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytextalign5.md b/docs/models/templatecreatetemplatetemporarytextalign5.md new file mode 100644 index 0000000..cf08fb6 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytextalign5.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryTextAlign5 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytextalign6.md b/docs/models/templatecreatetemplatetemporarytextalign6.md new file mode 100644 index 0000000..ef5b1b5 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytextalign6.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryTextAlign6 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytypecheckbox.md b/docs/models/templatecreatetemplatetemporarytypecheckbox.md new file mode 100644 index 0000000..d942fda --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytypecheckbox.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeCheckbox + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytypedate.md b/docs/models/templatecreatetemplatetemporarytypedate.md new file mode 100644 index 0000000..2da6be9 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytypedate.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeDate + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytypedropdown.md b/docs/models/templatecreatetemplatetemporarytypedropdown.md new file mode 100644 index 0000000..e83c30b --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytypedropdown.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeDropdown + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytypeemail.md b/docs/models/templatecreatetemplatetemporarytypeemail.md new file mode 100644 index 0000000..5434b33 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytypeemail.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeEmail + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | email | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytypeinitials.md b/docs/models/templatecreatetemplatetemporarytypeinitials.md new file mode 100644 index 0000000..d45df89 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytypeinitials.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeInitials + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | initials | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytypename.md b/docs/models/templatecreatetemplatetemporarytypename.md new file mode 100644 index 0000000..e7c1b17 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytypename.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeName + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | name | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytypenumber.md b/docs/models/templatecreatetemplatetemporarytypenumber.md new file mode 100644 index 0000000..65149e8 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytypenumber.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytyperadio.md b/docs/models/templatecreatetemplatetemporarytyperadio.md new file mode 100644 index 0000000..f506376 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytyperadio.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeRadio + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytyperequest.md b/docs/models/templatecreatetemplatetemporarytyperequest.md new file mode 100644 index 0000000..2a2a832 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytyperequest.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryTypeRequest + + +## Values + +| Name | Value | +| --------- | --------- | +| `PUBLIC` | PUBLIC | +| `PRIVATE` | PRIVATE | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytyperesponse.md b/docs/models/templatecreatetemplatetemporarytyperesponse.md new file mode 100644 index 0000000..fd5e916 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytyperesponse.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryTypeResponse + + +## Values + +| Name | Value | +| --------- | --------- | +| `PUBLIC` | PUBLIC | +| `PRIVATE` | PRIVATE | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarytypetext.md b/docs/models/templatecreatetemplatetemporarytypetext.md new file mode 100644 index 0000000..df1ee5a --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytypetext.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeText + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryuser.md b/docs/models/templatecreatetemplatetemporaryuser.md new file mode 100644 index 0000000..a017856 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryuser.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryUser + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *float* | :heavy_check_mark: | N/A | +| `name` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `email` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryvalue1.md b/docs/models/templatecreatetemplatetemporaryvalue1.md new file mode 100644 index 0000000..42f1ca5 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryvalue1.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryValue1 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *float* | :heavy_check_mark: | N/A | +| `checked` | *bool* | :heavy_check_mark: | N/A | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryvalue2.md b/docs/models/templatecreatetemplatetemporaryvalue2.md new file mode 100644 index 0000000..881b7c5 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryvalue2.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryValue2 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *float* | :heavy_check_mark: | N/A | +| `checked` | *bool* | :heavy_check_mark: | N/A | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryvalue3.md b/docs/models/templatecreatetemplatetemporaryvalue3.md new file mode 100644 index 0000000..330a719 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryvalue3.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryValue3 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryvisibilityrequest.md b/docs/models/templatecreatetemplatetemporaryvisibilityrequest.md new file mode 100644 index 0000000..6187bd7 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryvisibilityrequest.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryVisibilityRequest + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryvisibilityresponse.md b/docs/models/templatecreatetemplatetemporaryvisibilityresponse.md new file mode 100644 index 0000000..b260a12 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryvisibilityresponse.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryVisibilityResponse + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/templatedocumentdata.md b/docs/models/templatedocumentdata.md deleted file mode 100644 index 75685ef..0000000 --- a/docs/models/templatedocumentdata.md +++ /dev/null @@ -1,11 +0,0 @@ -# TemplateDocumentData - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [models.TemplateDocumentDataType](../models/templatedocumentdatatype.md) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `data` | *str* | :heavy_check_mark: | N/A | -| `initial_data` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templateduplicatetemplateglobalaccessauth.md b/docs/models/templateduplicatetemplateglobalaccessauth.md index c724059..69ee3d6 100644 --- a/docs/models/templateduplicatetemplateglobalaccessauth.md +++ b/docs/models/templateduplicatetemplateglobalaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templateduplicatetemplateresponse.md b/docs/models/templateduplicatetemplateresponse.md index 928a64e..171ab0f 100644 --- a/docs/models/templateduplicatetemplateresponse.md +++ b/docs/models/templateduplicatetemplateresponse.md @@ -15,10 +15,11 @@ Successful response | `user_id` | *float* | :heavy_check_mark: | N/A | | `team_id` | *float* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.TemplateDuplicateTemplateAuthOptions]](../models/templateduplicatetemplateauthoptions.md) | :heavy_check_mark: | N/A | -| `template_document_data_id` | *str* | :heavy_check_mark: | N/A | | `created_at` | *str* | :heavy_check_mark: | N/A | | `updated_at` | *str* | :heavy_check_mark: | N/A | | `public_title` | *str* | :heavy_check_mark: | N/A | | `public_description` | *str* | :heavy_check_mark: | N/A | | `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file +| `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `template_document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesaccessauth.md b/docs/models/templatefindtemplatesaccessauth.md index a178d35..80d6830 100644 --- a/docs/models/templatefindtemplatesaccessauth.md +++ b/docs/models/templatefindtemplatesaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesdata.md b/docs/models/templatefindtemplatesdata.md index c7aef28..a03a8fd 100644 --- a/docs/models/templatefindtemplatesdata.md +++ b/docs/models/templatefindtemplatesdata.md @@ -13,15 +13,16 @@ | `user_id` | *float* | :heavy_check_mark: | N/A | | `team_id` | *float* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.TemplateFindTemplatesAuthOptions]](../models/templatefindtemplatesauthoptions.md) | :heavy_check_mark: | N/A | -| `template_document_data_id` | *str* | :heavy_check_mark: | N/A | | `created_at` | *str* | :heavy_check_mark: | N/A | | `updated_at` | *str* | :heavy_check_mark: | N/A | | `public_title` | *str* | :heavy_check_mark: | N/A | | `public_description` | *str* | :heavy_check_mark: | N/A | | `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `team` | [Nullable[models.TemplateFindTemplatesTeam]](../models/templatefindtemplatesteam.md) | :heavy_check_mark: | N/A | | `fields` | List[[models.TemplateFindTemplatesField](../models/templatefindtemplatesfield.md)] | :heavy_check_mark: | N/A | | `recipients` | List[[models.TemplateFindTemplatesRecipient](../models/templatefindtemplatesrecipient.md)] | :heavy_check_mark: | N/A | | `template_meta` | [Nullable[models.TemplateFindTemplatesTemplateMeta]](../models/templatefindtemplatestemplatemeta.md) | :heavy_check_mark: | N/A | -| `direct_link` | [Nullable[models.TemplateFindTemplatesDirectLink]](../models/templatefindtemplatesdirectlink.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `direct_link` | [Nullable[models.TemplateFindTemplatesDirectLink]](../models/templatefindtemplatesdirectlink.md) | :heavy_check_mark: | N/A | +| `template_document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesdirection.md b/docs/models/templatefindtemplatesdirection.md new file mode 100644 index 0000000..03b15d7 --- /dev/null +++ b/docs/models/templatefindtemplatesdirection.md @@ -0,0 +1,9 @@ +# TemplateFindTemplatesDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfield.md b/docs/models/templatefindtemplatesfield.md index b5eb276..1ed67a7 100644 --- a/docs/models/templatefindtemplatesfield.md +++ b/docs/models/templatefindtemplatesfield.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.TemplateFindTemplatesFieldType](../models/templatefindtemplatesfieldtype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.TemplateFindTemplatesFieldMetaUnion]](../models/templatefindtemplatesfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.TemplateFindTemplatesFieldMetaUnion]](../models/templatefindtemplatesfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfieldmetacheckbox.md b/docs/models/templatefindtemplatesfieldmetacheckbox.md index 7d993dc..77e9c9f 100644 --- a/docs/models/templatefindtemplatesfieldmetacheckbox.md +++ b/docs/models/templatefindtemplatesfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.TemplateFindTemplatesTypeCheckbox](../models/templatefindtemplatestypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.TemplateFindTemplatesValue2](../models/templatefindtemplatesvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateFindTemplatesTypeCheckbox](../models/templatefindtemplatestypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.TemplateFindTemplatesValue2](../models/templatefindtemplatesvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.TemplateFindTemplatesDirection]](../models/templatefindtemplatesdirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfieldmetanumber.md b/docs/models/templatefindtemplatesfieldmetanumber.md index f4d867b..aece3ed 100644 --- a/docs/models/templatefindtemplatesfieldmetanumber.md +++ b/docs/models/templatefindtemplatesfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.TemplateFindTemplatesTypeNumber](../models/templatefindtemplatestypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.TemplateFindTemplatesTextAlign6]](../models/templatefindtemplatestextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesglobalaccessauth.md b/docs/models/templatefindtemplatesglobalaccessauth.md index bb3e24d..b41201b 100644 --- a/docs/models/templatefindtemplatesglobalaccessauth.md +++ b/docs/models/templatefindtemplatesglobalaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesrecipient.md b/docs/models/templatefindtemplatesrecipient.md index 51d0101..a2b92cb 100644 --- a/docs/models/templatefindtemplatesrecipient.md +++ b/docs/models/templatefindtemplatesrecipient.md @@ -5,13 +5,12 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.TemplateFindTemplatesRole](../models/templatefindtemplatesrole.md) | :heavy_check_mark: | N/A | | `read_status` | [models.TemplateFindTemplatesReadStatus](../models/templatefindtemplatesreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.TemplateFindTemplatesSigningStatus](../models/templatefindtemplatessigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.TemplateFindTemplatesSendStatus](../models/templatefindtemplatessendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -20,4 +19,6 @@ | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.TemplateFindTemplatesRecipientAuthOptions]](../models/templatefindtemplatesrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatestemplatemeta.md b/docs/models/templatefindtemplatestemplatemeta.md index b0801d0..57cb8b9 100644 --- a/docs/models/templatefindtemplatestemplatemeta.md +++ b/docs/models/templatefindtemplatestemplatemeta.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `signing_order` | [Nullable[models.TemplateFindTemplatesSigningOrder]](../models/templatefindtemplatessigningorder.md) | :heavy_check_mark: | N/A | +| `signing_order` | [models.TemplateFindTemplatesSigningOrder](../models/templatefindtemplatessigningorder.md) | :heavy_check_mark: | N/A | | `distribution_method` | [models.TemplateFindTemplatesDistributionMethod](../models/templatefindtemplatesdistributionmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidaccessauth.md b/docs/models/templategettemplatebyidaccessauth.md index e6f5902..29759c6 100644 --- a/docs/models/templategettemplatebyidaccessauth.md +++ b/docs/models/templategettemplatebyidaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templategettemplatebyiddirection.md b/docs/models/templategettemplatebyiddirection.md new file mode 100644 index 0000000..cbcb4aa --- /dev/null +++ b/docs/models/templategettemplatebyiddirection.md @@ -0,0 +1,9 @@ +# TemplateGetTemplateByIDDirection + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/templategettemplatebyiddirectlink.md b/docs/models/templategettemplatebyiddirectlink.md index c2ef732..698bd45 100644 --- a/docs/models/templategettemplatebyiddirectlink.md +++ b/docs/models/templategettemplatebyiddirectlink.md @@ -6,8 +6,9 @@ | Field | Type | Required | Description | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | | `id` | *str* | :heavy_check_mark: | N/A | -| `template_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | | `created_at` | *str* | :heavy_check_mark: | N/A | | `enabled` | *bool* | :heavy_check_mark: | N/A | -| `direct_template_recipient_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file +| `direct_template_recipient_id` | *float* | :heavy_check_mark: | N/A | +| `template_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfield.md b/docs/models/templategettemplatebyidfield.md index 7e2de8f..2677d6a 100644 --- a/docs/models/templategettemplatebyidfield.md +++ b/docs/models/templategettemplatebyidfield.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | | `type` | [models.TemplateGetTemplateByIDFieldType](../models/templategettemplatebyidfieldtype.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | | `secondary_id` | *str* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `recipient_id` | *float* | :heavy_check_mark: | N/A | | `page` | *float* | :heavy_check_mark: | The page number of the field on the document. Starts from 1. | | `position_x` | *Optional[Any]* | :heavy_minus_sign: | N/A | @@ -18,4 +18,6 @@ | `height` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `custom_text` | *str* | :heavy_check_mark: | N/A | | `inserted` | *bool* | :heavy_check_mark: | N/A | -| `field_meta` | [Nullable[models.TemplateGetTemplateByIDFieldMetaUnion]](../models/templategettemplatebyidfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `field_meta` | [Nullable[models.TemplateGetTemplateByIDFieldMetaUnion]](../models/templategettemplatebyidfieldmetaunion.md) | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfieldmetacheckbox.md b/docs/models/templategettemplatebyidfieldmetacheckbox.md index 35cb16f..36940cd 100644 --- a/docs/models/templategettemplatebyidfieldmetacheckbox.md +++ b/docs/models/templategettemplatebyidfieldmetacheckbox.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [models.TemplateGetTemplateByIDTypeCheckbox](../models/templategettemplatebyidtypecheckbox.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.TemplateGetTemplateByIDValue2](../models/templategettemplatebyidvalue2.md)] | :heavy_minus_sign: | N/A | -| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateGetTemplateByIDTypeCheckbox](../models/templategettemplatebyidtypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.TemplateGetTemplateByIDValue2](../models/templategettemplatebyidvalue2.md)] | :heavy_minus_sign: | N/A | +| `validation_rule` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.TemplateGetTemplateByIDDirection]](../models/templategettemplatebyiddirection.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfieldmetanumber.md b/docs/models/templategettemplatebyidfieldmetanumber.md index 7f3de4f..141bd0a 100644 --- a/docs/models/templategettemplatebyidfieldmetanumber.md +++ b/docs/models/templategettemplatebyidfieldmetanumber.md @@ -10,9 +10,9 @@ | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [models.TemplateGetTemplateByIDTypeNumber](../models/templategettemplatebyidtypenumber.md) | :heavy_check_mark: | N/A | -| `number_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `number_format` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `min_value` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `max_value` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `min_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `max_value` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `text_align` | [Optional[models.TemplateGetTemplateByIDTextAlign6]](../models/templategettemplatebyidtextalign6.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidglobalaccessauth.md b/docs/models/templategettemplatebyidglobalaccessauth.md index 5cdb7a4..29ce570 100644 --- a/docs/models/templategettemplatebyidglobalaccessauth.md +++ b/docs/models/templategettemplatebyidglobalaccessauth.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidrecipient.md b/docs/models/templategettemplatebyidrecipient.md index 6bc2a10..2e58302 100644 --- a/docs/models/templategettemplatebyidrecipient.md +++ b/docs/models/templategettemplatebyidrecipient.md @@ -5,13 +5,12 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | | `role` | [models.TemplateGetTemplateByIDRole](../models/templategettemplatebyidrole.md) | :heavy_check_mark: | N/A | | `read_status` | [models.TemplateGetTemplateByIDReadStatus](../models/templategettemplatebyidreadstatus.md) | :heavy_check_mark: | N/A | | `signing_status` | [models.TemplateGetTemplateByIDSigningStatus](../models/templategettemplatebyidsigningstatus.md) | :heavy_check_mark: | N/A | | `send_status` | [models.TemplateGetTemplateByIDSendStatus](../models/templategettemplatebyidsendstatus.md) | :heavy_check_mark: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | -| `document_id` | *Nullable[float]* | :heavy_check_mark: | N/A | -| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | | `email` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | @@ -20,4 +19,6 @@ | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.TemplateGetTemplateByIDRecipientAuthOptions]](../models/templategettemplatebyidrecipientauthoptions.md) | :heavy_check_mark: | N/A | | `signing_order` | *Nullable[float]* | :heavy_check_mark: | The order in which the recipient should sign the document. Only works if the document is set to sequential signing. | -| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `document_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidresponse.md b/docs/models/templategettemplatebyidresponse.md index bba9c2a..017ef43 100644 --- a/docs/models/templategettemplatebyidresponse.md +++ b/docs/models/templategettemplatebyidresponse.md @@ -5,26 +5,27 @@ Successful response ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [models.TemplateGetTemplateByIDType](../models/templategettemplatebyidtype.md) | :heavy_check_mark: | N/A | -| `visibility` | [models.TemplateGetTemplateByIDVisibility](../models/templategettemplatebyidvisibility.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | -| `external_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `user_id` | *float* | :heavy_check_mark: | N/A | -| `team_id` | *float* | :heavy_check_mark: | N/A | -| `auth_options` | [Nullable[models.TemplateGetTemplateByIDAuthOptions]](../models/templategettemplatebyidauthoptions.md) | :heavy_check_mark: | N/A | -| `template_document_data_id` | *str* | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `updated_at` | *str* | :heavy_check_mark: | N/A | -| `public_title` | *str* | :heavy_check_mark: | N/A | -| `public_description` | *str* | :heavy_check_mark: | N/A | -| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `template_document_data` | [models.TemplateDocumentData](../models/templatedocumentdata.md) | :heavy_check_mark: | N/A | -| `template_meta` | [Nullable[models.TemplateGetTemplateByIDTemplateMeta]](../models/templategettemplatebyidtemplatemeta.md) | :heavy_check_mark: | N/A | -| `direct_link` | [Nullable[models.TemplateGetTemplateByIDDirectLink]](../models/templategettemplatebyiddirectlink.md) | :heavy_check_mark: | N/A | -| `user` | [models.TemplateGetTemplateByIDUser](../models/templategettemplatebyiduser.md) | :heavy_check_mark: | N/A | -| `recipients` | List[[models.TemplateGetTemplateByIDRecipient](../models/templategettemplatebyidrecipient.md)] | :heavy_check_mark: | N/A | -| `fields` | List[[models.TemplateGetTemplateByIDField](../models/templategettemplatebyidfield.md)] | :heavy_check_mark: | N/A | -| `folder` | [Nullable[models.TemplateGetTemplateByIDFolder]](../models/templategettemplatebyidfolder.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `type` | [models.TemplateGetTemplateByIDType](../models/templategettemplatebyidtype.md) | :heavy_check_mark: | N/A | +| `visibility` | [models.TemplateGetTemplateByIDVisibility](../models/templategettemplatebyidvisibility.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `external_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `auth_options` | [Nullable[models.TemplateGetTemplateByIDAuthOptions]](../models/templategettemplatebyidauthoptions.md) | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `public_title` | *str* | :heavy_check_mark: | N/A | +| `public_description` | *str* | :heavy_check_mark: | N/A | +| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `template_document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `template_document_data` | [models.TemplateGetTemplateByIDTemplateDocumentData](../models/templategettemplatebyidtemplatedocumentdata.md) | :heavy_check_mark: | N/A | +| `template_meta` | [models.TemplateGetTemplateByIDTemplateMeta](../models/templategettemplatebyidtemplatemeta.md) | :heavy_check_mark: | N/A | +| `direct_link` | [Nullable[models.TemplateGetTemplateByIDDirectLink]](../models/templategettemplatebyiddirectlink.md) | :heavy_check_mark: | N/A | +| `user` | [models.TemplateGetTemplateByIDUser](../models/templategettemplatebyiduser.md) | :heavy_check_mark: | N/A | +| `recipients` | List[[models.TemplateGetTemplateByIDRecipient](../models/templategettemplatebyidrecipient.md)] | :heavy_check_mark: | N/A | +| `fields` | List[[models.TemplateGetTemplateByIDField](../models/templategettemplatebyidfield.md)] | :heavy_check_mark: | N/A | +| `folder` | [Nullable[models.TemplateGetTemplateByIDFolder]](../models/templategettemplatebyidfolder.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidtemplatedocumentdata.md b/docs/models/templategettemplatebyidtemplatedocumentdata.md new file mode 100644 index 0000000..76a2f63 --- /dev/null +++ b/docs/models/templategettemplatebyidtemplatedocumentdata.md @@ -0,0 +1,12 @@ +# TemplateGetTemplateByIDTemplateDocumentData + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.TemplateGetTemplateByIDTemplateDocumentDataType](../models/templategettemplatebyidtemplatedocumentdatatype.md) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | +| `initial_data` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyiddocumentdatatype.md b/docs/models/templategettemplatebyidtemplatedocumentdatatype.md similarity index 74% rename from docs/models/documentgetdocumentwithdetailsbyiddocumentdatatype.md rename to docs/models/templategettemplatebyidtemplatedocumentdatatype.md index ccb3abb..eb46d8d 100644 --- a/docs/models/documentgetdocumentwithdetailsbyiddocumentdatatype.md +++ b/docs/models/templategettemplatebyidtemplatedocumentdatatype.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDDocumentDataType +# TemplateGetTemplateByIDTemplateDocumentDataType ## Values diff --git a/docs/models/templategettemplatebyidtemplatemeta.md b/docs/models/templategettemplatebyidtemplatemeta.md index aecb078..82e7f9f 100644 --- a/docs/models/templategettemplatebyidtemplatemeta.md +++ b/docs/models/templategettemplatebyidtemplatemeta.md @@ -10,13 +10,15 @@ | `message` | *Nullable[str]* | :heavy_check_mark: | N/A | | `timezone` | *Nullable[str]* | :heavy_check_mark: | N/A | | `date_format` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `signing_order` | [Nullable[models.TemplateGetTemplateByIDSigningOrder]](../models/templategettemplatebyidsigningorder.md) | :heavy_check_mark: | N/A | +| `signing_order` | [models.TemplateGetTemplateByIDSigningOrder](../models/templategettemplatebyidsigningorder.md) | :heavy_check_mark: | N/A | | `typed_signature_enabled` | *bool* | :heavy_check_mark: | N/A | | `upload_signature_enabled` | *bool* | :heavy_check_mark: | N/A | | `draw_signature_enabled` | *bool* | :heavy_check_mark: | N/A | | `allow_dictate_next_signer` | *bool* | :heavy_check_mark: | N/A | | `distribution_method` | [models.TemplateGetTemplateByIDDistributionMethod](../models/templategettemplatebyiddistributionmethod.md) | :heavy_check_mark: | N/A | -| `template_id` | *float* | :heavy_check_mark: | N/A | | `redirect_url` | *Nullable[str]* | :heavy_check_mark: | N/A | | `language` | *str* | :heavy_check_mark: | N/A | -| `email_settings` | [Nullable[models.TemplateGetTemplateByIDEmailSettings]](../models/templategettemplatebyidemailsettings.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `email_settings` | [Nullable[models.TemplateGetTemplateByIDEmailSettings]](../models/templategettemplatebyidemailsettings.md) | :heavy_check_mark: | N/A | +| `email_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `email_reply_to` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatetoggletemplatedirectlinkresponse.md b/docs/models/templatetoggletemplatedirectlinkresponse.md index 29bf568..3f8354e 100644 --- a/docs/models/templatetoggletemplatedirectlinkresponse.md +++ b/docs/models/templatetoggletemplatedirectlinkresponse.md @@ -8,8 +8,9 @@ Successful response | Field | Type | Required | Description | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | | `id` | *str* | :heavy_check_mark: | N/A | -| `template_id` | *float* | :heavy_check_mark: | N/A | | `token` | *str* | :heavy_check_mark: | N/A | | `created_at` | *str* | :heavy_check_mark: | N/A | | `enabled` | *bool* | :heavy_check_mark: | N/A | -| `direct_template_recipient_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file +| `direct_template_recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `template_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templateupdatetemplatedata.md b/docs/models/templateupdatetemplatedata.md index 2776bb1..6b050e4 100644 --- a/docs/models/templateupdatetemplatedata.md +++ b/docs/models/templateupdatetemplatedata.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `title` | *Optional[str]* | :heavy_minus_sign: | The title of the document. | | `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `visibility` | [Optional[models.TemplateUpdateTemplateVisibilityRequest]](../models/templateupdatetemplatevisibilityrequest.md) | :heavy_minus_sign: | N/A | | `global_access_auth` | List[[models.TemplateUpdateTemplateGlobalAccessAuthRequest](../models/templateupdatetemplateglobalaccessauthrequest.md)] | :heavy_minus_sign: | N/A | @@ -13,4 +13,5 @@ | `public_title` | *Optional[str]* | :heavy_minus_sign: | The title of the template that will be displayed to the public. Only applicable for public templates. | | `public_description` | *Optional[str]* | :heavy_minus_sign: | The description of the template that will be displayed to the public. Only applicable for public templates. | | `type` | [Optional[models.TemplateUpdateTemplateDataType]](../models/templateupdatetemplatedatatype.md) | :heavy_minus_sign: | N/A | -| `use_legacy_field_insertion` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `use_legacy_field_insertion` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `folder_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templateupdatetemplatedateformat.md b/docs/models/templateupdatetemplatedateformat.md index 4c5aaf2..4fc82bc 100644 --- a/docs/models/templateupdatetemplatedateformat.md +++ b/docs/models/templateupdatetemplatedateformat.md @@ -5,15 +5,27 @@ The date format to use for date fields and signing the document. ## Values -| Name | Value | -| ------------------------------ | ------------------------------ | -| `YYYY_MM_DD_HH_MM_A` | yyyy-MM-dd hh:mm a | -| `YYYY_MM_DD` | yyyy-MM-dd | -| `DD_MM_YYYY_HH_MM_A` | dd/MM/yyyy hh:mm a | -| `MM_DD_YYYY_HH_MM_A` | MM/dd/yyyy hh:mm a | -| `YYYY_MM_DD_HH_MM` | yyyy-MM-dd HH:mm | -| `YY_MM_DD_HH_MM_A` | yy-MM-dd hh:mm a | -| `YYYY_MM_DD_HH_MM_SS` | yyyy-MM-dd HH:mm:ss | -| `MMMM_DD_YYYY_HH_MM_A` | MMMM dd, yyyy hh:mm a | -| `EEEE_MMMM_DD_YYYY_HH_MM_A` | EEEE, MMMM dd, yyyy hh:mm a | -| `YYYY_MM_DD_T_HH_MM_SS_SSSXXX` | yyyy-MM-dd'T'HH:mm:ss.SSSXXX | \ No newline at end of file +| Name | Value | +| --------------------------------- | --------------------------------- | +| `YYYY_M_MDD_HH_MM_A` | yyyy-MM-dd hh:mm a | +| `YYYY_M_MDD` | yyyy-MM-dd | +| `DD_MM_SLASH_YYYY` | dd/MM/yyyy | +| `MM_DD_SLASH_YYYY` | MM/dd/yyyy | +| `YY_M_MDD` | yy-MM-dd | +| `MMMM_DD_COMMA_YYYY` | MMMM dd, yyyy | +| `EEEE_MMMM_DD_COMMA_YYYY` | EEEE, MMMM dd, yyyy | +| `DD_MM_SLASH_YYYY_HH_MM_A` | dd/MM/yyyy hh:mm a | +| `DD_MM_SLASH_YYYY_H_HMM` | dd/MM/yyyy HH:mm | +| `MM_DD_SLASH_YYYY_HH_MM_A` | MM/dd/yyyy hh:mm a | +| `MM_DD_SLASH_YYYY_H_HMM` | MM/dd/yyyy HH:mm | +| `DD_DOT_MM_DOT_YYYY` | dd.MM.yyyy | +| `DD_DOT_MM_DOT_YYYY_H_HMM` | dd.MM.yyyy HH:mm | +| `YYYY_M_MDD_H_HMM` | yyyy-MM-dd HH:mm | +| `YY_M_MDD_HH_MM_A` | yy-MM-dd hh:mm a | +| `YY_M_MDD_H_HMM` | yy-MM-dd HH:mm | +| `YYYY_M_MDD_H_HMMSS` | yyyy-MM-dd HH:mm:ss | +| `MMMM_DD_COMMA_YYYY_HH_MM_A` | MMMM dd, yyyy hh:mm a | +| `MMMM_DD_COMMA_YYYY_H_HMM` | MMMM dd, yyyy HH:mm | +| `EEEE_MMMM_DD_COMMA_YYYY_HH_MM_A` | EEEE, MMMM dd, yyyy hh:mm a | +| `EEEE_MMMM_DD_COMMA_YYYY_H_HMM` | EEEE, MMMM dd, yyyy HH:mm | +| `ISO8601_FULL` | yyyy-MM-dd'T'HH:mm:ss.SSSXXX | \ No newline at end of file diff --git a/docs/models/templateupdatetemplateglobalaccessauthrequest.md b/docs/models/templateupdatetemplateglobalaccessauthrequest.md index 5719ae1..f396af6 100644 --- a/docs/models/templateupdatetemplateglobalaccessauthrequest.md +++ b/docs/models/templateupdatetemplateglobalaccessauthrequest.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templateupdatetemplateglobalaccessauthresponse.md b/docs/models/templateupdatetemplateglobalaccessauthresponse.md index f0dce78..02fc116 100644 --- a/docs/models/templateupdatetemplateglobalaccessauthresponse.md +++ b/docs/models/templateupdatetemplateglobalaccessauthresponse.md @@ -5,6 +5,7 @@ The type of authentication required for the recipient to access the document. ## Values -| Name | Value | -| --------- | --------- | -| `ACCOUNT` | ACCOUNT | \ No newline at end of file +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templateupdatetemplatemeta.md b/docs/models/templateupdatetemplatemeta.md index 331f611..54f86a1 100644 --- a/docs/models/templateupdatetemplatemeta.md +++ b/docs/models/templateupdatetemplatemeta.md @@ -10,6 +10,8 @@ | `timezone` | *Optional[str]* | :heavy_minus_sign: | The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne | | `date_format` | [Optional[models.TemplateUpdateTemplateDateFormat]](../models/templateupdatetemplatedateformat.md) | :heavy_minus_sign: | The date format to use for date fields and signing the document. | | `distribution_method` | [Optional[models.TemplateUpdateTemplateDistributionMethod]](../models/templateupdatetemplatedistributionmethod.md) | :heavy_minus_sign: | The distribution method to use when sending the document to the recipients. | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `email_settings` | [Optional[models.TemplateUpdateTemplateEmailSettings]](../models/templateupdatetemplateemailsettings.md) | :heavy_minus_sign: | N/A | | `redirect_url` | *Optional[str]* | :heavy_minus_sign: | The URL to which the recipient should be redirected after signing the document. | | `language` | [Optional[models.TemplateUpdateTemplateLanguage]](../models/templateupdatetemplatelanguage.md) | :heavy_minus_sign: | The language to use for email communications with recipients. | diff --git a/docs/models/templateupdatetemplateresponse.md b/docs/models/templateupdatetemplateresponse.md index 9217e07..08d5c0f 100644 --- a/docs/models/templateupdatetemplateresponse.md +++ b/docs/models/templateupdatetemplateresponse.md @@ -15,10 +15,11 @@ Successful response | `user_id` | *float* | :heavy_check_mark: | N/A | | `team_id` | *float* | :heavy_check_mark: | N/A | | `auth_options` | [Nullable[models.TemplateUpdateTemplateAuthOptions]](../models/templateupdatetemplateauthoptions.md) | :heavy_check_mark: | N/A | -| `template_document_data_id` | *str* | :heavy_check_mark: | N/A | | `created_at` | *str* | :heavy_check_mark: | N/A | | `updated_at` | *str* | :heavy_check_mark: | N/A | | `public_title` | *str* | :heavy_check_mark: | N/A | | `public_description` | *str* | :heavy_check_mark: | N/A | | `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file +| `use_legacy_field_insertion` | *bool* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `template_document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/version.md b/docs/models/version.md new file mode 100644 index 0000000..d0a0b52 --- /dev/null +++ b/docs/models/version.md @@ -0,0 +1,11 @@ +# Version + +The version of the document to download. "signed" returns the completed document with signatures, "original" returns the original uploaded document. + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `ORIGINAL` | original | +| `SIGNED` | signed | \ No newline at end of file diff --git a/docs/sdks/documenso/README.md b/docs/sdks/documenso/README.md deleted file mode 100644 index 1a7081f..0000000 --- a/docs/sdks/documenso/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Documenso SDK - -## Overview - -Documenso v2 beta API: Subject to breaking changes until v2 is fully released. - -### Available Operations diff --git a/docs/sdks/documents/README.md b/docs/sdks/documents/README.md index 4b6ef8d..7e1bcbc 100644 --- a/docs/sdks/documents/README.md +++ b/docs/sdks/documents/README.md @@ -5,22 +5,22 @@ ### Available Operations -* [update](#update) - Update document -* [find](#find) - Find documents * [get](#get) - Get document -* [create_v0](#create_v0) - Create document +* [find](#find) - Find documents +* [update](#update) - Update document * [delete](#delete) - Delete document +* [duplicate](#duplicate) - Duplicate document * [distribute](#distribute) - Distribute document * [redistribute](#redistribute) - Redistribute document -* [duplicate](#duplicate) - Duplicate document +* [create_v0](#create_v0) - Create document -## update +## get -Update document +Returns a document given an ID ### Example Usage - + ```python from documenso_sdk import Documenso import os @@ -30,7 +30,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92) + res = documenso.documents.get(document_id=6150.61) # Handle response print(res) @@ -39,24 +39,23 @@ with Documenso( ### Parameters -| Parameter | Type | Required | Description | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `document_id` | *float* | :heavy_check_mark: | N/A | -| `data` | [Optional[models.DocumentUpdateDocumentData]](../../models/documentupdatedocumentdata.md) | :heavy_minus_sign: | N/A | -| `meta` | [Optional[models.DocumentUpdateDocumentMeta]](../../models/documentupdatedocumentmeta.md) | :heavy_minus_sign: | N/A | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | N/A | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response -**[models.DocumentUpdateDocumentResponse](../../models/documentupdatedocumentresponse.md)** +**[models.DocumentGetResponse](../../models/documentgetresponse.md)** ### Errors -| Error Type | Status Code | Content Type | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| models.DocumentUpdateDocumentBadRequestError | 400 | application/json | -| models.DocumentUpdateDocumentInternalServerError | 500 | application/json | -| models.APIError | 4XX, 5XX | \*/\* | +| Error Type | Status Code | Content Type | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | +| models.DocumentGetBadRequestError | 400 | application/json | +| models.DocumentGetNotFoundError | 404 | application/json | +| models.DocumentGetInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | ## find @@ -64,7 +63,7 @@ Find documents based on a search criteria ### Example Usage - + ```python import documenso_sdk from documenso_sdk import Documenso @@ -99,24 +98,24 @@ with Documenso( ### Response -**[models.DocumentFindDocumentsResponse](../../models/documentfinddocumentsresponse.md)** +**[models.DocumentFindResponse](../../models/documentfindresponse.md)** ### Errors -| Error Type | Status Code | Content Type | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| models.DocumentFindDocumentsBadRequestError | 400 | application/json | -| models.DocumentFindDocumentsNotFoundError | 404 | application/json | -| models.DocumentFindDocumentsInternalServerError | 500 | application/json | -| models.APIError | 4XX, 5XX | \*/\* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models.DocumentFindBadRequestError | 400 | application/json | +| models.DocumentFindNotFoundError | 404 | application/json | +| models.DocumentFindInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | -## get +## update -Returns a document given an ID +Update document ### Example Usage - + ```python from documenso_sdk import Documenso import os @@ -126,7 +125,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.get(document_id=7491.86) + res = documenso.documents.update(document_id=3428.95) # Handle response print(res) @@ -135,32 +134,32 @@ with Documenso( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `document_id` | *float* | :heavy_check_mark: | N/A | -| `folder_id` | *Optional[str]* | :heavy_minus_sign: | Filter documents by folder ID | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | N/A | +| `data` | [Optional[models.DocumentUpdateData]](../../models/documentupdatedata.md) | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.DocumentUpdateMeta]](../../models/documentupdatemeta.md) | :heavy_minus_sign: | N/A | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response -**[models.DocumentGetDocumentWithDetailsByIDResponse](../../models/documentgetdocumentwithdetailsbyidresponse.md)** +**[models.DocumentUpdateResponse](../../models/documentupdateresponse.md)** ### Errors -| Error Type | Status Code | Content Type | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| models.DocumentGetDocumentWithDetailsByIDBadRequestError | 400 | application/json | -| models.DocumentGetDocumentWithDetailsByIDNotFoundError | 404 | application/json | -| models.DocumentGetDocumentWithDetailsByIDInternalServerError | 500 | application/json | -| models.APIError | 4XX, 5XX | \*/\* | +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| models.DocumentUpdateBadRequestError | 400 | application/json | +| models.DocumentUpdateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | -## create_v0 +## delete -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. +Delete document ### Example Usage - + ```python from documenso_sdk import Documenso import os @@ -170,7 +169,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.create_v0(title="") + res = documenso.documents.delete(document_id=3963.4) # Handle response print(res) @@ -179,37 +178,30 @@ with Documenso( ### Parameters -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `title` | *str* | :heavy_check_mark: | The title of the document. | -| `external_id` | *Optional[str]* | :heavy_minus_sign: | The external ID of the document. | -| `visibility` | [Optional[models.DocumentCreateDocumentTemporaryVisibilityRequest]](../../models/documentcreatedocumenttemporaryvisibilityrequest.md) | :heavy_minus_sign: | The visibility of the document. | -| `global_access_auth` | List[[models.DocumentCreateDocumentTemporaryGlobalAccessAuthRequest](../../models/documentcreatedocumenttemporaryglobalaccessauthrequest.md)] | :heavy_minus_sign: | N/A | -| `global_action_auth` | List[[models.DocumentCreateDocumentTemporaryGlobalActionAuthRequest](../../models/documentcreatedocumenttemporaryglobalactionauthrequest.md)] | :heavy_minus_sign: | N/A | -| `form_values` | Dict[str, [models.FormValuesRequest](../../models/formvaluesrequest.md)] | :heavy_minus_sign: | N/A | -| `recipients` | List[[models.DocumentCreateDocumentTemporaryRecipientRequest](../../models/documentcreatedocumenttemporaryrecipientrequest.md)] | :heavy_minus_sign: | N/A | -| `meta` | [Optional[models.DocumentCreateDocumentTemporaryMeta]](../../models/documentcreatedocumenttemporarymeta.md) | :heavy_minus_sign: | N/A | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | N/A | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response -**[models.DocumentCreateDocumentTemporaryResponse](../../models/documentcreatedocumenttemporaryresponse.md)** +**[models.DocumentDeleteResponse](../../models/documentdeleteresponse.md)** ### Errors -| Error Type | Status Code | Content Type | -| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| models.DocumentCreateDocumentTemporaryBadRequestError | 400 | application/json | -| models.DocumentCreateDocumentTemporaryInternalServerError | 500 | application/json | -| models.APIError | 4XX, 5XX | \*/\* | +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| models.DocumentDeleteBadRequestError | 400 | application/json | +| models.DocumentDeleteInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | -## delete +## duplicate -Delete document +Duplicate document ### Example Usage - + ```python from documenso_sdk import Documenso import os @@ -219,7 +211,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.delete(document_id=4054.62) + res = documenso.documents.duplicate(document_id=5285.3) # Handle response print(res) @@ -235,15 +227,15 @@ with Documenso( ### Response -**[models.DocumentDeleteDocumentResponse](../../models/documentdeletedocumentresponse.md)** +**[models.DocumentDuplicateResponse](../../models/documentduplicateresponse.md)** ### Errors -| Error Type | Status Code | Content Type | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| models.DocumentDeleteDocumentBadRequestError | 400 | application/json | -| models.DocumentDeleteDocumentInternalServerError | 500 | application/json | -| models.APIError | 4XX, 5XX | \*/\* | +| Error Type | Status Code | Content Type | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| models.DocumentDuplicateBadRequestError | 400 | application/json | +| models.DocumentDuplicateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | ## distribute @@ -251,7 +243,7 @@ Send the document out to recipients based on your distribution method ### Example Usage - + ```python from documenso_sdk import Documenso import os @@ -261,7 +253,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.distribute(document_id=7930.82) + res = documenso.documents.distribute(document_id=7548.74) # Handle response print(res) @@ -270,23 +262,23 @@ with Documenso( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `document_id` | *float* | :heavy_check_mark: | The ID of the document to send. | -| `meta` | [Optional[models.DocumentSendDocumentMeta]](../../models/documentsenddocumentmeta.md) | :heavy_minus_sign: | N/A | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | The ID of the document to send. | +| `meta` | [Optional[models.DocumentDistributeMeta]](../../models/documentdistributemeta.md) | :heavy_minus_sign: | N/A | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response -**[models.DocumentSendDocumentResponse](../../models/documentsenddocumentresponse.md)** +**[models.DocumentDistributeResponse](../../models/documentdistributeresponse.md)** ### Errors -| Error Type | Status Code | Content Type | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| models.DocumentSendDocumentBadRequestError | 400 | application/json | -| models.DocumentSendDocumentInternalServerError | 500 | application/json | -| models.APIError | 4XX, 5XX | \*/\* | +| Error Type | Status Code | Content Type | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| models.DocumentDistributeBadRequestError | 400 | application/json | +| models.DocumentDistributeInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | ## redistribute @@ -294,7 +286,7 @@ Redistribute the document to the provided recipients who have not actioned the d ### Example Usage - + ```python from documenso_sdk import Documenso import os @@ -304,7 +296,11 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.redistribute(document_id=2824.22, recipients=[]) + res = documenso.documents.redistribute(document_id=9084.69, recipients=[ + 6011.8, + 4441.56, + 4251.15, + ]) # Handle response print(res) @@ -321,23 +317,23 @@ with Documenso( ### Response -**[models.DocumentResendDocumentResponse](../../models/documentresenddocumentresponse.md)** +**[models.DocumentRedistributeResponse](../../models/documentredistributeresponse.md)** ### Errors -| Error Type | Status Code | Content Type | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| models.DocumentResendDocumentBadRequestError | 400 | application/json | -| models.DocumentResendDocumentInternalServerError | 500 | application/json | -| models.APIError | 4XX, 5XX | \*/\* | +| Error Type | Status Code | Content Type | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| models.DocumentRedistributeBadRequestError | 400 | application/json | +| models.DocumentRedistributeInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | -## duplicate +## create_v0 -Duplicate document +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. ### Example Usage - + ```python from documenso_sdk import Documenso import os @@ -347,7 +343,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.duplicate(document_id=309.05) + res = documenso.documents.create_v0(title="") # Handle response print(res) @@ -356,19 +352,27 @@ with Documenso( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `document_id` | *float* | :heavy_check_mark: | N/A | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| `title` | *str* | :heavy_check_mark: | The title of the document. | +| `external_id` | *Optional[str]* | :heavy_minus_sign: | The external ID of the document. | +| `visibility` | [Optional[models.DocumentCreateDocumentTemporaryVisibilityRequest]](../../models/documentcreatedocumenttemporaryvisibilityrequest.md) | :heavy_minus_sign: | The visibility of the document. | +| `global_access_auth` | List[[models.DocumentCreateDocumentTemporaryGlobalAccessAuthRequest](../../models/documentcreatedocumenttemporaryglobalaccessauthrequest.md)] | :heavy_minus_sign: | N/A | +| `global_action_auth` | List[[models.DocumentCreateDocumentTemporaryGlobalActionAuthRequest](../../models/documentcreatedocumenttemporaryglobalactionauthrequest.md)] | :heavy_minus_sign: | N/A | +| `form_values` | Dict[str, [models.FormValuesRequest](../../models/formvaluesrequest.md)] | :heavy_minus_sign: | N/A | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the folder to create the document in. If not provided, the document will be created in the root folder. | +| `recipients` | List[[models.DocumentCreateDocumentTemporaryRecipientRequest](../../models/documentcreatedocumenttemporaryrecipientrequest.md)] | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.DocumentCreateDocumentTemporaryMeta]](../../models/documentcreatedocumenttemporarymeta.md) | :heavy_minus_sign: | N/A | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response -**[models.DocumentDuplicateDocumentResponse](../../models/documentduplicatedocumentresponse.md)** +**[models.DocumentCreateDocumentTemporaryResponse](../../models/documentcreatedocumenttemporaryresponse.md)** ### Errors -| Error Type | Status Code | Content Type | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| models.DocumentDuplicateDocumentBadRequestError | 400 | application/json | -| models.DocumentDuplicateDocumentInternalServerError | 500 | application/json | -| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file +| Error Type | Status Code | Content Type | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| models.DocumentCreateDocumentTemporaryBadRequestError | 400 | application/json | +| models.DocumentCreateDocumentTemporaryInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/documentsdk/README.md b/docs/sdks/documentsdk/README.md new file mode 100644 index 0000000..91f95fc --- /dev/null +++ b/docs/sdks/documentsdk/README.md @@ -0,0 +1,53 @@ +# DocumentSDK +(*document*) + +## Overview + +### Available Operations + +* [document_download](#document_download) - Download document (beta) + +## document_download + +Get a pre-signed download URL for the original or signed version of a document + +### Example Usage + + +```python +import documenso_sdk +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.document.document_download(document_id=5396.97, version=documenso_sdk.Version.SIGNED) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | The ID of the document to download. | +| `version` | [Optional[models.Version]](../../models/version.md) | :heavy_minus_sign: | The version of the document to download. "signed" returns the completed document with signatures, "original" returns the original uploaded document. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | + +### Response + +**[models.DocumentDownloadResponse](../../models/documentdownloadresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | +| models.DocumentDownloadBadRequestError | 400 | application/json | +| models.DocumentDownloadNotFoundError | 404 | application/json | +| models.DocumentDownloadInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/templates/README.md b/docs/sdks/templates/README.md index 152e1ba..39b5410 100644 --- a/docs/sdks/templates/README.md +++ b/docs/sdks/templates/README.md @@ -255,14 +255,16 @@ with Documenso( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `template_id` | *float* | :heavy_check_mark: | N/A | -| `recipients` | List[[models.TemplateCreateDocumentFromTemplateRecipientRequest](../../models/templatecreatedocumentfromtemplaterecipientrequest.md)] | :heavy_check_mark: | The information of the recipients to create the document with. | -| `distribute_document` | *Optional[bool]* | :heavy_minus_sign: | Whether to create the document as pending and distribute it to recipients. | -| `custom_document_data_id` | *Optional[str]* | :heavy_minus_sign: | The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. | -| `prefill_fields` | List[[models.PrefillField](../../models/prefillfield.md)] | :heavy_minus_sign: | The fields to prefill on the document before sending it out. Useful when you want to create a document from an existing template and pre-fill the fields with specific values. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `template_id` | *float* | :heavy_check_mark: | N/A | +| `recipients` | List[[models.TemplateCreateDocumentFromTemplateRecipientRequest](../../models/templatecreatedocumentfromtemplaterecipientrequest.md)] | :heavy_check_mark: | The information of the recipients to create the document with. | +| `distribute_document` | *Optional[bool]* | :heavy_minus_sign: | Whether to create the document as pending and distribute it to recipients. | +| `custom_document_data_id` | *Optional[str]* | :heavy_minus_sign: | [DEPRECATED] - Use customDocumentData instead. The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. | +| `custom_document_data` | List[[models.CustomDocumentDatum](../../models/customdocumentdatum.md)] | :heavy_minus_sign: | The data IDs of alternative PDFs to use when creating the document. If not provided, the PDF attached to the template will be used. | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the folder to create the document in. If not provided, the document will be created in the root folder. | +| `prefill_fields` | List[[models.PrefillField](../../models/prefillfield.md)] | :heavy_minus_sign: | The fields to prefill on the document before sending it out. Useful when you want to create a document from an existing template and pre-fill the fields with specific values. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/templatesdk/README.md b/docs/sdks/templatesdk/README.md new file mode 100644 index 0000000..04b4837 --- /dev/null +++ b/docs/sdks/templatesdk/README.md @@ -0,0 +1,59 @@ +# TemplateSDK +(*template*) + +## Overview + +### Available Operations + +* [template_create_template_temporary](#template_create_template_temporary) - Create template + +## template_create_template_temporary + +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. + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.template.template_create_template_temporary(title="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| `title` | *str* | :heavy_check_mark: | The title of the document. | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.TemplateCreateTemplateTemporaryVisibilityRequest]](../../models/templatecreatetemplatetemporaryvisibilityrequest.md) | :heavy_minus_sign: | N/A | +| `global_access_auth` | List[[models.TemplateCreateTemplateTemporaryGlobalAccessAuthRequest](../../models/templatecreatetemplatetemporaryglobalaccessauthrequest.md)] | :heavy_minus_sign: | N/A | +| `global_action_auth` | List[[models.TemplateCreateTemplateTemporaryGlobalActionAuthRequest](../../models/templatecreatetemplatetemporaryglobalactionauthrequest.md)] | :heavy_minus_sign: | N/A | +| `public_title` | *Optional[str]* | :heavy_minus_sign: | The title of the template that will be displayed to the public. Only applicable for public templates. | +| `public_description` | *Optional[str]* | :heavy_minus_sign: | The description of the template that will be displayed to the public. Only applicable for public templates. | +| `type` | [Optional[models.TemplateCreateTemplateTemporaryTypeRequest]](../../models/templatecreatetemplatetemporarytyperequest.md) | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.TemplateCreateTemplateTemporaryMeta]](../../models/templatecreatetemplatetemporarymeta.md) | :heavy_minus_sign: | N/A | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | + +### Response + +**[models.TemplateCreateTemplateTemporaryResponse](../../models/templatecreatetemplatetemporaryresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| models.TemplateCreateTemplateTemporaryBadRequestError | 400 | application/json | +| models.TemplateCreateTemplateTemporaryInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 58f7cc4..5e29d57 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "documenso_sdk" -version = "0.3.0" +version = "0.4.0" description = "Python Client SDK Generated by Speakeasy." authors = [{ name = "Speakeasy" },] readme = "README-PYPI.md" @@ -35,7 +35,6 @@ build-backend = "poetry.core.masonry.api" [tool.pytest.ini_options] asyncio_default_fixture_loop_scope = "function" -asyncio_mode = "auto" pythonpath = ["src"] [tool.mypy] diff --git a/src/documenso_sdk/_version.py b/src/documenso_sdk/_version.py index 8b05148..79a69e4 100644 --- a/src/documenso_sdk/_version.py +++ b/src/documenso_sdk/_version.py @@ -3,10 +3,10 @@ import importlib.metadata __title__: str = "documenso_sdk" -__version__: str = "0.3.0" +__version__: str = "0.4.0" __openapi_doc_version__: str = "0.0.0" -__gen_version__: str = "2.687.13" -__user_agent__: str = "speakeasy-sdk/python 0.3.0 2.687.13 0.0.0 documenso_sdk" +__gen_version__: str = "2.743.2" +__user_agent__: str = "speakeasy-sdk/python 0.4.0 2.743.2 0.0.0 documenso_sdk" try: if __package__ is not None: diff --git a/src/documenso_sdk/directlink_sdk.py b/src/documenso_sdk/directlink_sdk.py index 8ab6e79..99e4cc2 100644 --- a/src/documenso_sdk/directlink_sdk.py +++ b/src/documenso_sdk/directlink_sdk.py @@ -82,7 +82,7 @@ def create( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-createTemplateDirectLink", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -192,7 +192,7 @@ async def create_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-createTemplateDirectLink", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -299,7 +299,7 @@ def delete( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-deleteTemplateDirectLink", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -406,7 +406,7 @@ async def delete_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-deleteTemplateDirectLink", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -516,7 +516,7 @@ def toggle( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-toggleTemplateDirectLink", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -626,7 +626,7 @@ async def toggle_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-toggleTemplateDirectLink", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), diff --git a/src/documenso_sdk/document_sdk.py b/src/documenso_sdk/document_sdk.py new file mode 100644 index 0000000..4ae5663 --- /dev/null +++ b/src/documenso_sdk/document_sdk.py @@ -0,0 +1,215 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from .basesdk import BaseSDK +from documenso_sdk import models, utils +from documenso_sdk._hooks import HookContext +from documenso_sdk.types import OptionalNullable, UNSET +from documenso_sdk.utils import get_security_from_env +from documenso_sdk.utils.unmarshal_json_response import unmarshal_json_response +from typing import Any, Mapping, Optional + + +class DocumentSDK(BaseSDK): + def document_download( + self, + *, + document_id: float, + version: Optional[models.Version] = models.Version.SIGNED, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.DocumentDownloadResponse: + r"""Download document (beta) + + Get a pre-signed download URL for the original or signed version of a document + + :param document_id: The ID of the document to download. + :param version: The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document. + :param retries: Override the default retry configuration for this method + :param server_url: Override the default server URL for this method + :param timeout_ms: Override the default request timeout configuration for this method in milliseconds + :param http_headers: Additional headers to set or replace on requests. + """ + base_url = None + url_variables = None + if timeout_ms is None: + timeout_ms = self.sdk_configuration.timeout_ms + + if server_url is not None: + base_url = server_url + else: + base_url = self._get_url(base_url, url_variables) + + request = models.DocumentDownloadRequest( + document_id=document_id, + version=version, + ) + + req = self._build_request( + method="GET", + path="/document/{documentId}/download-beta", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=False, + request_has_path_params=True, + request_has_query_params=True, + user_agent_header="user-agent", + accept_header_value="application/json", + http_headers=http_headers, + security=self.sdk_configuration.security, + timeout_ms=timeout_ms, + ) + + if retries == UNSET: + if self.sdk_configuration.retry_config is not UNSET: + retries = self.sdk_configuration.retry_config + + retry_config = None + if isinstance(retries, utils.RetryConfig): + retry_config = (retries, ["429", "500", "502", "503", "504"]) + + http_res = self.do_request( + hook_ctx=HookContext( + config=self.sdk_configuration, + base_url=base_url or "", + operation_id="document-download", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "404", "4XX", "500", "5XX"], + retry_config=retry_config, + ) + + response_data: Any = None + if utils.match_response(http_res, "200", "application/json"): + return unmarshal_json_response(models.DocumentDownloadResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBadRequestErrorData, http_res + ) + raise models.DocumentDownloadBadRequestError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadNotFoundErrorData, http_res + ) + raise models.DocumentDownloadNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadInternalServerErrorData, http_res + ) + raise models.DocumentDownloadInternalServerError(response_data, http_res) + if utils.match_response(http_res, "4XX", "*"): + http_res_text = utils.stream_to_text(http_res) + raise models.APIError("API error occurred", http_res, http_res_text) + if utils.match_response(http_res, "5XX", "*"): + http_res_text = utils.stream_to_text(http_res) + raise models.APIError("API error occurred", http_res, http_res_text) + + raise models.APIError("Unexpected response received", http_res) + + async def document_download_async( + self, + *, + document_id: float, + version: Optional[models.Version] = models.Version.SIGNED, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.DocumentDownloadResponse: + r"""Download document (beta) + + Get a pre-signed download URL for the original or signed version of a document + + :param document_id: The ID of the document to download. + :param version: The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document. + :param retries: Override the default retry configuration for this method + :param server_url: Override the default server URL for this method + :param timeout_ms: Override the default request timeout configuration for this method in milliseconds + :param http_headers: Additional headers to set or replace on requests. + """ + base_url = None + url_variables = None + if timeout_ms is None: + timeout_ms = self.sdk_configuration.timeout_ms + + if server_url is not None: + base_url = server_url + else: + base_url = self._get_url(base_url, url_variables) + + request = models.DocumentDownloadRequest( + document_id=document_id, + version=version, + ) + + req = self._build_request_async( + method="GET", + path="/document/{documentId}/download-beta", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=False, + request_has_path_params=True, + request_has_query_params=True, + user_agent_header="user-agent", + accept_header_value="application/json", + http_headers=http_headers, + security=self.sdk_configuration.security, + timeout_ms=timeout_ms, + ) + + if retries == UNSET: + if self.sdk_configuration.retry_config is not UNSET: + retries = self.sdk_configuration.retry_config + + retry_config = None + if isinstance(retries, utils.RetryConfig): + retry_config = (retries, ["429", "500", "502", "503", "504"]) + + http_res = await self.do_request_async( + hook_ctx=HookContext( + config=self.sdk_configuration, + base_url=base_url or "", + operation_id="document-download", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "404", "4XX", "500", "5XX"], + retry_config=retry_config, + ) + + response_data: Any = None + if utils.match_response(http_res, "200", "application/json"): + return unmarshal_json_response(models.DocumentDownloadResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBadRequestErrorData, http_res + ) + raise models.DocumentDownloadBadRequestError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadNotFoundErrorData, http_res + ) + raise models.DocumentDownloadNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadInternalServerErrorData, http_res + ) + raise models.DocumentDownloadInternalServerError(response_data, http_res) + if utils.match_response(http_res, "4XX", "*"): + http_res_text = await utils.stream_to_text_async(http_res) + raise models.APIError("API error occurred", http_res, http_res_text) + if utils.match_response(http_res, "5XX", "*"): + http_res_text = await utils.stream_to_text_async(http_res) + raise models.APIError("API error occurred", http_res, http_res_text) + + raise models.APIError("Unexpected response received", http_res) diff --git a/src/documenso_sdk/documents.py b/src/documenso_sdk/documents.py index fe50fb8..d50df7e 100644 --- a/src/documenso_sdk/documents.py +++ b/src/documenso_sdk/documents.py @@ -31,32 +31,20 @@ def _init_sdks(self): self.sdk_configuration, parent_ref=self.parent_ref ) - def update( + def get( self, *, document_id: float, - data: Optional[ - Union[ - models.DocumentUpdateDocumentData, - models.DocumentUpdateDocumentDataTypedDict, - ] - ] = None, - meta: Optional[ - Union[ - models.DocumentUpdateDocumentMeta, - models.DocumentUpdateDocumentMetaTypedDict, - ] - ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentUpdateDocumentResponse: - r"""Update document + ) -> models.DocumentGetResponse: + r"""Get document + + Returns a document given an ID :param document_id: - :param data: - :param meta: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -72,32 +60,23 @@ def update( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentUpdateDocumentRequest( + request = models.DocumentGetRequest( document_id=document_id, - data=utils.get_pydantic_model( - data, Optional[models.DocumentUpdateDocumentData] - ), - meta=utils.get_pydantic_model( - meta, Optional[models.DocumentUpdateDocumentMeta] - ), ) req = self._build_request( - method="POST", - path="/document/update", + method="GET", + path="/document/{documentId}", base_url=base_url, url_variables=url_variables, request=request, - request_body_required=True, - request_has_path_params=False, + request_body_required=False, + request_has_path_params=True, request_has_query_params=True, user_agent_header="user-agent", accept_header_value="application/json", http_headers=http_headers, security=self.sdk_configuration.security, - get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.DocumentUpdateDocumentRequest - ), timeout_ms=timeout_ms, ) @@ -113,34 +92,35 @@ def update( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-updateDocument", - oauth2_scopes=[], + operation_id="document-get", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentUpdateDocumentResponse, http_res - ) + return unmarshal_json_response(models.DocumentGetResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentUpdateDocumentBadRequestErrorData, http_res + models.DocumentGetBadRequestErrorData, http_res ) - raise models.DocumentUpdateDocumentBadRequestError(response_data, http_res) - if utils.match_response(http_res, "500", "application/json"): + raise models.DocumentGetBadRequestError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( - models.DocumentUpdateDocumentInternalServerErrorData, http_res + models.DocumentGetNotFoundErrorData, http_res ) - raise models.DocumentUpdateDocumentInternalServerError( - response_data, http_res + raise models.DocumentGetNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentGetInternalServerErrorData, http_res ) + raise models.DocumentGetInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = utils.stream_to_text(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -150,32 +130,20 @@ def update( raise models.APIError("Unexpected response received", http_res) - async def update_async( + async def get_async( self, *, document_id: float, - data: Optional[ - Union[ - models.DocumentUpdateDocumentData, - models.DocumentUpdateDocumentDataTypedDict, - ] - ] = None, - meta: Optional[ - Union[ - models.DocumentUpdateDocumentMeta, - models.DocumentUpdateDocumentMetaTypedDict, - ] - ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentUpdateDocumentResponse: - r"""Update document + ) -> models.DocumentGetResponse: + r"""Get document + + Returns a document given an ID :param document_id: - :param data: - :param meta: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -191,32 +159,23 @@ async def update_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentUpdateDocumentRequest( + request = models.DocumentGetRequest( document_id=document_id, - data=utils.get_pydantic_model( - data, Optional[models.DocumentUpdateDocumentData] - ), - meta=utils.get_pydantic_model( - meta, Optional[models.DocumentUpdateDocumentMeta] - ), ) req = self._build_request_async( - method="POST", - path="/document/update", + method="GET", + path="/document/{documentId}", base_url=base_url, url_variables=url_variables, request=request, - request_body_required=True, - request_has_path_params=False, + request_body_required=False, + request_has_path_params=True, request_has_query_params=True, user_agent_header="user-agent", accept_header_value="application/json", http_headers=http_headers, security=self.sdk_configuration.security, - get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.DocumentUpdateDocumentRequest - ), timeout_ms=timeout_ms, ) @@ -232,34 +191,35 @@ async def update_async( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-updateDocument", - oauth2_scopes=[], + operation_id="document-get", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentUpdateDocumentResponse, http_res - ) + return unmarshal_json_response(models.DocumentGetResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentUpdateDocumentBadRequestErrorData, http_res + models.DocumentGetBadRequestErrorData, http_res ) - raise models.DocumentUpdateDocumentBadRequestError(response_data, http_res) - if utils.match_response(http_res, "500", "application/json"): + raise models.DocumentGetBadRequestError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( - models.DocumentUpdateDocumentInternalServerErrorData, http_res + models.DocumentGetNotFoundErrorData, http_res ) - raise models.DocumentUpdateDocumentInternalServerError( - response_data, http_res + raise models.DocumentGetNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentGetInternalServerErrorData, http_res ) + raise models.DocumentGetInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = await utils.stream_to_text_async(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -287,7 +247,7 @@ def find( server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentFindDocumentsResponse: + ) -> models.DocumentFindResponse: r"""Find documents Find documents based on a search criteria @@ -316,7 +276,7 @@ def find( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentFindDocumentsRequest( + request = models.DocumentFindRequest( query=query, page=page, per_page=per_page, @@ -356,8 +316,8 @@ def find( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-findDocuments", - oauth2_scopes=[], + operation_id="document-find", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -369,26 +329,22 @@ def find( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentFindDocumentsResponse, http_res - ) + return unmarshal_json_response(models.DocumentFindResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentFindDocumentsBadRequestErrorData, http_res + models.DocumentFindBadRequestErrorData, http_res ) - raise models.DocumentFindDocumentsBadRequestError(response_data, http_res) + raise models.DocumentFindBadRequestError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( - models.DocumentFindDocumentsNotFoundErrorData, http_res + models.DocumentFindNotFoundErrorData, http_res ) - raise models.DocumentFindDocumentsNotFoundError(response_data, http_res) + raise models.DocumentFindNotFoundError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentFindDocumentsInternalServerErrorData, http_res - ) - raise models.DocumentFindDocumentsInternalServerError( - response_data, http_res + models.DocumentFindInternalServerErrorData, http_res ) + raise models.DocumentFindInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = utils.stream_to_text(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -416,7 +372,7 @@ async def find_async( server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentFindDocumentsResponse: + ) -> models.DocumentFindResponse: r"""Find documents Find documents based on a search criteria @@ -445,7 +401,7 @@ async def find_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentFindDocumentsRequest( + request = models.DocumentFindRequest( query=query, page=page, per_page=per_page, @@ -485,8 +441,8 @@ async def find_async( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-findDocuments", - oauth2_scopes=[], + operation_id="document-find", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -498,26 +454,22 @@ async def find_async( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentFindDocumentsResponse, http_res - ) + return unmarshal_json_response(models.DocumentFindResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentFindDocumentsBadRequestErrorData, http_res + models.DocumentFindBadRequestErrorData, http_res ) - raise models.DocumentFindDocumentsBadRequestError(response_data, http_res) + raise models.DocumentFindBadRequestError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( - models.DocumentFindDocumentsNotFoundErrorData, http_res + models.DocumentFindNotFoundErrorData, http_res ) - raise models.DocumentFindDocumentsNotFoundError(response_data, http_res) + raise models.DocumentFindNotFoundError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentFindDocumentsInternalServerErrorData, http_res - ) - raise models.DocumentFindDocumentsInternalServerError( - response_data, http_res + models.DocumentFindInternalServerErrorData, http_res ) + raise models.DocumentFindInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = await utils.stream_to_text_async(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -527,22 +479,26 @@ async def find_async( raise models.APIError("Unexpected response received", http_res) - def get( + def update( self, *, document_id: float, - folder_id: Optional[str] = None, + data: Optional[ + Union[models.DocumentUpdateData, models.DocumentUpdateDataTypedDict] + ] = None, + meta: Optional[ + Union[models.DocumentUpdateMeta, models.DocumentUpdateMetaTypedDict] + ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentGetDocumentWithDetailsByIDResponse: - r"""Get document - - Returns a document given an ID + ) -> models.DocumentUpdateResponse: + r"""Update document :param document_id: - :param folder_id: Filter documents by folder ID + :param data: + :param meta: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -558,24 +514,28 @@ def get( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentGetDocumentWithDetailsByIDRequest( + request = models.DocumentUpdateRequest( document_id=document_id, - folder_id=folder_id, + data=utils.get_pydantic_model(data, Optional[models.DocumentUpdateData]), + meta=utils.get_pydantic_model(meta, Optional[models.DocumentUpdateMeta]), ) req = self._build_request( - method="GET", - path="/document/{documentId}", + method="POST", + path="/document/update", base_url=base_url, url_variables=url_variables, request=request, - request_body_required=False, - request_has_path_params=True, + request_body_required=True, + request_has_path_params=False, request_has_query_params=True, user_agent_header="user-agent", accept_header_value="application/json", http_headers=http_headers, security=self.sdk_configuration.security, + get_serialized_body=lambda: utils.serialize_request_body( + request, False, False, "json", models.DocumentUpdateRequest + ), timeout_ms=timeout_ms, ) @@ -591,44 +551,30 @@ def get( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-getDocumentWithDetailsById", - oauth2_scopes=[], + operation_id="document-update", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "4XX", "500", "5XX"], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentGetDocumentWithDetailsByIDResponse, http_res - ) + return unmarshal_json_response(models.DocumentUpdateResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentGetDocumentWithDetailsByIDBadRequestErrorData, http_res - ) - raise models.DocumentGetDocumentWithDetailsByIDBadRequestError( - response_data, http_res - ) - if utils.match_response(http_res, "404", "application/json"): - response_data = unmarshal_json_response( - models.DocumentGetDocumentWithDetailsByIDNotFoundErrorData, http_res - ) - raise models.DocumentGetDocumentWithDetailsByIDNotFoundError( - response_data, http_res + models.DocumentUpdateBadRequestErrorData, http_res ) + raise models.DocumentUpdateBadRequestError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentGetDocumentWithDetailsByIDInternalServerErrorData, - http_res, - ) - raise models.DocumentGetDocumentWithDetailsByIDInternalServerError( - response_data, http_res + models.DocumentUpdateInternalServerErrorData, http_res ) + raise models.DocumentUpdateInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = utils.stream_to_text(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -638,22 +584,26 @@ def get( raise models.APIError("Unexpected response received", http_res) - async def get_async( + async def update_async( self, *, document_id: float, - folder_id: Optional[str] = None, + data: Optional[ + Union[models.DocumentUpdateData, models.DocumentUpdateDataTypedDict] + ] = None, + meta: Optional[ + Union[models.DocumentUpdateMeta, models.DocumentUpdateMetaTypedDict] + ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentGetDocumentWithDetailsByIDResponse: - r"""Get document - - Returns a document given an ID + ) -> models.DocumentUpdateResponse: + r"""Update document :param document_id: - :param folder_id: Filter documents by folder ID + :param data: + :param meta: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -669,24 +619,28 @@ async def get_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentGetDocumentWithDetailsByIDRequest( + request = models.DocumentUpdateRequest( document_id=document_id, - folder_id=folder_id, + data=utils.get_pydantic_model(data, Optional[models.DocumentUpdateData]), + meta=utils.get_pydantic_model(meta, Optional[models.DocumentUpdateMeta]), ) req = self._build_request_async( - method="GET", - path="/document/{documentId}", + method="POST", + path="/document/update", base_url=base_url, url_variables=url_variables, request=request, - request_body_required=False, - request_has_path_params=True, + request_body_required=True, + request_has_path_params=False, request_has_query_params=True, user_agent_header="user-agent", accept_header_value="application/json", http_headers=http_headers, security=self.sdk_configuration.security, + get_serialized_body=lambda: utils.serialize_request_body( + request, False, False, "json", models.DocumentUpdateRequest + ), timeout_ms=timeout_ms, ) @@ -702,44 +656,30 @@ async def get_async( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-getDocumentWithDetailsById", - oauth2_scopes=[], + operation_id="document-update", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "4XX", "500", "5XX"], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentGetDocumentWithDetailsByIDResponse, http_res - ) + return unmarshal_json_response(models.DocumentUpdateResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentGetDocumentWithDetailsByIDBadRequestErrorData, http_res - ) - raise models.DocumentGetDocumentWithDetailsByIDBadRequestError( - response_data, http_res - ) - if utils.match_response(http_res, "404", "application/json"): - response_data = unmarshal_json_response( - models.DocumentGetDocumentWithDetailsByIDNotFoundErrorData, http_res - ) - raise models.DocumentGetDocumentWithDetailsByIDNotFoundError( - response_data, http_res + models.DocumentUpdateBadRequestErrorData, http_res ) + raise models.DocumentUpdateBadRequestError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentGetDocumentWithDetailsByIDInternalServerErrorData, - http_res, - ) - raise models.DocumentGetDocumentWithDetailsByIDInternalServerError( - response_data, http_res + models.DocumentUpdateInternalServerErrorData, http_res ) + raise models.DocumentUpdateInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = await utils.stream_to_text_async(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -749,55 +689,18 @@ async def get_async( raise models.APIError("Unexpected response received", http_res) - def create_v0( + def delete( self, *, - title: str, - external_id: Optional[str] = None, - visibility: Optional[ - models.DocumentCreateDocumentTemporaryVisibilityRequest - ] = None, - global_access_auth: Optional[ - List[models.DocumentCreateDocumentTemporaryGlobalAccessAuthRequest] - ] = None, - global_action_auth: Optional[ - List[models.DocumentCreateDocumentTemporaryGlobalActionAuthRequest] - ] = None, - form_values: Optional[ - Union[ - Dict[str, models.FormValuesRequest], - Dict[str, models.FormValuesRequestTypedDict], - ] - ] = None, - recipients: Optional[ - Union[ - List[models.DocumentCreateDocumentTemporaryRecipientRequest], - List[models.DocumentCreateDocumentTemporaryRecipientRequestTypedDict], - ] - ] = None, - meta: Optional[ - Union[ - models.DocumentCreateDocumentTemporaryMeta, - models.DocumentCreateDocumentTemporaryMetaTypedDict, - ] - ] = None, + document_id: float, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentCreateDocumentTemporaryResponse: - r"""Create document - - 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. + ) -> models.DocumentDeleteResponse: + r"""Delete document - :param title: The title of the document. - :param external_id: The external ID of the document. - :param visibility: The visibility of the document. - :param global_access_auth: - :param global_action_auth: - :param form_values: - :param recipients: - :param meta: + :param document_id: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -813,25 +716,13 @@ def create_v0( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentCreateDocumentTemporaryRequest( - title=title, - external_id=external_id, - visibility=visibility, - global_access_auth=global_access_auth, - global_action_auth=global_action_auth, - form_values=form_values, - recipients=utils.get_pydantic_model( - recipients, - Optional[List[models.DocumentCreateDocumentTemporaryRecipientRequest]], - ), - meta=utils.get_pydantic_model( - meta, Optional[models.DocumentCreateDocumentTemporaryMeta] - ), + request = models.DocumentDeleteRequest( + document_id=document_id, ) req = self._build_request( method="POST", - path="/document/create/beta", + path="/document/delete", base_url=base_url, url_variables=url_variables, request=request, @@ -843,11 +734,7 @@ def create_v0( http_headers=http_headers, security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, - False, - False, - "json", - models.DocumentCreateDocumentTemporaryRequest, + request, False, False, "json", models.DocumentDeleteRequest ), timeout_ms=timeout_ms, ) @@ -864,8 +751,8 @@ def create_v0( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-createDocumentTemporary", - oauth2_scopes=[], + operation_id="document-delete", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -877,23 +764,17 @@ def create_v0( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentCreateDocumentTemporaryResponse, http_res - ) + return unmarshal_json_response(models.DocumentDeleteResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentCreateDocumentTemporaryBadRequestErrorData, http_res - ) - raise models.DocumentCreateDocumentTemporaryBadRequestError( - response_data, http_res + models.DocumentDeleteBadRequestErrorData, http_res ) + raise models.DocumentDeleteBadRequestError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentCreateDocumentTemporaryInternalServerErrorData, http_res - ) - raise models.DocumentCreateDocumentTemporaryInternalServerError( - response_data, http_res + models.DocumentDeleteInternalServerErrorData, http_res ) + raise models.DocumentDeleteInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = utils.stream_to_text(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -903,55 +784,18 @@ def create_v0( raise models.APIError("Unexpected response received", http_res) - async def create_v0_async( + async def delete_async( self, *, - title: str, - external_id: Optional[str] = None, - visibility: Optional[ - models.DocumentCreateDocumentTemporaryVisibilityRequest - ] = None, - global_access_auth: Optional[ - List[models.DocumentCreateDocumentTemporaryGlobalAccessAuthRequest] - ] = None, - global_action_auth: Optional[ - List[models.DocumentCreateDocumentTemporaryGlobalActionAuthRequest] - ] = None, - form_values: Optional[ - Union[ - Dict[str, models.FormValuesRequest], - Dict[str, models.FormValuesRequestTypedDict], - ] - ] = None, - recipients: Optional[ - Union[ - List[models.DocumentCreateDocumentTemporaryRecipientRequest], - List[models.DocumentCreateDocumentTemporaryRecipientRequestTypedDict], - ] - ] = None, - meta: Optional[ - Union[ - models.DocumentCreateDocumentTemporaryMeta, - models.DocumentCreateDocumentTemporaryMetaTypedDict, - ] - ] = None, + document_id: float, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentCreateDocumentTemporaryResponse: - r"""Create document - - 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. + ) -> models.DocumentDeleteResponse: + r"""Delete document - :param title: The title of the document. - :param external_id: The external ID of the document. - :param visibility: The visibility of the document. - :param global_access_auth: - :param global_action_auth: - :param form_values: - :param recipients: - :param meta: + :param document_id: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -967,25 +811,13 @@ async def create_v0_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentCreateDocumentTemporaryRequest( - title=title, - external_id=external_id, - visibility=visibility, - global_access_auth=global_access_auth, - global_action_auth=global_action_auth, - form_values=form_values, - recipients=utils.get_pydantic_model( - recipients, - Optional[List[models.DocumentCreateDocumentTemporaryRecipientRequest]], - ), - meta=utils.get_pydantic_model( - meta, Optional[models.DocumentCreateDocumentTemporaryMeta] - ), + request = models.DocumentDeleteRequest( + document_id=document_id, ) req = self._build_request_async( method="POST", - path="/document/create/beta", + path="/document/delete", base_url=base_url, url_variables=url_variables, request=request, @@ -997,11 +829,7 @@ async def create_v0_async( http_headers=http_headers, security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, - False, - False, - "json", - models.DocumentCreateDocumentTemporaryRequest, + request, False, False, "json", models.DocumentDeleteRequest ), timeout_ms=timeout_ms, ) @@ -1018,8 +846,8 @@ async def create_v0_async( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-createDocumentTemporary", - oauth2_scopes=[], + operation_id="document-delete", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1031,23 +859,17 @@ async def create_v0_async( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentCreateDocumentTemporaryResponse, http_res - ) + return unmarshal_json_response(models.DocumentDeleteResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentCreateDocumentTemporaryBadRequestErrorData, http_res - ) - raise models.DocumentCreateDocumentTemporaryBadRequestError( - response_data, http_res + models.DocumentDeleteBadRequestErrorData, http_res ) + raise models.DocumentDeleteBadRequestError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentCreateDocumentTemporaryInternalServerErrorData, http_res - ) - raise models.DocumentCreateDocumentTemporaryInternalServerError( - response_data, http_res + models.DocumentDeleteInternalServerErrorData, http_res ) + raise models.DocumentDeleteInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = await utils.stream_to_text_async(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -1057,7 +879,7 @@ async def create_v0_async( raise models.APIError("Unexpected response received", http_res) - def delete( + def duplicate( self, *, document_id: float, @@ -1065,8 +887,8 @@ def delete( server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentDeleteDocumentResponse: - r"""Delete document + ) -> models.DocumentDuplicateResponse: + r"""Duplicate document :param document_id: :param retries: Override the default retry configuration for this method @@ -1084,13 +906,13 @@ def delete( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentDeleteDocumentRequest( + request = models.DocumentDuplicateRequest( document_id=document_id, ) req = self._build_request( method="POST", - path="/document/delete", + path="/document/duplicate", base_url=base_url, url_variables=url_variables, request=request, @@ -1102,7 +924,7 @@ def delete( http_headers=http_headers, security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.DocumentDeleteDocumentRequest + request, False, False, "json", models.DocumentDuplicateRequest ), timeout_ms=timeout_ms, ) @@ -1119,8 +941,8 @@ def delete( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-deleteDocument", - oauth2_scopes=[], + operation_id="document-duplicate", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1132,21 +954,17 @@ def delete( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentDeleteDocumentResponse, http_res - ) + return unmarshal_json_response(models.DocumentDuplicateResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentDeleteDocumentBadRequestErrorData, http_res + models.DocumentDuplicateBadRequestErrorData, http_res ) - raise models.DocumentDeleteDocumentBadRequestError(response_data, http_res) + raise models.DocumentDuplicateBadRequestError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentDeleteDocumentInternalServerErrorData, http_res - ) - raise models.DocumentDeleteDocumentInternalServerError( - response_data, http_res + models.DocumentDuplicateInternalServerErrorData, http_res ) + raise models.DocumentDuplicateInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = utils.stream_to_text(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -1156,7 +974,7 @@ def delete( raise models.APIError("Unexpected response received", http_res) - async def delete_async( + async def duplicate_async( self, *, document_id: float, @@ -1164,8 +982,8 @@ async def delete_async( server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentDeleteDocumentResponse: - r"""Delete document + ) -> models.DocumentDuplicateResponse: + r"""Duplicate document :param document_id: :param retries: Override the default retry configuration for this method @@ -1183,13 +1001,13 @@ async def delete_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentDeleteDocumentRequest( + request = models.DocumentDuplicateRequest( document_id=document_id, ) req = self._build_request_async( method="POST", - path="/document/delete", + path="/document/duplicate", base_url=base_url, url_variables=url_variables, request=request, @@ -1201,7 +1019,7 @@ async def delete_async( http_headers=http_headers, security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.DocumentDeleteDocumentRequest + request, False, False, "json", models.DocumentDuplicateRequest ), timeout_ms=timeout_ms, ) @@ -1218,8 +1036,8 @@ async def delete_async( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-deleteDocument", - oauth2_scopes=[], + operation_id="document-duplicate", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1231,21 +1049,17 @@ async def delete_async( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentDeleteDocumentResponse, http_res - ) + return unmarshal_json_response(models.DocumentDuplicateResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentDeleteDocumentBadRequestErrorData, http_res + models.DocumentDuplicateBadRequestErrorData, http_res ) - raise models.DocumentDeleteDocumentBadRequestError(response_data, http_res) + raise models.DocumentDuplicateBadRequestError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentDeleteDocumentInternalServerErrorData, http_res - ) - raise models.DocumentDeleteDocumentInternalServerError( - response_data, http_res + models.DocumentDuplicateInternalServerErrorData, http_res ) + raise models.DocumentDuplicateInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = await utils.stream_to_text_async(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -1260,16 +1074,13 @@ def distribute( *, document_id: float, meta: Optional[ - Union[ - models.DocumentSendDocumentMeta, - models.DocumentSendDocumentMetaTypedDict, - ] + Union[models.DocumentDistributeMeta, models.DocumentDistributeMetaTypedDict] ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentSendDocumentResponse: + ) -> models.DocumentDistributeResponse: r"""Distribute document Send the document out to recipients based on your distribution method @@ -1291,10 +1102,10 @@ def distribute( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentSendDocumentRequest( + request = models.DocumentDistributeRequest( document_id=document_id, meta=utils.get_pydantic_model( - meta, Optional[models.DocumentSendDocumentMeta] + meta, Optional[models.DocumentDistributeMeta] ), ) @@ -1312,7 +1123,7 @@ def distribute( http_headers=http_headers, security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.DocumentSendDocumentRequest + request, False, False, "json", models.DocumentDistributeRequest ), timeout_ms=timeout_ms, ) @@ -1329,8 +1140,8 @@ def distribute( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-sendDocument", - oauth2_scopes=[], + operation_id="document-distribute", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1342,21 +1153,17 @@ def distribute( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentSendDocumentResponse, http_res - ) + return unmarshal_json_response(models.DocumentDistributeResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentSendDocumentBadRequestErrorData, http_res + models.DocumentDistributeBadRequestErrorData, http_res ) - raise models.DocumentSendDocumentBadRequestError(response_data, http_res) + raise models.DocumentDistributeBadRequestError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentSendDocumentInternalServerErrorData, http_res - ) - raise models.DocumentSendDocumentInternalServerError( - response_data, http_res + models.DocumentDistributeInternalServerErrorData, http_res ) + raise models.DocumentDistributeInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = utils.stream_to_text(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -1371,16 +1178,13 @@ async def distribute_async( *, document_id: float, meta: Optional[ - Union[ - models.DocumentSendDocumentMeta, - models.DocumentSendDocumentMetaTypedDict, - ] + Union[models.DocumentDistributeMeta, models.DocumentDistributeMetaTypedDict] ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentSendDocumentResponse: + ) -> models.DocumentDistributeResponse: r"""Distribute document Send the document out to recipients based on your distribution method @@ -1402,10 +1206,10 @@ async def distribute_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentSendDocumentRequest( + request = models.DocumentDistributeRequest( document_id=document_id, meta=utils.get_pydantic_model( - meta, Optional[models.DocumentSendDocumentMeta] + meta, Optional[models.DocumentDistributeMeta] ), ) @@ -1423,7 +1227,7 @@ async def distribute_async( http_headers=http_headers, security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.DocumentSendDocumentRequest + request, False, False, "json", models.DocumentDistributeRequest ), timeout_ms=timeout_ms, ) @@ -1440,8 +1244,8 @@ async def distribute_async( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-sendDocument", - oauth2_scopes=[], + operation_id="document-distribute", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1453,21 +1257,17 @@ async def distribute_async( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): - return unmarshal_json_response( - models.DocumentSendDocumentResponse, http_res - ) + return unmarshal_json_response(models.DocumentDistributeResponse, http_res) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentSendDocumentBadRequestErrorData, http_res + models.DocumentDistributeBadRequestErrorData, http_res ) - raise models.DocumentSendDocumentBadRequestError(response_data, http_res) + raise models.DocumentDistributeBadRequestError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentSendDocumentInternalServerErrorData, http_res - ) - raise models.DocumentSendDocumentInternalServerError( - response_data, http_res + models.DocumentDistributeInternalServerErrorData, http_res ) + raise models.DocumentDistributeInternalServerError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = await utils.stream_to_text_async(http_res) raise models.APIError("API error occurred", http_res, http_res_text) @@ -1486,7 +1286,7 @@ def redistribute( server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentResendDocumentResponse: + ) -> models.DocumentRedistributeResponse: r"""Redistribute document Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document @@ -1508,7 +1308,7 @@ def redistribute( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentResendDocumentRequest( + request = models.DocumentRedistributeRequest( document_id=document_id, recipients=recipients, ) @@ -1527,7 +1327,7 @@ def redistribute( http_headers=http_headers, security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.DocumentResendDocumentRequest + request, False, False, "json", models.DocumentRedistributeRequest ), timeout_ms=timeout_ms, ) @@ -1544,8 +1344,8 @@ def redistribute( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-resendDocument", - oauth2_scopes=[], + operation_id="document-redistribute", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1558,18 +1358,18 @@ def redistribute( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response( - models.DocumentResendDocumentResponse, http_res + models.DocumentRedistributeResponse, http_res ) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentResendDocumentBadRequestErrorData, http_res + models.DocumentRedistributeBadRequestErrorData, http_res ) - raise models.DocumentResendDocumentBadRequestError(response_data, http_res) + raise models.DocumentRedistributeBadRequestError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentResendDocumentInternalServerErrorData, http_res + models.DocumentRedistributeInternalServerErrorData, http_res ) - raise models.DocumentResendDocumentInternalServerError( + raise models.DocumentRedistributeInternalServerError( response_data, http_res ) if utils.match_response(http_res, "4XX", "*"): @@ -1590,7 +1390,7 @@ async def redistribute_async( server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentResendDocumentResponse: + ) -> models.DocumentRedistributeResponse: r"""Redistribute document Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document @@ -1612,7 +1412,7 @@ async def redistribute_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentResendDocumentRequest( + request = models.DocumentRedistributeRequest( document_id=document_id, recipients=recipients, ) @@ -1631,7 +1431,7 @@ async def redistribute_async( http_headers=http_headers, security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.DocumentResendDocumentRequest + request, False, False, "json", models.DocumentRedistributeRequest ), timeout_ms=timeout_ms, ) @@ -1648,8 +1448,8 @@ async def redistribute_async( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-resendDocument", - oauth2_scopes=[], + operation_id="document-redistribute", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1662,18 +1462,18 @@ async def redistribute_async( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response( - models.DocumentResendDocumentResponse, http_res + models.DocumentRedistributeResponse, http_res ) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentResendDocumentBadRequestErrorData, http_res + models.DocumentRedistributeBadRequestErrorData, http_res ) - raise models.DocumentResendDocumentBadRequestError(response_data, http_res) + raise models.DocumentRedistributeBadRequestError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentResendDocumentInternalServerErrorData, http_res + models.DocumentRedistributeInternalServerErrorData, http_res ) - raise models.DocumentResendDocumentInternalServerError( + raise models.DocumentRedistributeInternalServerError( response_data, http_res ) if utils.match_response(http_res, "4XX", "*"): @@ -1685,18 +1485,57 @@ async def redistribute_async( raise models.APIError("Unexpected response received", http_res) - def duplicate( + def create_v0( self, *, - document_id: float, + title: str, + external_id: Optional[str] = None, + visibility: Optional[ + models.DocumentCreateDocumentTemporaryVisibilityRequest + ] = None, + global_access_auth: Optional[ + List[models.DocumentCreateDocumentTemporaryGlobalAccessAuthRequest] + ] = None, + global_action_auth: Optional[ + List[models.DocumentCreateDocumentTemporaryGlobalActionAuthRequest] + ] = None, + form_values: Optional[ + Union[ + Dict[str, models.FormValuesRequest], + Dict[str, models.FormValuesRequestTypedDict], + ] + ] = None, + folder_id: Optional[str] = None, + recipients: Optional[ + Union[ + List[models.DocumentCreateDocumentTemporaryRecipientRequest], + List[models.DocumentCreateDocumentTemporaryRecipientRequestTypedDict], + ] + ] = None, + meta: Optional[ + Union[ + models.DocumentCreateDocumentTemporaryMeta, + models.DocumentCreateDocumentTemporaryMetaTypedDict, + ] + ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentDuplicateDocumentResponse: - r"""Duplicate document + ) -> models.DocumentCreateDocumentTemporaryResponse: + r"""Create document - :param document_id: + 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. + + :param title: The title of the document. + :param external_id: The external ID of the document. + :param visibility: The visibility of the document. + :param global_access_auth: + :param global_action_auth: + :param form_values: + :param folder_id: The ID of the folder to create the document in. If not provided, the document will be created in the root folder. + :param recipients: + :param meta: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -1712,13 +1551,26 @@ def duplicate( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentDuplicateDocumentRequest( - document_id=document_id, + request = models.DocumentCreateDocumentTemporaryRequest( + title=title, + external_id=external_id, + visibility=visibility, + global_access_auth=global_access_auth, + global_action_auth=global_action_auth, + form_values=form_values, + folder_id=folder_id, + recipients=utils.get_pydantic_model( + recipients, + Optional[List[models.DocumentCreateDocumentTemporaryRecipientRequest]], + ), + meta=utils.get_pydantic_model( + meta, Optional[models.DocumentCreateDocumentTemporaryMeta] + ), ) req = self._build_request( method="POST", - path="/document/duplicate", + path="/document/create/beta", base_url=base_url, url_variables=url_variables, request=request, @@ -1730,7 +1582,11 @@ def duplicate( http_headers=http_headers, security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.DocumentDuplicateDocumentRequest + request, + False, + False, + "json", + models.DocumentCreateDocumentTemporaryRequest, ), timeout_ms=timeout_ms, ) @@ -1747,8 +1603,8 @@ def duplicate( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-duplicateDocument", - oauth2_scopes=[], + operation_id="document-createDocumentTemporary", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1761,20 +1617,20 @@ def duplicate( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response( - models.DocumentDuplicateDocumentResponse, http_res + models.DocumentCreateDocumentTemporaryResponse, http_res ) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentDuplicateDocumentBadRequestErrorData, http_res + models.DocumentCreateDocumentTemporaryBadRequestErrorData, http_res ) - raise models.DocumentDuplicateDocumentBadRequestError( + raise models.DocumentCreateDocumentTemporaryBadRequestError( response_data, http_res ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentDuplicateDocumentInternalServerErrorData, http_res + models.DocumentCreateDocumentTemporaryInternalServerErrorData, http_res ) - raise models.DocumentDuplicateDocumentInternalServerError( + raise models.DocumentCreateDocumentTemporaryInternalServerError( response_data, http_res ) if utils.match_response(http_res, "4XX", "*"): @@ -1786,18 +1642,57 @@ def duplicate( raise models.APIError("Unexpected response received", http_res) - async def duplicate_async( + async def create_v0_async( self, *, - document_id: float, + title: str, + external_id: Optional[str] = None, + visibility: Optional[ + models.DocumentCreateDocumentTemporaryVisibilityRequest + ] = None, + global_access_auth: Optional[ + List[models.DocumentCreateDocumentTemporaryGlobalAccessAuthRequest] + ] = None, + global_action_auth: Optional[ + List[models.DocumentCreateDocumentTemporaryGlobalActionAuthRequest] + ] = None, + form_values: Optional[ + Union[ + Dict[str, models.FormValuesRequest], + Dict[str, models.FormValuesRequestTypedDict], + ] + ] = None, + folder_id: Optional[str] = None, + recipients: Optional[ + Union[ + List[models.DocumentCreateDocumentTemporaryRecipientRequest], + List[models.DocumentCreateDocumentTemporaryRecipientRequestTypedDict], + ] + ] = None, + meta: Optional[ + Union[ + models.DocumentCreateDocumentTemporaryMeta, + models.DocumentCreateDocumentTemporaryMetaTypedDict, + ] + ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentDuplicateDocumentResponse: - r"""Duplicate document + ) -> models.DocumentCreateDocumentTemporaryResponse: + r"""Create document - :param document_id: + 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. + + :param title: The title of the document. + :param external_id: The external ID of the document. + :param visibility: The visibility of the document. + :param global_access_auth: + :param global_action_auth: + :param form_values: + :param folder_id: The ID of the folder to create the document in. If not provided, the document will be created in the root folder. + :param recipients: + :param meta: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -1813,13 +1708,26 @@ async def duplicate_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentDuplicateDocumentRequest( - document_id=document_id, + request = models.DocumentCreateDocumentTemporaryRequest( + title=title, + external_id=external_id, + visibility=visibility, + global_access_auth=global_access_auth, + global_action_auth=global_action_auth, + form_values=form_values, + folder_id=folder_id, + recipients=utils.get_pydantic_model( + recipients, + Optional[List[models.DocumentCreateDocumentTemporaryRecipientRequest]], + ), + meta=utils.get_pydantic_model( + meta, Optional[models.DocumentCreateDocumentTemporaryMeta] + ), ) req = self._build_request_async( method="POST", - path="/document/duplicate", + path="/document/create/beta", base_url=base_url, url_variables=url_variables, request=request, @@ -1831,7 +1739,11 @@ async def duplicate_async( http_headers=http_headers, security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.DocumentDuplicateDocumentRequest + request, + False, + False, + "json", + models.DocumentCreateDocumentTemporaryRequest, ), timeout_ms=timeout_ms, ) @@ -1848,8 +1760,8 @@ async def duplicate_async( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-duplicateDocument", - oauth2_scopes=[], + operation_id="document-createDocumentTemporary", + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1862,20 +1774,20 @@ async def duplicate_async( response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response( - models.DocumentDuplicateDocumentResponse, http_res + models.DocumentCreateDocumentTemporaryResponse, http_res ) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentDuplicateDocumentBadRequestErrorData, http_res + models.DocumentCreateDocumentTemporaryBadRequestErrorData, http_res ) - raise models.DocumentDuplicateDocumentBadRequestError( + raise models.DocumentCreateDocumentTemporaryBadRequestError( response_data, http_res ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentDuplicateDocumentInternalServerErrorData, http_res + models.DocumentCreateDocumentTemporaryInternalServerErrorData, http_res ) - raise models.DocumentDuplicateDocumentInternalServerError( + raise models.DocumentCreateDocumentTemporaryInternalServerError( response_data, http_res ) if utils.match_response(http_res, "4XX", "*"): diff --git a/src/documenso_sdk/documents_fields.py b/src/documenso_sdk/documents_fields.py index cdf2fb7..a3fc6e6 100644 --- a/src/documenso_sdk/documents_fields.py +++ b/src/documenso_sdk/documents_fields.py @@ -72,7 +72,7 @@ def get( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-getDocumentField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -175,7 +175,7 @@ async def get_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-getDocumentField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -289,7 +289,7 @@ def create( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-createDocumentField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -400,7 +400,7 @@ async def create_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-createDocumentField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -511,7 +511,7 @@ def create_many( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-createDocumentFields", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -622,7 +622,7 @@ async def create_many_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-createDocumentFields", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -733,7 +733,7 @@ def update( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-updateDocumentField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -844,7 +844,7 @@ async def update_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-updateDocumentField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -955,7 +955,7 @@ def update_many( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-updateDocumentFields", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1066,7 +1066,7 @@ async def update_many_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-updateDocumentFields", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1167,7 +1167,7 @@ def delete( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-deleteDocumentField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1268,7 +1268,7 @@ async def delete_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-deleteDocumentField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), diff --git a/src/documenso_sdk/documents_recipients.py b/src/documenso_sdk/documents_recipients.py index 98ccc29..d600cc7 100644 --- a/src/documenso_sdk/documents_recipients.py +++ b/src/documenso_sdk/documents_recipients.py @@ -72,7 +72,7 @@ def get( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-getDocumentRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -179,7 +179,7 @@ async def get_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-getDocumentRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -301,7 +301,7 @@ def create( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-createDocumentRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -416,7 +416,7 @@ async def create_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-createDocumentRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -532,7 +532,7 @@ def create_many( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-createDocumentRecipients", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -649,7 +649,7 @@ async def create_many_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-createDocumentRecipients", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -765,7 +765,7 @@ def update( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-updateDocumentRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -880,7 +880,7 @@ async def update_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-updateDocumentRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -996,7 +996,7 @@ def update_many( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-updateDocumentRecipients", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1113,7 +1113,7 @@ async def update_many_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-updateDocumentRecipients", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1219,7 +1219,7 @@ def delete( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-deleteDocumentRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1324,7 +1324,7 @@ async def delete_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-deleteDocumentRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), diff --git a/src/documenso_sdk/embedding.py b/src/documenso_sdk/embedding.py index 2e65876..ef73a54 100644 --- a/src/documenso_sdk/embedding.py +++ b/src/documenso_sdk/embedding.py @@ -79,7 +79,7 @@ def embedding_presign_create_embedding_presign_token( config=self.sdk_configuration, base_url=base_url or "", operation_id="embeddingPresign-createEmbeddingPresignToken", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -188,7 +188,7 @@ async def embedding_presign_create_embedding_presign_token_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="embeddingPresign-createEmbeddingPresignToken", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -297,7 +297,7 @@ def embedding_presign_verify_embedding_presign_token( config=self.sdk_configuration, base_url=base_url or "", operation_id="embeddingPresign-verifyEmbeddingPresignToken", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -406,7 +406,7 @@ async def embedding_presign_verify_embedding_presign_token_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="embeddingPresign-verifyEmbeddingPresignToken", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), diff --git a/src/documenso_sdk/httpclient.py b/src/documenso_sdk/httpclient.py index 47b052c..89560b5 100644 --- a/src/documenso_sdk/httpclient.py +++ b/src/documenso_sdk/httpclient.py @@ -107,7 +107,6 @@ def close_clients( # to them from the owning SDK instance and they can be reaped. owner.client = None owner.async_client = None - if sync_client is not None and not sync_client_supplied: try: sync_client.close() diff --git a/src/documenso_sdk/models/__init__.py b/src/documenso_sdk/models/__init__.py index ec9d1db..09b998b 100644 --- a/src/documenso_sdk/models/__init__.py +++ b/src/documenso_sdk/models/__init__.py @@ -9,7 +9,6 @@ if TYPE_CHECKING: from .apierror import APIError from .document_createdocumenttemporaryop import ( - Document, DocumentAccessAuth, DocumentActionAuth, DocumentCreateDocumentTemporaryAccessAuthRequest, @@ -22,10 +21,12 @@ DocumentCreateDocumentTemporaryBadRequestIssueTypedDict, DocumentCreateDocumentTemporaryDateFormat, DocumentCreateDocumentTemporaryDistributionMethodRequest, + DocumentCreateDocumentTemporaryDocument, DocumentCreateDocumentTemporaryDocumentData, DocumentCreateDocumentTemporaryDocumentDataTypedDict, DocumentCreateDocumentTemporaryDocumentMeta, DocumentCreateDocumentTemporaryDocumentMetaTypedDict, + DocumentCreateDocumentTemporaryDocumentTypedDict, DocumentCreateDocumentTemporaryEmailSettingsRequest, DocumentCreateDocumentTemporaryEmailSettingsRequestTypedDict, DocumentCreateDocumentTemporaryFieldCheckbox, @@ -66,6 +67,7 @@ DocumentCreateDocumentTemporaryReadStatus, DocumentCreateDocumentTemporaryRecipientAuthOptions, DocumentCreateDocumentTemporaryRecipientAuthOptionsTypedDict, + DocumentCreateDocumentTemporaryRecipientDirection, DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox, DocumentCreateDocumentTemporaryRecipientFieldMetaCheckboxTypedDict, DocumentCreateDocumentTemporaryRecipientFieldMetaDate, @@ -129,6 +131,7 @@ DocumentCreateDocumentTemporaryValueRadio, DocumentCreateDocumentTemporaryValueRadioTypedDict, DocumentCreateDocumentTemporaryVisibilityRequest, + DocumentDirection, DocumentDistributionMethod, DocumentDocumentDataType, DocumentEmailSettings, @@ -163,7 +166,6 @@ DocumentTypeNumber, DocumentTypeRadio, DocumentTypeText, - DocumentTypedDict, DocumentValue1, DocumentValue1TypedDict, DocumentValue2, @@ -192,254 +194,274 @@ FormValuesRequest, FormValuesRequestTypedDict, ) - from .document_deletedocumentop import ( - DocumentDeleteDocumentBadRequestError, - DocumentDeleteDocumentBadRequestErrorData, - DocumentDeleteDocumentBadRequestIssue, - DocumentDeleteDocumentBadRequestIssueTypedDict, - DocumentDeleteDocumentInternalServerError, - DocumentDeleteDocumentInternalServerErrorData, - DocumentDeleteDocumentInternalServerErrorIssue, - DocumentDeleteDocumentInternalServerErrorIssueTypedDict, - DocumentDeleteDocumentRequest, - DocumentDeleteDocumentRequestTypedDict, - DocumentDeleteDocumentResponse, - DocumentDeleteDocumentResponseTypedDict, + from .document_deleteop import ( + DocumentDeleteBadRequestError, + DocumentDeleteBadRequestErrorData, + DocumentDeleteBadRequestIssue, + DocumentDeleteBadRequestIssueTypedDict, + DocumentDeleteInternalServerError, + DocumentDeleteInternalServerErrorData, + DocumentDeleteInternalServerErrorIssue, + DocumentDeleteInternalServerErrorIssueTypedDict, + DocumentDeleteRequest, + DocumentDeleteRequestTypedDict, + DocumentDeleteResponse, + DocumentDeleteResponseTypedDict, ) - from .document_duplicatedocumentop import ( - DocumentDuplicateDocumentBadRequestError, - DocumentDuplicateDocumentBadRequestErrorData, - DocumentDuplicateDocumentBadRequestIssue, - DocumentDuplicateDocumentBadRequestIssueTypedDict, - DocumentDuplicateDocumentInternalServerError, - DocumentDuplicateDocumentInternalServerErrorData, - DocumentDuplicateDocumentInternalServerErrorIssue, - DocumentDuplicateDocumentInternalServerErrorIssueTypedDict, - DocumentDuplicateDocumentRequest, - DocumentDuplicateDocumentRequestTypedDict, - DocumentDuplicateDocumentResponse, - DocumentDuplicateDocumentResponseTypedDict, + from .document_distributeop import ( + DocumentDistributeAuthOptions, + DocumentDistributeAuthOptionsTypedDict, + DocumentDistributeBadRequestError, + DocumentDistributeBadRequestErrorData, + DocumentDistributeBadRequestIssue, + DocumentDistributeBadRequestIssueTypedDict, + DocumentDistributeDateFormat, + DocumentDistributeDistributionMethod, + DocumentDistributeEmailSettings, + DocumentDistributeEmailSettingsTypedDict, + DocumentDistributeFormValues, + DocumentDistributeFormValuesTypedDict, + DocumentDistributeGlobalAccessAuth, + DocumentDistributeGlobalActionAuth, + DocumentDistributeInternalServerError, + DocumentDistributeInternalServerErrorData, + DocumentDistributeInternalServerErrorIssue, + DocumentDistributeInternalServerErrorIssueTypedDict, + DocumentDistributeLanguage, + DocumentDistributeMeta, + DocumentDistributeMetaTypedDict, + DocumentDistributeRequest, + DocumentDistributeRequestTypedDict, + DocumentDistributeResponse, + DocumentDistributeResponseTypedDict, + DocumentDistributeSource, + DocumentDistributeStatus, + DocumentDistributeVisibility, ) - from .document_finddocumentsop import ( + from .document_downloadop import ( + DocumentDownloadBadRequestError, + DocumentDownloadBadRequestErrorData, + DocumentDownloadBadRequestIssue, + DocumentDownloadBadRequestIssueTypedDict, + DocumentDownloadInternalServerError, + DocumentDownloadInternalServerErrorData, + DocumentDownloadInternalServerErrorIssue, + DocumentDownloadInternalServerErrorIssueTypedDict, + DocumentDownloadNotFoundError, + DocumentDownloadNotFoundErrorData, + DocumentDownloadNotFoundIssue, + DocumentDownloadNotFoundIssueTypedDict, + DocumentDownloadRequest, + DocumentDownloadRequestTypedDict, + DocumentDownloadResponse, + DocumentDownloadResponseTypedDict, + Version, + ) + from .document_duplicateop import ( + DocumentDuplicateBadRequestError, + DocumentDuplicateBadRequestErrorData, + DocumentDuplicateBadRequestIssue, + DocumentDuplicateBadRequestIssueTypedDict, + DocumentDuplicateInternalServerError, + DocumentDuplicateInternalServerErrorData, + DocumentDuplicateInternalServerErrorIssue, + DocumentDuplicateInternalServerErrorIssueTypedDict, + DocumentDuplicateRequest, + DocumentDuplicateRequestTypedDict, + DocumentDuplicateResponse, + DocumentDuplicateResponseTypedDict, + ) + from .document_findop import ( DataSource, DataStatus, - DocumentFindDocumentsAccessAuth, - DocumentFindDocumentsActionAuth, - DocumentFindDocumentsAuthOptions, - DocumentFindDocumentsAuthOptionsTypedDict, - DocumentFindDocumentsBadRequestError, - DocumentFindDocumentsBadRequestErrorData, - DocumentFindDocumentsBadRequestIssue, - DocumentFindDocumentsBadRequestIssueTypedDict, - DocumentFindDocumentsData, - DocumentFindDocumentsDataTypedDict, - DocumentFindDocumentsFormValues, - DocumentFindDocumentsFormValuesTypedDict, - DocumentFindDocumentsGlobalAccessAuth, - DocumentFindDocumentsGlobalActionAuth, - DocumentFindDocumentsInternalServerError, - DocumentFindDocumentsInternalServerErrorData, - DocumentFindDocumentsInternalServerErrorIssue, - DocumentFindDocumentsInternalServerErrorIssueTypedDict, - DocumentFindDocumentsNotFoundError, - DocumentFindDocumentsNotFoundErrorData, - DocumentFindDocumentsNotFoundIssue, - DocumentFindDocumentsNotFoundIssueTypedDict, - DocumentFindDocumentsReadStatus, - DocumentFindDocumentsRecipient, - DocumentFindDocumentsRecipientAuthOptions, - DocumentFindDocumentsRecipientAuthOptionsTypedDict, - DocumentFindDocumentsRecipientTypedDict, - DocumentFindDocumentsRequest, - DocumentFindDocumentsRequestTypedDict, - DocumentFindDocumentsResponse, - DocumentFindDocumentsResponseTypedDict, - DocumentFindDocumentsRole, - DocumentFindDocumentsSendStatus, - DocumentFindDocumentsSigningStatus, - DocumentFindDocumentsTeam, - DocumentFindDocumentsTeamTypedDict, - DocumentFindDocumentsUser, - DocumentFindDocumentsUserTypedDict, - DocumentFindDocumentsVisibility, + DocumentFindAccessAuth, + DocumentFindActionAuth, + DocumentFindAuthOptions, + DocumentFindAuthOptionsTypedDict, + DocumentFindBadRequestError, + DocumentFindBadRequestErrorData, + DocumentFindBadRequestIssue, + DocumentFindBadRequestIssueTypedDict, + DocumentFindData, + DocumentFindDataTypedDict, + DocumentFindFormValues, + DocumentFindFormValuesTypedDict, + DocumentFindGlobalAccessAuth, + DocumentFindGlobalActionAuth, + DocumentFindInternalServerError, + DocumentFindInternalServerErrorData, + DocumentFindInternalServerErrorIssue, + DocumentFindInternalServerErrorIssueTypedDict, + DocumentFindNotFoundError, + DocumentFindNotFoundErrorData, + DocumentFindNotFoundIssue, + DocumentFindNotFoundIssueTypedDict, + DocumentFindReadStatus, + DocumentFindRecipient, + DocumentFindRecipientAuthOptions, + DocumentFindRecipientAuthOptionsTypedDict, + DocumentFindRecipientTypedDict, + DocumentFindRequest, + DocumentFindRequestTypedDict, + DocumentFindResponse, + DocumentFindResponseTypedDict, + DocumentFindRole, + DocumentFindSendStatus, + DocumentFindSigningStatus, + DocumentFindTeam, + DocumentFindTeamTypedDict, + DocumentFindUser, + DocumentFindUserTypedDict, + DocumentFindVisibility, OrderByColumn, OrderByDirection, QueryParamSource, QueryParamStatus, ) - from .document_getdocumentwithdetailsbyidop import ( - DocumentGetDocumentWithDetailsByIDAccessAuth, - DocumentGetDocumentWithDetailsByIDActionAuth, - DocumentGetDocumentWithDetailsByIDAuthOptions, - DocumentGetDocumentWithDetailsByIDAuthOptionsTypedDict, - DocumentGetDocumentWithDetailsByIDBadRequestError, - DocumentGetDocumentWithDetailsByIDBadRequestErrorData, - DocumentGetDocumentWithDetailsByIDBadRequestIssue, - DocumentGetDocumentWithDetailsByIDBadRequestIssueTypedDict, - DocumentGetDocumentWithDetailsByIDDistributionMethod, - DocumentGetDocumentWithDetailsByIDDocumentData, - DocumentGetDocumentWithDetailsByIDDocumentDataType, - DocumentGetDocumentWithDetailsByIDDocumentDataTypedDict, - DocumentGetDocumentWithDetailsByIDDocumentMeta, - DocumentGetDocumentWithDetailsByIDDocumentMetaTypedDict, - DocumentGetDocumentWithDetailsByIDEmailSettings, - DocumentGetDocumentWithDetailsByIDEmailSettingsTypedDict, - DocumentGetDocumentWithDetailsByIDField, - DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox, - DocumentGetDocumentWithDetailsByIDFieldMetaCheckboxTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaDate, - DocumentGetDocumentWithDetailsByIDFieldMetaDateTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaDropdown, - DocumentGetDocumentWithDetailsByIDFieldMetaDropdownTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaEmail, - DocumentGetDocumentWithDetailsByIDFieldMetaEmailTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaInitials, - DocumentGetDocumentWithDetailsByIDFieldMetaInitialsTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaName, - DocumentGetDocumentWithDetailsByIDFieldMetaNameTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaNumber, - DocumentGetDocumentWithDetailsByIDFieldMetaNumberTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaRadio, - DocumentGetDocumentWithDetailsByIDFieldMetaRadioTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaText, - DocumentGetDocumentWithDetailsByIDFieldMetaTextTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaUnion, - DocumentGetDocumentWithDetailsByIDFieldMetaUnionTypedDict, - DocumentGetDocumentWithDetailsByIDFieldType, - DocumentGetDocumentWithDetailsByIDFieldTypedDict, - DocumentGetDocumentWithDetailsByIDFolder, - DocumentGetDocumentWithDetailsByIDFolderType, - DocumentGetDocumentWithDetailsByIDFolderTypedDict, - DocumentGetDocumentWithDetailsByIDFolderVisibility, - DocumentGetDocumentWithDetailsByIDFormValues, - DocumentGetDocumentWithDetailsByIDFormValuesTypedDict, - DocumentGetDocumentWithDetailsByIDGlobalAccessAuth, - DocumentGetDocumentWithDetailsByIDGlobalActionAuth, - DocumentGetDocumentWithDetailsByIDInternalServerError, - DocumentGetDocumentWithDetailsByIDInternalServerErrorData, - DocumentGetDocumentWithDetailsByIDInternalServerErrorIssue, - DocumentGetDocumentWithDetailsByIDInternalServerErrorIssueTypedDict, - DocumentGetDocumentWithDetailsByIDNotFoundError, - DocumentGetDocumentWithDetailsByIDNotFoundErrorData, - DocumentGetDocumentWithDetailsByIDNotFoundIssue, - DocumentGetDocumentWithDetailsByIDNotFoundIssueTypedDict, - DocumentGetDocumentWithDetailsByIDReadStatus, - DocumentGetDocumentWithDetailsByIDRecipient, - DocumentGetDocumentWithDetailsByIDRecipientAuthOptions, - DocumentGetDocumentWithDetailsByIDRecipientAuthOptionsTypedDict, - DocumentGetDocumentWithDetailsByIDRecipientTypedDict, - DocumentGetDocumentWithDetailsByIDRequest, - DocumentGetDocumentWithDetailsByIDRequestTypedDict, - DocumentGetDocumentWithDetailsByIDResponse, - DocumentGetDocumentWithDetailsByIDResponseTypedDict, - DocumentGetDocumentWithDetailsByIDRole, - DocumentGetDocumentWithDetailsByIDSendStatus, - DocumentGetDocumentWithDetailsByIDSigningOrder, - DocumentGetDocumentWithDetailsByIDSigningStatus, - DocumentGetDocumentWithDetailsByIDSource, - DocumentGetDocumentWithDetailsByIDStatus, - DocumentGetDocumentWithDetailsByIDTextAlign1, - DocumentGetDocumentWithDetailsByIDTextAlign2, - DocumentGetDocumentWithDetailsByIDTextAlign3, - DocumentGetDocumentWithDetailsByIDTextAlign4, - DocumentGetDocumentWithDetailsByIDTextAlign5, - DocumentGetDocumentWithDetailsByIDTextAlign6, - DocumentGetDocumentWithDetailsByIDTypeCheckbox, - DocumentGetDocumentWithDetailsByIDTypeDate, - DocumentGetDocumentWithDetailsByIDTypeDropdown, - DocumentGetDocumentWithDetailsByIDTypeEmail, - DocumentGetDocumentWithDetailsByIDTypeInitials, - DocumentGetDocumentWithDetailsByIDTypeName, - DocumentGetDocumentWithDetailsByIDTypeNumber, - DocumentGetDocumentWithDetailsByIDTypeRadio, - DocumentGetDocumentWithDetailsByIDTypeText, - DocumentGetDocumentWithDetailsByIDValue1, - DocumentGetDocumentWithDetailsByIDValue1TypedDict, - DocumentGetDocumentWithDetailsByIDValue2, - DocumentGetDocumentWithDetailsByIDValue2TypedDict, - DocumentGetDocumentWithDetailsByIDValue3, - DocumentGetDocumentWithDetailsByIDValue3TypedDict, - DocumentGetDocumentWithDetailsByIDVisibility, + from .document_getop import ( + DocumentGetAccessAuth, + DocumentGetActionAuth, + DocumentGetAuthOptions, + DocumentGetAuthOptionsTypedDict, + DocumentGetBadRequestError, + DocumentGetBadRequestErrorData, + DocumentGetBadRequestIssue, + DocumentGetBadRequestIssueTypedDict, + DocumentGetDirection, + DocumentGetDistributionMethod, + DocumentGetDocumentData, + DocumentGetDocumentDataType, + DocumentGetDocumentDataTypedDict, + DocumentGetDocumentMeta, + DocumentGetDocumentMetaTypedDict, + DocumentGetEmailSettings, + DocumentGetEmailSettingsTypedDict, + DocumentGetField, + DocumentGetFieldMetaCheckbox, + DocumentGetFieldMetaCheckboxTypedDict, + DocumentGetFieldMetaDate, + DocumentGetFieldMetaDateTypedDict, + DocumentGetFieldMetaDropdown, + DocumentGetFieldMetaDropdownTypedDict, + DocumentGetFieldMetaEmail, + DocumentGetFieldMetaEmailTypedDict, + DocumentGetFieldMetaInitials, + DocumentGetFieldMetaInitialsTypedDict, + DocumentGetFieldMetaName, + DocumentGetFieldMetaNameTypedDict, + DocumentGetFieldMetaNumber, + DocumentGetFieldMetaNumberTypedDict, + DocumentGetFieldMetaRadio, + DocumentGetFieldMetaRadioTypedDict, + DocumentGetFieldMetaText, + DocumentGetFieldMetaTextTypedDict, + DocumentGetFieldMetaUnion, + DocumentGetFieldMetaUnionTypedDict, + DocumentGetFieldType, + DocumentGetFieldTypedDict, + DocumentGetFolder, + DocumentGetFolderType, + DocumentGetFolderTypedDict, + DocumentGetFolderVisibility, + DocumentGetFormValues, + DocumentGetFormValuesTypedDict, + DocumentGetGlobalAccessAuth, + DocumentGetGlobalActionAuth, + DocumentGetInternalServerError, + DocumentGetInternalServerErrorData, + DocumentGetInternalServerErrorIssue, + DocumentGetInternalServerErrorIssueTypedDict, + DocumentGetNotFoundError, + DocumentGetNotFoundErrorData, + DocumentGetNotFoundIssue, + DocumentGetNotFoundIssueTypedDict, + DocumentGetReadStatus, + DocumentGetRecipient, + DocumentGetRecipientAuthOptions, + DocumentGetRecipientAuthOptionsTypedDict, + DocumentGetRecipientTypedDict, + DocumentGetRequest, + DocumentGetRequestTypedDict, + DocumentGetResponse, + DocumentGetResponseTypedDict, + DocumentGetRole, + DocumentGetSendStatus, + DocumentGetSigningOrder, + DocumentGetSigningStatus, + DocumentGetSource, + DocumentGetStatus, + DocumentGetTextAlign1, + DocumentGetTextAlign2, + DocumentGetTextAlign3, + DocumentGetTextAlign4, + DocumentGetTextAlign5, + DocumentGetTextAlign6, + DocumentGetTypeCheckbox, + DocumentGetTypeDate, + DocumentGetTypeDropdown, + DocumentGetTypeEmail, + DocumentGetTypeInitials, + DocumentGetTypeName, + DocumentGetTypeNumber, + DocumentGetTypeRadio, + DocumentGetTypeText, + DocumentGetValue1, + DocumentGetValue1TypedDict, + DocumentGetValue2, + DocumentGetValue2TypedDict, + DocumentGetValue3, + DocumentGetValue3TypedDict, + DocumentGetVisibility, ) - from .document_resenddocumentop import ( - DocumentResendDocumentBadRequestError, - DocumentResendDocumentBadRequestErrorData, - DocumentResendDocumentBadRequestIssue, - DocumentResendDocumentBadRequestIssueTypedDict, - DocumentResendDocumentInternalServerError, - DocumentResendDocumentInternalServerErrorData, - DocumentResendDocumentInternalServerErrorIssue, - DocumentResendDocumentInternalServerErrorIssueTypedDict, - DocumentResendDocumentRequest, - DocumentResendDocumentRequestTypedDict, - DocumentResendDocumentResponse, - DocumentResendDocumentResponseTypedDict, + from .document_redistributeop import ( + DocumentRedistributeBadRequestError, + DocumentRedistributeBadRequestErrorData, + DocumentRedistributeBadRequestIssue, + DocumentRedistributeBadRequestIssueTypedDict, + DocumentRedistributeInternalServerError, + DocumentRedistributeInternalServerErrorData, + DocumentRedistributeInternalServerErrorIssue, + DocumentRedistributeInternalServerErrorIssueTypedDict, + DocumentRedistributeRequest, + DocumentRedistributeRequestTypedDict, + DocumentRedistributeResponse, + DocumentRedistributeResponseTypedDict, ) - from .document_senddocumentop import ( - DocumentSendDocumentAuthOptions, - DocumentSendDocumentAuthOptionsTypedDict, - DocumentSendDocumentBadRequestError, - DocumentSendDocumentBadRequestErrorData, - DocumentSendDocumentBadRequestIssue, - DocumentSendDocumentBadRequestIssueTypedDict, - DocumentSendDocumentDateFormat, - DocumentSendDocumentDistributionMethod, - DocumentSendDocumentEmailSettings, - DocumentSendDocumentEmailSettingsTypedDict, - DocumentSendDocumentFormValues, - DocumentSendDocumentFormValuesTypedDict, - DocumentSendDocumentGlobalAccessAuth, - DocumentSendDocumentGlobalActionAuth, - DocumentSendDocumentInternalServerError, - DocumentSendDocumentInternalServerErrorData, - DocumentSendDocumentInternalServerErrorIssue, - DocumentSendDocumentInternalServerErrorIssueTypedDict, - DocumentSendDocumentLanguage, - DocumentSendDocumentMeta, - DocumentSendDocumentMetaTypedDict, - DocumentSendDocumentRequest, - DocumentSendDocumentRequestTypedDict, - DocumentSendDocumentResponse, - DocumentSendDocumentResponseTypedDict, - DocumentSendDocumentSource, - DocumentSendDocumentStatus, - DocumentSendDocumentVisibility, - ) - from .document_updatedocumentop import ( - DocumentUpdateDocumentAuthOptions, - DocumentUpdateDocumentAuthOptionsTypedDict, - DocumentUpdateDocumentBadRequestError, - DocumentUpdateDocumentBadRequestErrorData, - DocumentUpdateDocumentBadRequestIssue, - DocumentUpdateDocumentBadRequestIssueTypedDict, - DocumentUpdateDocumentData, - DocumentUpdateDocumentDataTypedDict, - DocumentUpdateDocumentDateFormat, - DocumentUpdateDocumentDistributionMethod, - DocumentUpdateDocumentEmailSettings, - DocumentUpdateDocumentEmailSettingsTypedDict, - DocumentUpdateDocumentFormValues, - DocumentUpdateDocumentFormValuesTypedDict, - DocumentUpdateDocumentGlobalAccessAuthRequest, - DocumentUpdateDocumentGlobalAccessAuthResponse, - DocumentUpdateDocumentGlobalActionAuthRequest, - DocumentUpdateDocumentGlobalActionAuthResponse, - DocumentUpdateDocumentInternalServerError, - DocumentUpdateDocumentInternalServerErrorData, - DocumentUpdateDocumentInternalServerErrorIssue, - DocumentUpdateDocumentInternalServerErrorIssueTypedDict, - DocumentUpdateDocumentLanguage, - DocumentUpdateDocumentMeta, - DocumentUpdateDocumentMetaTypedDict, - DocumentUpdateDocumentRequest, - DocumentUpdateDocumentRequestTypedDict, - DocumentUpdateDocumentResponse, - DocumentUpdateDocumentResponseTypedDict, - DocumentUpdateDocumentSigningOrder, - DocumentUpdateDocumentSource, - DocumentUpdateDocumentStatus, - DocumentUpdateDocumentVisibilityRequest, - DocumentUpdateDocumentVisibilityResponse, + from .document_updateop import ( + DocumentUpdateAuthOptions, + DocumentUpdateAuthOptionsTypedDict, + DocumentUpdateBadRequestError, + DocumentUpdateBadRequestErrorData, + DocumentUpdateBadRequestIssue, + DocumentUpdateBadRequestIssueTypedDict, + DocumentUpdateData, + DocumentUpdateDataTypedDict, + DocumentUpdateDateFormat, + DocumentUpdateDistributionMethod, + DocumentUpdateEmailSettings, + DocumentUpdateEmailSettingsTypedDict, + DocumentUpdateFormValues, + DocumentUpdateFormValuesTypedDict, + DocumentUpdateGlobalAccessAuthRequest, + DocumentUpdateGlobalAccessAuthResponse, + DocumentUpdateGlobalActionAuthRequest, + DocumentUpdateGlobalActionAuthResponse, + DocumentUpdateInternalServerError, + DocumentUpdateInternalServerErrorData, + DocumentUpdateInternalServerErrorIssue, + DocumentUpdateInternalServerErrorIssueTypedDict, + DocumentUpdateLanguage, + DocumentUpdateMeta, + DocumentUpdateMetaTypedDict, + DocumentUpdateRequest, + DocumentUpdateRequestTypedDict, + DocumentUpdateResponse, + DocumentUpdateResponseTypedDict, + DocumentUpdateSigningOrder, + DocumentUpdateSource, + DocumentUpdateStatus, + DocumentUpdateVisibilityRequest, + DocumentUpdateVisibilityResponse, ) from .embeddingpresign_createembeddingpresigntokenop import ( EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError, @@ -474,6 +496,8 @@ FieldCreateDocumentFieldBadRequestErrorData, FieldCreateDocumentFieldBadRequestIssue, FieldCreateDocumentFieldBadRequestIssueTypedDict, + FieldCreateDocumentFieldDirectionRequest, + FieldCreateDocumentFieldDirectionResponse, FieldCreateDocumentFieldFieldCheckbox, FieldCreateDocumentFieldFieldCheckboxTypedDict, FieldCreateDocumentFieldFieldDate, @@ -604,6 +628,8 @@ FieldCreateDocumentFieldsBadRequestErrorData, FieldCreateDocumentFieldsBadRequestIssue, FieldCreateDocumentFieldsBadRequestIssueTypedDict, + FieldCreateDocumentFieldsDirectionRequest, + FieldCreateDocumentFieldsDirectionResponse, FieldCreateDocumentFieldsFieldCheckbox, FieldCreateDocumentFieldsFieldCheckboxTypedDict, FieldCreateDocumentFieldsFieldDate, @@ -736,6 +762,8 @@ FieldCreateTemplateFieldBadRequestErrorData, FieldCreateTemplateFieldBadRequestIssue, FieldCreateTemplateFieldBadRequestIssueTypedDict, + FieldCreateTemplateFieldDirectionRequest, + FieldCreateTemplateFieldDirectionResponse, FieldCreateTemplateFieldFieldCheckbox, FieldCreateTemplateFieldFieldCheckboxTypedDict, FieldCreateTemplateFieldFieldDate, @@ -866,6 +894,8 @@ FieldCreateTemplateFieldsBadRequestErrorData, FieldCreateTemplateFieldsBadRequestIssue, FieldCreateTemplateFieldsBadRequestIssueTypedDict, + FieldCreateTemplateFieldsDirectionRequest, + FieldCreateTemplateFieldsDirectionResponse, FieldCreateTemplateFieldsFieldCheckbox, FieldCreateTemplateFieldsFieldCheckboxTypedDict, FieldCreateTemplateFieldsFieldDate, @@ -1026,6 +1056,7 @@ FieldGetDocumentFieldBadRequestErrorData, FieldGetDocumentFieldBadRequestIssue, FieldGetDocumentFieldBadRequestIssueTypedDict, + FieldGetDocumentFieldDirection, FieldGetDocumentFieldFieldMetaCheckbox, FieldGetDocumentFieldFieldMetaCheckboxTypedDict, FieldGetDocumentFieldFieldMetaDate, @@ -1086,6 +1117,7 @@ FieldGetTemplateFieldBadRequestErrorData, FieldGetTemplateFieldBadRequestIssue, FieldGetTemplateFieldBadRequestIssueTypedDict, + FieldGetTemplateFieldDirection, FieldGetTemplateFieldFieldMetaCheckbox, FieldGetTemplateFieldFieldMetaCheckboxTypedDict, FieldGetTemplateFieldFieldMetaDate, @@ -1146,6 +1178,8 @@ FieldUpdateDocumentFieldBadRequestErrorData, FieldUpdateDocumentFieldBadRequestIssue, FieldUpdateDocumentFieldBadRequestIssueTypedDict, + FieldUpdateDocumentFieldDirectionRequest, + FieldUpdateDocumentFieldDirectionResponse, FieldUpdateDocumentFieldFieldCheckbox, FieldUpdateDocumentFieldFieldCheckboxTypedDict, FieldUpdateDocumentFieldFieldDate, @@ -1276,6 +1310,8 @@ FieldUpdateDocumentFieldsBadRequestErrorData, FieldUpdateDocumentFieldsBadRequestIssue, FieldUpdateDocumentFieldsBadRequestIssueTypedDict, + FieldUpdateDocumentFieldsDirectionRequest, + FieldUpdateDocumentFieldsDirectionResponse, FieldUpdateDocumentFieldsFieldCheckbox, FieldUpdateDocumentFieldsFieldCheckboxTypedDict, FieldUpdateDocumentFieldsFieldDate, @@ -1408,6 +1444,8 @@ FieldUpdateTemplateFieldBadRequestErrorData, FieldUpdateTemplateFieldBadRequestIssue, FieldUpdateTemplateFieldBadRequestIssueTypedDict, + FieldUpdateTemplateFieldDirectionRequest, + FieldUpdateTemplateFieldDirectionResponse, FieldUpdateTemplateFieldFieldCheckbox, FieldUpdateTemplateFieldFieldCheckboxTypedDict, FieldUpdateTemplateFieldFieldDate, @@ -1538,6 +1576,8 @@ FieldUpdateTemplateFieldsBadRequestErrorData, FieldUpdateTemplateFieldsBadRequestIssue, FieldUpdateTemplateFieldsBadRequestIssueTypedDict, + FieldUpdateTemplateFieldsDirectionRequest, + FieldUpdateTemplateFieldsDirectionResponse, FieldUpdateTemplateFieldsFieldCheckbox, FieldUpdateTemplateFieldsFieldCheckboxTypedDict, FieldUpdateTemplateFieldsFieldDate, @@ -1815,6 +1855,7 @@ RecipientGetDocumentRecipientBadRequestErrorData, RecipientGetDocumentRecipientBadRequestIssue, RecipientGetDocumentRecipientBadRequestIssueTypedDict, + RecipientGetDocumentRecipientDirection, RecipientGetDocumentRecipientField, RecipientGetDocumentRecipientFieldMetaCheckbox, RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict, @@ -1885,6 +1926,7 @@ RecipientGetTemplateRecipientBadRequestErrorData, RecipientGetTemplateRecipientBadRequestIssue, RecipientGetTemplateRecipientBadRequestIssueTypedDict, + RecipientGetTemplateRecipientDirection, RecipientGetTemplateRecipientField, RecipientGetTemplateRecipientFieldMetaCheckbox, RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict, @@ -1957,6 +1999,7 @@ RecipientUpdateDocumentRecipientBadRequestErrorData, RecipientUpdateDocumentRecipientBadRequestIssue, RecipientUpdateDocumentRecipientBadRequestIssueTypedDict, + RecipientUpdateDocumentRecipientDirection, RecipientUpdateDocumentRecipientField, RecipientUpdateDocumentRecipientFieldMetaCheckbox, RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict, @@ -2028,6 +2071,7 @@ RecipientUpdateDocumentRecipientsBadRequestErrorData, RecipientUpdateDocumentRecipientsBadRequestIssue, RecipientUpdateDocumentRecipientsBadRequestIssueTypedDict, + RecipientUpdateDocumentRecipientsDirection, RecipientUpdateDocumentRecipientsField, RecipientUpdateDocumentRecipientsFieldMetaCheckbox, RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict, @@ -2101,6 +2145,7 @@ RecipientUpdateTemplateRecipientBadRequestErrorData, RecipientUpdateTemplateRecipientBadRequestIssue, RecipientUpdateTemplateRecipientBadRequestIssueTypedDict, + RecipientUpdateTemplateRecipientDirection, RecipientUpdateTemplateRecipientField, RecipientUpdateTemplateRecipientFieldMetaCheckbox, RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict, @@ -2172,6 +2217,7 @@ RecipientUpdateTemplateRecipientsBadRequestErrorData, RecipientUpdateTemplateRecipientsBadRequestIssue, RecipientUpdateTemplateRecipientsBadRequestIssueTypedDict, + RecipientUpdateTemplateRecipientsDirection, RecipientUpdateTemplateRecipientsField, RecipientUpdateTemplateRecipientsFieldMetaCheckbox, RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict, @@ -2237,6 +2283,8 @@ from .responsevalidationerror import ResponseValidationError from .security import Security, SecurityTypedDict from .template_createdocumentfromtemplateop import ( + CustomDocumentDatum, + CustomDocumentDatumTypedDict, PrefillField, PrefillFieldCheckbox, PrefillFieldCheckboxTypedDict, @@ -2265,6 +2313,7 @@ TemplateCreateDocumentFromTemplateBadRequestErrorData, TemplateCreateDocumentFromTemplateBadRequestIssue, TemplateCreateDocumentFromTemplateBadRequestIssueTypedDict, + TemplateCreateDocumentFromTemplateDirection, TemplateCreateDocumentFromTemplateDistributionMethod, TemplateCreateDocumentFromTemplateDocumentData, TemplateCreateDocumentFromTemplateDocumentDataType, @@ -2362,6 +2411,112 @@ TemplateCreateTemplateDirectLinkResponse, TemplateCreateTemplateDirectLinkResponseTypedDict, ) + from .template_createtemplatetemporaryop import ( + TemplateCreateTemplateTemporaryAccessAuth, + TemplateCreateTemplateTemporaryActionAuth, + TemplateCreateTemplateTemporaryAuthOptions, + TemplateCreateTemplateTemporaryAuthOptionsTypedDict, + TemplateCreateTemplateTemporaryBadRequestError, + TemplateCreateTemplateTemporaryBadRequestErrorData, + TemplateCreateTemplateTemporaryBadRequestIssue, + TemplateCreateTemplateTemporaryBadRequestIssueTypedDict, + TemplateCreateTemplateTemporaryDateFormat, + TemplateCreateTemplateTemporaryDirectLink, + TemplateCreateTemplateTemporaryDirectLinkTypedDict, + TemplateCreateTemplateTemporaryDirection, + TemplateCreateTemplateTemporaryDistributionMethodRequest, + TemplateCreateTemplateTemporaryEmailSettingsRequest, + TemplateCreateTemplateTemporaryEmailSettingsRequestTypedDict, + TemplateCreateTemplateTemporaryField, + TemplateCreateTemplateTemporaryFieldMetaCheckbox, + TemplateCreateTemplateTemporaryFieldMetaCheckboxTypedDict, + TemplateCreateTemplateTemporaryFieldMetaDate, + TemplateCreateTemplateTemporaryFieldMetaDateTypedDict, + TemplateCreateTemplateTemporaryFieldMetaDropdown, + TemplateCreateTemplateTemporaryFieldMetaDropdownTypedDict, + TemplateCreateTemplateTemporaryFieldMetaEmail, + TemplateCreateTemplateTemporaryFieldMetaEmailTypedDict, + TemplateCreateTemplateTemporaryFieldMetaInitials, + TemplateCreateTemplateTemporaryFieldMetaInitialsTypedDict, + TemplateCreateTemplateTemporaryFieldMetaName, + TemplateCreateTemplateTemporaryFieldMetaNameTypedDict, + TemplateCreateTemplateTemporaryFieldMetaNumber, + TemplateCreateTemplateTemporaryFieldMetaNumberTypedDict, + TemplateCreateTemplateTemporaryFieldMetaRadio, + TemplateCreateTemplateTemporaryFieldMetaRadioTypedDict, + TemplateCreateTemplateTemporaryFieldMetaText, + TemplateCreateTemplateTemporaryFieldMetaTextTypedDict, + TemplateCreateTemplateTemporaryFieldMetaUnion, + TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict, + TemplateCreateTemplateTemporaryFieldType, + TemplateCreateTemplateTemporaryFieldTypedDict, + TemplateCreateTemplateTemporaryFolder, + TemplateCreateTemplateTemporaryFolderType, + TemplateCreateTemplateTemporaryFolderTypedDict, + TemplateCreateTemplateTemporaryFolderVisibility, + TemplateCreateTemplateTemporaryGlobalAccessAuthRequest, + TemplateCreateTemplateTemporaryGlobalAccessAuthResponse, + TemplateCreateTemplateTemporaryGlobalActionAuthRequest, + TemplateCreateTemplateTemporaryGlobalActionAuthResponse, + TemplateCreateTemplateTemporaryInternalServerError, + TemplateCreateTemplateTemporaryInternalServerErrorData, + TemplateCreateTemplateTemporaryInternalServerErrorIssue, + TemplateCreateTemplateTemporaryInternalServerErrorIssueTypedDict, + TemplateCreateTemplateTemporaryLanguage, + TemplateCreateTemplateTemporaryMeta, + TemplateCreateTemplateTemporaryMetaTypedDict, + TemplateCreateTemplateTemporaryReadStatus, + TemplateCreateTemplateTemporaryRecipient, + TemplateCreateTemplateTemporaryRecipientAuthOptions, + TemplateCreateTemplateTemporaryRecipientAuthOptionsTypedDict, + TemplateCreateTemplateTemporaryRecipientTypedDict, + TemplateCreateTemplateTemporaryRequest, + TemplateCreateTemplateTemporaryRequestTypedDict, + TemplateCreateTemplateTemporaryResponse, + TemplateCreateTemplateTemporaryResponseTypedDict, + TemplateCreateTemplateTemporaryRole, + TemplateCreateTemplateTemporarySendStatus, + TemplateCreateTemplateTemporarySigningOrderRequest, + TemplateCreateTemplateTemporarySigningStatus, + TemplateCreateTemplateTemporaryTemplate, + TemplateCreateTemplateTemporaryTemplateDocumentData, + TemplateCreateTemplateTemporaryTemplateDocumentDataType, + TemplateCreateTemplateTemporaryTemplateDocumentDataTypedDict, + TemplateCreateTemplateTemporaryTemplateMeta, + TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod, + TemplateCreateTemplateTemporaryTemplateMetaEmailSettings, + TemplateCreateTemplateTemporaryTemplateMetaEmailSettingsTypedDict, + TemplateCreateTemplateTemporaryTemplateMetaSigningOrder, + TemplateCreateTemplateTemporaryTemplateMetaTypedDict, + TemplateCreateTemplateTemporaryTemplateTypedDict, + TemplateCreateTemplateTemporaryTextAlign1, + TemplateCreateTemplateTemporaryTextAlign2, + TemplateCreateTemplateTemporaryTextAlign3, + TemplateCreateTemplateTemporaryTextAlign4, + TemplateCreateTemplateTemporaryTextAlign5, + TemplateCreateTemplateTemporaryTextAlign6, + TemplateCreateTemplateTemporaryTypeCheckbox, + TemplateCreateTemplateTemporaryTypeDate, + TemplateCreateTemplateTemporaryTypeDropdown, + TemplateCreateTemplateTemporaryTypeEmail, + TemplateCreateTemplateTemporaryTypeInitials, + TemplateCreateTemplateTemporaryTypeName, + TemplateCreateTemplateTemporaryTypeNumber, + TemplateCreateTemplateTemporaryTypeRadio, + TemplateCreateTemplateTemporaryTypeRequest, + TemplateCreateTemplateTemporaryTypeResponse, + TemplateCreateTemplateTemporaryTypeText, + TemplateCreateTemplateTemporaryUser, + TemplateCreateTemplateTemporaryUserTypedDict, + TemplateCreateTemplateTemporaryValue1, + TemplateCreateTemplateTemporaryValue1TypedDict, + TemplateCreateTemplateTemporaryValue2, + TemplateCreateTemplateTemporaryValue2TypedDict, + TemplateCreateTemplateTemporaryValue3, + TemplateCreateTemplateTemporaryValue3TypedDict, + TemplateCreateTemplateTemporaryVisibilityRequest, + TemplateCreateTemplateTemporaryVisibilityResponse, + ) from .template_deletetemplatedirectlinkop import ( TemplateDeleteTemplateDirectLinkBadRequestError, TemplateDeleteTemplateDirectLinkBadRequestErrorData, @@ -2425,6 +2580,7 @@ TemplateFindTemplatesDataTypedDict, TemplateFindTemplatesDirectLink, TemplateFindTemplatesDirectLinkTypedDict, + TemplateFindTemplatesDirection, TemplateFindTemplatesDistributionMethod, TemplateFindTemplatesField, TemplateFindTemplatesFieldMetaCheckbox, @@ -2500,9 +2656,6 @@ TemplateFindTemplatesVisibility, ) from .template_gettemplatebyidop import ( - TemplateDocumentData, - TemplateDocumentDataType, - TemplateDocumentDataTypedDict, TemplateGetTemplateByIDAccessAuth, TemplateGetTemplateByIDActionAuth, TemplateGetTemplateByIDAuthOptions, @@ -2513,6 +2666,7 @@ TemplateGetTemplateByIDBadRequestIssueTypedDict, TemplateGetTemplateByIDDirectLink, TemplateGetTemplateByIDDirectLinkTypedDict, + TemplateGetTemplateByIDDirection, TemplateGetTemplateByIDDistributionMethod, TemplateGetTemplateByIDEmailSettings, TemplateGetTemplateByIDEmailSettingsTypedDict, @@ -2566,6 +2720,9 @@ TemplateGetTemplateByIDSendStatus, TemplateGetTemplateByIDSigningOrder, TemplateGetTemplateByIDSigningStatus, + TemplateGetTemplateByIDTemplateDocumentData, + TemplateGetTemplateByIDTemplateDocumentDataType, + TemplateGetTemplateByIDTemplateDocumentDataTypedDict, TemplateGetTemplateByIDTemplateMeta, TemplateGetTemplateByIDTemplateMetaTypedDict, TemplateGetTemplateByIDTextAlign1, @@ -2645,10 +2802,11 @@ __all__ = [ "APIError", + "CustomDocumentDatum", + "CustomDocumentDatumTypedDict", "DataSource", "DataStatus", "DocumensoError", - "Document", "DocumentAccessAuth", "DocumentActionAuth", "DocumentCreateDocumentTemporaryAccessAuthRequest", @@ -2661,10 +2819,12 @@ "DocumentCreateDocumentTemporaryBadRequestIssueTypedDict", "DocumentCreateDocumentTemporaryDateFormat", "DocumentCreateDocumentTemporaryDistributionMethodRequest", + "DocumentCreateDocumentTemporaryDocument", "DocumentCreateDocumentTemporaryDocumentData", "DocumentCreateDocumentTemporaryDocumentDataTypedDict", "DocumentCreateDocumentTemporaryDocumentMeta", "DocumentCreateDocumentTemporaryDocumentMetaTypedDict", + "DocumentCreateDocumentTemporaryDocumentTypedDict", "DocumentCreateDocumentTemporaryEmailSettingsRequest", "DocumentCreateDocumentTemporaryEmailSettingsRequestTypedDict", "DocumentCreateDocumentTemporaryFieldCheckbox", @@ -2705,6 +2865,7 @@ "DocumentCreateDocumentTemporaryReadStatus", "DocumentCreateDocumentTemporaryRecipientAuthOptions", "DocumentCreateDocumentTemporaryRecipientAuthOptionsTypedDict", + "DocumentCreateDocumentTemporaryRecipientDirection", "DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox", "DocumentCreateDocumentTemporaryRecipientFieldMetaCheckboxTypedDict", "DocumentCreateDocumentTemporaryRecipientFieldMetaDate", @@ -2768,32 +2929,77 @@ "DocumentCreateDocumentTemporaryValueRadio", "DocumentCreateDocumentTemporaryValueRadioTypedDict", "DocumentCreateDocumentTemporaryVisibilityRequest", - "DocumentDeleteDocumentBadRequestError", - "DocumentDeleteDocumentBadRequestErrorData", - "DocumentDeleteDocumentBadRequestIssue", - "DocumentDeleteDocumentBadRequestIssueTypedDict", - "DocumentDeleteDocumentInternalServerError", - "DocumentDeleteDocumentInternalServerErrorData", - "DocumentDeleteDocumentInternalServerErrorIssue", - "DocumentDeleteDocumentInternalServerErrorIssueTypedDict", - "DocumentDeleteDocumentRequest", - "DocumentDeleteDocumentRequestTypedDict", - "DocumentDeleteDocumentResponse", - "DocumentDeleteDocumentResponseTypedDict", + "DocumentDeleteBadRequestError", + "DocumentDeleteBadRequestErrorData", + "DocumentDeleteBadRequestIssue", + "DocumentDeleteBadRequestIssueTypedDict", + "DocumentDeleteInternalServerError", + "DocumentDeleteInternalServerErrorData", + "DocumentDeleteInternalServerErrorIssue", + "DocumentDeleteInternalServerErrorIssueTypedDict", + "DocumentDeleteRequest", + "DocumentDeleteRequestTypedDict", + "DocumentDeleteResponse", + "DocumentDeleteResponseTypedDict", + "DocumentDirection", + "DocumentDistributeAuthOptions", + "DocumentDistributeAuthOptionsTypedDict", + "DocumentDistributeBadRequestError", + "DocumentDistributeBadRequestErrorData", + "DocumentDistributeBadRequestIssue", + "DocumentDistributeBadRequestIssueTypedDict", + "DocumentDistributeDateFormat", + "DocumentDistributeDistributionMethod", + "DocumentDistributeEmailSettings", + "DocumentDistributeEmailSettingsTypedDict", + "DocumentDistributeFormValues", + "DocumentDistributeFormValuesTypedDict", + "DocumentDistributeGlobalAccessAuth", + "DocumentDistributeGlobalActionAuth", + "DocumentDistributeInternalServerError", + "DocumentDistributeInternalServerErrorData", + "DocumentDistributeInternalServerErrorIssue", + "DocumentDistributeInternalServerErrorIssueTypedDict", + "DocumentDistributeLanguage", + "DocumentDistributeMeta", + "DocumentDistributeMetaTypedDict", + "DocumentDistributeRequest", + "DocumentDistributeRequestTypedDict", + "DocumentDistributeResponse", + "DocumentDistributeResponseTypedDict", + "DocumentDistributeSource", + "DocumentDistributeStatus", + "DocumentDistributeVisibility", "DocumentDistributionMethod", "DocumentDocumentDataType", - "DocumentDuplicateDocumentBadRequestError", - "DocumentDuplicateDocumentBadRequestErrorData", - "DocumentDuplicateDocumentBadRequestIssue", - "DocumentDuplicateDocumentBadRequestIssueTypedDict", - "DocumentDuplicateDocumentInternalServerError", - "DocumentDuplicateDocumentInternalServerErrorData", - "DocumentDuplicateDocumentInternalServerErrorIssue", - "DocumentDuplicateDocumentInternalServerErrorIssueTypedDict", - "DocumentDuplicateDocumentRequest", - "DocumentDuplicateDocumentRequestTypedDict", - "DocumentDuplicateDocumentResponse", - "DocumentDuplicateDocumentResponseTypedDict", + "DocumentDownloadBadRequestError", + "DocumentDownloadBadRequestErrorData", + "DocumentDownloadBadRequestIssue", + "DocumentDownloadBadRequestIssueTypedDict", + "DocumentDownloadInternalServerError", + "DocumentDownloadInternalServerErrorData", + "DocumentDownloadInternalServerErrorIssue", + "DocumentDownloadInternalServerErrorIssueTypedDict", + "DocumentDownloadNotFoundError", + "DocumentDownloadNotFoundErrorData", + "DocumentDownloadNotFoundIssue", + "DocumentDownloadNotFoundIssueTypedDict", + "DocumentDownloadRequest", + "DocumentDownloadRequestTypedDict", + "DocumentDownloadResponse", + "DocumentDownloadResponseTypedDict", + "DocumentDuplicateBadRequestError", + "DocumentDuplicateBadRequestErrorData", + "DocumentDuplicateBadRequestIssue", + "DocumentDuplicateBadRequestIssueTypedDict", + "DocumentDuplicateInternalServerError", + "DocumentDuplicateInternalServerErrorData", + "DocumentDuplicateInternalServerErrorIssue", + "DocumentDuplicateInternalServerErrorIssueTypedDict", + "DocumentDuplicateRequest", + "DocumentDuplicateRequestTypedDict", + "DocumentDuplicateResponse", + "DocumentDuplicateResponseTypedDict", "DocumentEmailSettings", "DocumentEmailSettingsTypedDict", "DocumentField", @@ -2801,186 +3007,159 @@ "DocumentFieldMetaUnionTypedDict", "DocumentFieldType", "DocumentFieldTypedDict", - "DocumentFindDocumentsAccessAuth", - "DocumentFindDocumentsActionAuth", - "DocumentFindDocumentsAuthOptions", - "DocumentFindDocumentsAuthOptionsTypedDict", - "DocumentFindDocumentsBadRequestError", - "DocumentFindDocumentsBadRequestErrorData", - "DocumentFindDocumentsBadRequestIssue", - "DocumentFindDocumentsBadRequestIssueTypedDict", - "DocumentFindDocumentsData", - "DocumentFindDocumentsDataTypedDict", - "DocumentFindDocumentsFormValues", - "DocumentFindDocumentsFormValuesTypedDict", - "DocumentFindDocumentsGlobalAccessAuth", - "DocumentFindDocumentsGlobalActionAuth", - "DocumentFindDocumentsInternalServerError", - "DocumentFindDocumentsInternalServerErrorData", - "DocumentFindDocumentsInternalServerErrorIssue", - "DocumentFindDocumentsInternalServerErrorIssueTypedDict", - "DocumentFindDocumentsNotFoundError", - "DocumentFindDocumentsNotFoundErrorData", - "DocumentFindDocumentsNotFoundIssue", - "DocumentFindDocumentsNotFoundIssueTypedDict", - "DocumentFindDocumentsReadStatus", - "DocumentFindDocumentsRecipient", - "DocumentFindDocumentsRecipientAuthOptions", - "DocumentFindDocumentsRecipientAuthOptionsTypedDict", - "DocumentFindDocumentsRecipientTypedDict", - "DocumentFindDocumentsRequest", - "DocumentFindDocumentsRequestTypedDict", - "DocumentFindDocumentsResponse", - "DocumentFindDocumentsResponseTypedDict", - "DocumentFindDocumentsRole", - "DocumentFindDocumentsSendStatus", - "DocumentFindDocumentsSigningStatus", - "DocumentFindDocumentsTeam", - "DocumentFindDocumentsTeamTypedDict", - "DocumentFindDocumentsUser", - "DocumentFindDocumentsUserTypedDict", - "DocumentFindDocumentsVisibility", + "DocumentFindAccessAuth", + "DocumentFindActionAuth", + "DocumentFindAuthOptions", + "DocumentFindAuthOptionsTypedDict", + "DocumentFindBadRequestError", + "DocumentFindBadRequestErrorData", + "DocumentFindBadRequestIssue", + "DocumentFindBadRequestIssueTypedDict", + "DocumentFindData", + "DocumentFindDataTypedDict", + "DocumentFindFormValues", + "DocumentFindFormValuesTypedDict", + "DocumentFindGlobalAccessAuth", + "DocumentFindGlobalActionAuth", + "DocumentFindInternalServerError", + "DocumentFindInternalServerErrorData", + "DocumentFindInternalServerErrorIssue", + "DocumentFindInternalServerErrorIssueTypedDict", + "DocumentFindNotFoundError", + "DocumentFindNotFoundErrorData", + "DocumentFindNotFoundIssue", + "DocumentFindNotFoundIssueTypedDict", + "DocumentFindReadStatus", + "DocumentFindRecipient", + "DocumentFindRecipientAuthOptions", + "DocumentFindRecipientAuthOptionsTypedDict", + "DocumentFindRecipientTypedDict", + "DocumentFindRequest", + "DocumentFindRequestTypedDict", + "DocumentFindResponse", + "DocumentFindResponseTypedDict", + "DocumentFindRole", + "DocumentFindSendStatus", + "DocumentFindSigningStatus", + "DocumentFindTeam", + "DocumentFindTeamTypedDict", + "DocumentFindUser", + "DocumentFindUserTypedDict", + "DocumentFindVisibility", "DocumentFolderType", "DocumentFolderVisibility", "DocumentFormValues", "DocumentFormValuesTypedDict", - "DocumentGetDocumentWithDetailsByIDAccessAuth", - "DocumentGetDocumentWithDetailsByIDActionAuth", - "DocumentGetDocumentWithDetailsByIDAuthOptions", - "DocumentGetDocumentWithDetailsByIDAuthOptionsTypedDict", - "DocumentGetDocumentWithDetailsByIDBadRequestError", - "DocumentGetDocumentWithDetailsByIDBadRequestErrorData", - "DocumentGetDocumentWithDetailsByIDBadRequestIssue", - "DocumentGetDocumentWithDetailsByIDBadRequestIssueTypedDict", - "DocumentGetDocumentWithDetailsByIDDistributionMethod", - "DocumentGetDocumentWithDetailsByIDDocumentData", - "DocumentGetDocumentWithDetailsByIDDocumentDataType", - "DocumentGetDocumentWithDetailsByIDDocumentDataTypedDict", - "DocumentGetDocumentWithDetailsByIDDocumentMeta", - "DocumentGetDocumentWithDetailsByIDDocumentMetaTypedDict", - "DocumentGetDocumentWithDetailsByIDEmailSettings", - "DocumentGetDocumentWithDetailsByIDEmailSettingsTypedDict", - "DocumentGetDocumentWithDetailsByIDField", - "DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox", - "DocumentGetDocumentWithDetailsByIDFieldMetaCheckboxTypedDict", - "DocumentGetDocumentWithDetailsByIDFieldMetaDate", - "DocumentGetDocumentWithDetailsByIDFieldMetaDateTypedDict", - "DocumentGetDocumentWithDetailsByIDFieldMetaDropdown", - "DocumentGetDocumentWithDetailsByIDFieldMetaDropdownTypedDict", - "DocumentGetDocumentWithDetailsByIDFieldMetaEmail", - "DocumentGetDocumentWithDetailsByIDFieldMetaEmailTypedDict", - "DocumentGetDocumentWithDetailsByIDFieldMetaInitials", - "DocumentGetDocumentWithDetailsByIDFieldMetaInitialsTypedDict", - "DocumentGetDocumentWithDetailsByIDFieldMetaName", - "DocumentGetDocumentWithDetailsByIDFieldMetaNameTypedDict", - "DocumentGetDocumentWithDetailsByIDFieldMetaNumber", - "DocumentGetDocumentWithDetailsByIDFieldMetaNumberTypedDict", - "DocumentGetDocumentWithDetailsByIDFieldMetaRadio", - "DocumentGetDocumentWithDetailsByIDFieldMetaRadioTypedDict", - "DocumentGetDocumentWithDetailsByIDFieldMetaText", - "DocumentGetDocumentWithDetailsByIDFieldMetaTextTypedDict", - "DocumentGetDocumentWithDetailsByIDFieldMetaUnion", - "DocumentGetDocumentWithDetailsByIDFieldMetaUnionTypedDict", - "DocumentGetDocumentWithDetailsByIDFieldType", - "DocumentGetDocumentWithDetailsByIDFieldTypedDict", - "DocumentGetDocumentWithDetailsByIDFolder", - "DocumentGetDocumentWithDetailsByIDFolderType", - "DocumentGetDocumentWithDetailsByIDFolderTypedDict", - "DocumentGetDocumentWithDetailsByIDFolderVisibility", - "DocumentGetDocumentWithDetailsByIDFormValues", - "DocumentGetDocumentWithDetailsByIDFormValuesTypedDict", - "DocumentGetDocumentWithDetailsByIDGlobalAccessAuth", - "DocumentGetDocumentWithDetailsByIDGlobalActionAuth", - "DocumentGetDocumentWithDetailsByIDInternalServerError", - "DocumentGetDocumentWithDetailsByIDInternalServerErrorData", - "DocumentGetDocumentWithDetailsByIDInternalServerErrorIssue", - "DocumentGetDocumentWithDetailsByIDInternalServerErrorIssueTypedDict", - "DocumentGetDocumentWithDetailsByIDNotFoundError", - "DocumentGetDocumentWithDetailsByIDNotFoundErrorData", - "DocumentGetDocumentWithDetailsByIDNotFoundIssue", - "DocumentGetDocumentWithDetailsByIDNotFoundIssueTypedDict", - "DocumentGetDocumentWithDetailsByIDReadStatus", - "DocumentGetDocumentWithDetailsByIDRecipient", - "DocumentGetDocumentWithDetailsByIDRecipientAuthOptions", - "DocumentGetDocumentWithDetailsByIDRecipientAuthOptionsTypedDict", - "DocumentGetDocumentWithDetailsByIDRecipientTypedDict", - "DocumentGetDocumentWithDetailsByIDRequest", - "DocumentGetDocumentWithDetailsByIDRequestTypedDict", - "DocumentGetDocumentWithDetailsByIDResponse", - "DocumentGetDocumentWithDetailsByIDResponseTypedDict", - "DocumentGetDocumentWithDetailsByIDRole", - "DocumentGetDocumentWithDetailsByIDSendStatus", - "DocumentGetDocumentWithDetailsByIDSigningOrder", - "DocumentGetDocumentWithDetailsByIDSigningStatus", - "DocumentGetDocumentWithDetailsByIDSource", - "DocumentGetDocumentWithDetailsByIDStatus", - "DocumentGetDocumentWithDetailsByIDTextAlign1", - "DocumentGetDocumentWithDetailsByIDTextAlign2", - "DocumentGetDocumentWithDetailsByIDTextAlign3", - "DocumentGetDocumentWithDetailsByIDTextAlign4", - "DocumentGetDocumentWithDetailsByIDTextAlign5", - "DocumentGetDocumentWithDetailsByIDTextAlign6", - "DocumentGetDocumentWithDetailsByIDTypeCheckbox", - "DocumentGetDocumentWithDetailsByIDTypeDate", - "DocumentGetDocumentWithDetailsByIDTypeDropdown", - "DocumentGetDocumentWithDetailsByIDTypeEmail", - "DocumentGetDocumentWithDetailsByIDTypeInitials", - "DocumentGetDocumentWithDetailsByIDTypeName", - "DocumentGetDocumentWithDetailsByIDTypeNumber", - "DocumentGetDocumentWithDetailsByIDTypeRadio", - "DocumentGetDocumentWithDetailsByIDTypeText", - "DocumentGetDocumentWithDetailsByIDValue1", - "DocumentGetDocumentWithDetailsByIDValue1TypedDict", - "DocumentGetDocumentWithDetailsByIDValue2", - "DocumentGetDocumentWithDetailsByIDValue2TypedDict", - "DocumentGetDocumentWithDetailsByIDValue3", - "DocumentGetDocumentWithDetailsByIDValue3TypedDict", - "DocumentGetDocumentWithDetailsByIDVisibility", + "DocumentGetAccessAuth", + "DocumentGetActionAuth", + "DocumentGetAuthOptions", + "DocumentGetAuthOptionsTypedDict", + "DocumentGetBadRequestError", + "DocumentGetBadRequestErrorData", + "DocumentGetBadRequestIssue", + "DocumentGetBadRequestIssueTypedDict", + "DocumentGetDirection", + "DocumentGetDistributionMethod", + "DocumentGetDocumentData", + "DocumentGetDocumentDataType", + "DocumentGetDocumentDataTypedDict", + "DocumentGetDocumentMeta", + "DocumentGetDocumentMetaTypedDict", + "DocumentGetEmailSettings", + "DocumentGetEmailSettingsTypedDict", + "DocumentGetField", + "DocumentGetFieldMetaCheckbox", + "DocumentGetFieldMetaCheckboxTypedDict", + "DocumentGetFieldMetaDate", + "DocumentGetFieldMetaDateTypedDict", + "DocumentGetFieldMetaDropdown", + "DocumentGetFieldMetaDropdownTypedDict", + "DocumentGetFieldMetaEmail", + "DocumentGetFieldMetaEmailTypedDict", + "DocumentGetFieldMetaInitials", + "DocumentGetFieldMetaInitialsTypedDict", + "DocumentGetFieldMetaName", + "DocumentGetFieldMetaNameTypedDict", + "DocumentGetFieldMetaNumber", + "DocumentGetFieldMetaNumberTypedDict", + "DocumentGetFieldMetaRadio", + "DocumentGetFieldMetaRadioTypedDict", + "DocumentGetFieldMetaText", + "DocumentGetFieldMetaTextTypedDict", + "DocumentGetFieldMetaUnion", + "DocumentGetFieldMetaUnionTypedDict", + "DocumentGetFieldType", + "DocumentGetFieldTypedDict", + "DocumentGetFolder", + "DocumentGetFolderType", + "DocumentGetFolderTypedDict", + "DocumentGetFolderVisibility", + "DocumentGetFormValues", + "DocumentGetFormValuesTypedDict", + "DocumentGetGlobalAccessAuth", + "DocumentGetGlobalActionAuth", + "DocumentGetInternalServerError", + "DocumentGetInternalServerErrorData", + "DocumentGetInternalServerErrorIssue", + "DocumentGetInternalServerErrorIssueTypedDict", + "DocumentGetNotFoundError", + "DocumentGetNotFoundErrorData", + "DocumentGetNotFoundIssue", + "DocumentGetNotFoundIssueTypedDict", + "DocumentGetReadStatus", + "DocumentGetRecipient", + "DocumentGetRecipientAuthOptions", + "DocumentGetRecipientAuthOptionsTypedDict", + "DocumentGetRecipientTypedDict", + "DocumentGetRequest", + "DocumentGetRequestTypedDict", + "DocumentGetResponse", + "DocumentGetResponseTypedDict", + "DocumentGetRole", + "DocumentGetSendStatus", + "DocumentGetSigningOrder", + "DocumentGetSigningStatus", + "DocumentGetSource", + "DocumentGetStatus", + "DocumentGetTextAlign1", + "DocumentGetTextAlign2", + "DocumentGetTextAlign3", + "DocumentGetTextAlign4", + "DocumentGetTextAlign5", + "DocumentGetTextAlign6", + "DocumentGetTypeCheckbox", + "DocumentGetTypeDate", + "DocumentGetTypeDropdown", + "DocumentGetTypeEmail", + "DocumentGetTypeInitials", + "DocumentGetTypeName", + "DocumentGetTypeNumber", + "DocumentGetTypeRadio", + "DocumentGetTypeText", + "DocumentGetValue1", + "DocumentGetValue1TypedDict", + "DocumentGetValue2", + "DocumentGetValue2TypedDict", + "DocumentGetValue3", + "DocumentGetValue3TypedDict", + "DocumentGetVisibility", "DocumentGlobalAccessAuth", "DocumentGlobalActionAuth", "DocumentRecipient", "DocumentRecipientTypedDict", - "DocumentResendDocumentBadRequestError", - "DocumentResendDocumentBadRequestErrorData", - "DocumentResendDocumentBadRequestIssue", - "DocumentResendDocumentBadRequestIssueTypedDict", - "DocumentResendDocumentInternalServerError", - "DocumentResendDocumentInternalServerErrorData", - "DocumentResendDocumentInternalServerErrorIssue", - "DocumentResendDocumentInternalServerErrorIssueTypedDict", - "DocumentResendDocumentRequest", - "DocumentResendDocumentRequestTypedDict", - "DocumentResendDocumentResponse", - "DocumentResendDocumentResponseTypedDict", + "DocumentRedistributeBadRequestError", + "DocumentRedistributeBadRequestErrorData", + "DocumentRedistributeBadRequestIssue", + "DocumentRedistributeBadRequestIssueTypedDict", + "DocumentRedistributeInternalServerError", + "DocumentRedistributeInternalServerErrorData", + "DocumentRedistributeInternalServerErrorIssue", + "DocumentRedistributeInternalServerErrorIssueTypedDict", + "DocumentRedistributeRequest", + "DocumentRedistributeRequestTypedDict", + "DocumentRedistributeResponse", + "DocumentRedistributeResponseTypedDict", "DocumentRole", - "DocumentSendDocumentAuthOptions", - "DocumentSendDocumentAuthOptionsTypedDict", - "DocumentSendDocumentBadRequestError", - "DocumentSendDocumentBadRequestErrorData", - "DocumentSendDocumentBadRequestIssue", - "DocumentSendDocumentBadRequestIssueTypedDict", - "DocumentSendDocumentDateFormat", - "DocumentSendDocumentDistributionMethod", - "DocumentSendDocumentEmailSettings", - "DocumentSendDocumentEmailSettingsTypedDict", - "DocumentSendDocumentFormValues", - "DocumentSendDocumentFormValuesTypedDict", - "DocumentSendDocumentGlobalAccessAuth", - "DocumentSendDocumentGlobalActionAuth", - "DocumentSendDocumentInternalServerError", - "DocumentSendDocumentInternalServerErrorData", - "DocumentSendDocumentInternalServerErrorIssue", - "DocumentSendDocumentInternalServerErrorIssueTypedDict", - "DocumentSendDocumentLanguage", - "DocumentSendDocumentMeta", - "DocumentSendDocumentMetaTypedDict", - "DocumentSendDocumentRequest", - "DocumentSendDocumentRequestTypedDict", - "DocumentSendDocumentResponse", - "DocumentSendDocumentResponseTypedDict", - "DocumentSendDocumentSource", - "DocumentSendDocumentStatus", - "DocumentSendDocumentVisibility", "DocumentSigningOrder", "DocumentTextAlign1", "DocumentTextAlign2", @@ -2997,41 +3176,40 @@ "DocumentTypeNumber", "DocumentTypeRadio", "DocumentTypeText", - "DocumentTypedDict", - "DocumentUpdateDocumentAuthOptions", - "DocumentUpdateDocumentAuthOptionsTypedDict", - "DocumentUpdateDocumentBadRequestError", - "DocumentUpdateDocumentBadRequestErrorData", - "DocumentUpdateDocumentBadRequestIssue", - "DocumentUpdateDocumentBadRequestIssueTypedDict", - "DocumentUpdateDocumentData", - "DocumentUpdateDocumentDataTypedDict", - "DocumentUpdateDocumentDateFormat", - "DocumentUpdateDocumentDistributionMethod", - "DocumentUpdateDocumentEmailSettings", - "DocumentUpdateDocumentEmailSettingsTypedDict", - "DocumentUpdateDocumentFormValues", - "DocumentUpdateDocumentFormValuesTypedDict", - "DocumentUpdateDocumentGlobalAccessAuthRequest", - "DocumentUpdateDocumentGlobalAccessAuthResponse", - "DocumentUpdateDocumentGlobalActionAuthRequest", - "DocumentUpdateDocumentGlobalActionAuthResponse", - "DocumentUpdateDocumentInternalServerError", - "DocumentUpdateDocumentInternalServerErrorData", - "DocumentUpdateDocumentInternalServerErrorIssue", - "DocumentUpdateDocumentInternalServerErrorIssueTypedDict", - "DocumentUpdateDocumentLanguage", - "DocumentUpdateDocumentMeta", - "DocumentUpdateDocumentMetaTypedDict", - "DocumentUpdateDocumentRequest", - "DocumentUpdateDocumentRequestTypedDict", - "DocumentUpdateDocumentResponse", - "DocumentUpdateDocumentResponseTypedDict", - "DocumentUpdateDocumentSigningOrder", - "DocumentUpdateDocumentSource", - "DocumentUpdateDocumentStatus", - "DocumentUpdateDocumentVisibilityRequest", - "DocumentUpdateDocumentVisibilityResponse", + "DocumentUpdateAuthOptions", + "DocumentUpdateAuthOptionsTypedDict", + "DocumentUpdateBadRequestError", + "DocumentUpdateBadRequestErrorData", + "DocumentUpdateBadRequestIssue", + "DocumentUpdateBadRequestIssueTypedDict", + "DocumentUpdateData", + "DocumentUpdateDataTypedDict", + "DocumentUpdateDateFormat", + "DocumentUpdateDistributionMethod", + "DocumentUpdateEmailSettings", + "DocumentUpdateEmailSettingsTypedDict", + "DocumentUpdateFormValues", + "DocumentUpdateFormValuesTypedDict", + "DocumentUpdateGlobalAccessAuthRequest", + "DocumentUpdateGlobalAccessAuthResponse", + "DocumentUpdateGlobalActionAuthRequest", + "DocumentUpdateGlobalActionAuthResponse", + "DocumentUpdateInternalServerError", + "DocumentUpdateInternalServerErrorData", + "DocumentUpdateInternalServerErrorIssue", + "DocumentUpdateInternalServerErrorIssueTypedDict", + "DocumentUpdateLanguage", + "DocumentUpdateMeta", + "DocumentUpdateMetaTypedDict", + "DocumentUpdateRequest", + "DocumentUpdateRequestTypedDict", + "DocumentUpdateResponse", + "DocumentUpdateResponseTypedDict", + "DocumentUpdateSigningOrder", + "DocumentUpdateSource", + "DocumentUpdateStatus", + "DocumentUpdateVisibilityRequest", + "DocumentUpdateVisibilityResponse", "DocumentValue1", "DocumentValue1TypedDict", "DocumentValue2", @@ -3067,6 +3245,8 @@ "FieldCreateDocumentFieldBadRequestErrorData", "FieldCreateDocumentFieldBadRequestIssue", "FieldCreateDocumentFieldBadRequestIssueTypedDict", + "FieldCreateDocumentFieldDirectionRequest", + "FieldCreateDocumentFieldDirectionResponse", "FieldCreateDocumentFieldFieldCheckbox", "FieldCreateDocumentFieldFieldCheckboxTypedDict", "FieldCreateDocumentFieldFieldDate", @@ -3195,6 +3375,8 @@ "FieldCreateDocumentFieldsBadRequestErrorData", "FieldCreateDocumentFieldsBadRequestIssue", "FieldCreateDocumentFieldsBadRequestIssueTypedDict", + "FieldCreateDocumentFieldsDirectionRequest", + "FieldCreateDocumentFieldsDirectionResponse", "FieldCreateDocumentFieldsFieldCheckbox", "FieldCreateDocumentFieldsFieldCheckboxTypedDict", "FieldCreateDocumentFieldsFieldDate", @@ -3325,6 +3507,8 @@ "FieldCreateTemplateFieldBadRequestErrorData", "FieldCreateTemplateFieldBadRequestIssue", "FieldCreateTemplateFieldBadRequestIssueTypedDict", + "FieldCreateTemplateFieldDirectionRequest", + "FieldCreateTemplateFieldDirectionResponse", "FieldCreateTemplateFieldFieldCheckbox", "FieldCreateTemplateFieldFieldCheckboxTypedDict", "FieldCreateTemplateFieldFieldDate", @@ -3453,6 +3637,8 @@ "FieldCreateTemplateFieldsBadRequestErrorData", "FieldCreateTemplateFieldsBadRequestIssue", "FieldCreateTemplateFieldsBadRequestIssueTypedDict", + "FieldCreateTemplateFieldsDirectionRequest", + "FieldCreateTemplateFieldsDirectionResponse", "FieldCreateTemplateFieldsFieldCheckbox", "FieldCreateTemplateFieldsFieldCheckboxTypedDict", "FieldCreateTemplateFieldsFieldDate", @@ -3607,6 +3793,7 @@ "FieldGetDocumentFieldBadRequestErrorData", "FieldGetDocumentFieldBadRequestIssue", "FieldGetDocumentFieldBadRequestIssueTypedDict", + "FieldGetDocumentFieldDirection", "FieldGetDocumentFieldFieldMetaCheckbox", "FieldGetDocumentFieldFieldMetaCheckboxTypedDict", "FieldGetDocumentFieldFieldMetaDate", @@ -3665,6 +3852,7 @@ "FieldGetTemplateFieldBadRequestErrorData", "FieldGetTemplateFieldBadRequestIssue", "FieldGetTemplateFieldBadRequestIssueTypedDict", + "FieldGetTemplateFieldDirection", "FieldGetTemplateFieldFieldMetaCheckbox", "FieldGetTemplateFieldFieldMetaCheckboxTypedDict", "FieldGetTemplateFieldFieldMetaDate", @@ -3741,6 +3929,8 @@ "FieldUpdateDocumentFieldBadRequestErrorData", "FieldUpdateDocumentFieldBadRequestIssue", "FieldUpdateDocumentFieldBadRequestIssueTypedDict", + "FieldUpdateDocumentFieldDirectionRequest", + "FieldUpdateDocumentFieldDirectionResponse", "FieldUpdateDocumentFieldFieldCheckbox", "FieldUpdateDocumentFieldFieldCheckboxTypedDict", "FieldUpdateDocumentFieldFieldDate", @@ -3869,6 +4059,8 @@ "FieldUpdateDocumentFieldsBadRequestErrorData", "FieldUpdateDocumentFieldsBadRequestIssue", "FieldUpdateDocumentFieldsBadRequestIssueTypedDict", + "FieldUpdateDocumentFieldsDirectionRequest", + "FieldUpdateDocumentFieldsDirectionResponse", "FieldUpdateDocumentFieldsFieldCheckbox", "FieldUpdateDocumentFieldsFieldCheckboxTypedDict", "FieldUpdateDocumentFieldsFieldDate", @@ -3999,6 +4191,8 @@ "FieldUpdateTemplateFieldBadRequestErrorData", "FieldUpdateTemplateFieldBadRequestIssue", "FieldUpdateTemplateFieldBadRequestIssueTypedDict", + "FieldUpdateTemplateFieldDirectionRequest", + "FieldUpdateTemplateFieldDirectionResponse", "FieldUpdateTemplateFieldFieldCheckbox", "FieldUpdateTemplateFieldFieldCheckboxTypedDict", "FieldUpdateTemplateFieldFieldDate", @@ -4127,6 +4321,8 @@ "FieldUpdateTemplateFieldsBadRequestErrorData", "FieldUpdateTemplateFieldsBadRequestIssue", "FieldUpdateTemplateFieldsBadRequestIssueTypedDict", + "FieldUpdateTemplateFieldsDirectionRequest", + "FieldUpdateTemplateFieldsDirectionResponse", "FieldUpdateTemplateFieldsFieldCheckbox", "FieldUpdateTemplateFieldsFieldCheckboxTypedDict", "FieldUpdateTemplateFieldsFieldDate", @@ -4417,6 +4613,7 @@ "RecipientGetDocumentRecipientBadRequestErrorData", "RecipientGetDocumentRecipientBadRequestIssue", "RecipientGetDocumentRecipientBadRequestIssueTypedDict", + "RecipientGetDocumentRecipientDirection", "RecipientGetDocumentRecipientField", "RecipientGetDocumentRecipientFieldMetaCheckbox", "RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict", @@ -4485,6 +4682,7 @@ "RecipientGetTemplateRecipientBadRequestErrorData", "RecipientGetTemplateRecipientBadRequestIssue", "RecipientGetTemplateRecipientBadRequestIssueTypedDict", + "RecipientGetTemplateRecipientDirection", "RecipientGetTemplateRecipientField", "RecipientGetTemplateRecipientFieldMetaCheckbox", "RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict", @@ -4555,6 +4753,7 @@ "RecipientUpdateDocumentRecipientBadRequestErrorData", "RecipientUpdateDocumentRecipientBadRequestIssue", "RecipientUpdateDocumentRecipientBadRequestIssueTypedDict", + "RecipientUpdateDocumentRecipientDirection", "RecipientUpdateDocumentRecipientField", "RecipientUpdateDocumentRecipientFieldMetaCheckbox", "RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict", @@ -4624,6 +4823,7 @@ "RecipientUpdateDocumentRecipientsBadRequestErrorData", "RecipientUpdateDocumentRecipientsBadRequestIssue", "RecipientUpdateDocumentRecipientsBadRequestIssueTypedDict", + "RecipientUpdateDocumentRecipientsDirection", "RecipientUpdateDocumentRecipientsField", "RecipientUpdateDocumentRecipientsFieldMetaCheckbox", "RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict", @@ -4695,6 +4895,7 @@ "RecipientUpdateTemplateRecipientBadRequestErrorData", "RecipientUpdateTemplateRecipientBadRequestIssue", "RecipientUpdateTemplateRecipientBadRequestIssueTypedDict", + "RecipientUpdateTemplateRecipientDirection", "RecipientUpdateTemplateRecipientField", "RecipientUpdateTemplateRecipientFieldMetaCheckbox", "RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict", @@ -4764,6 +4965,7 @@ "RecipientUpdateTemplateRecipientsBadRequestErrorData", "RecipientUpdateTemplateRecipientsBadRequestIssue", "RecipientUpdateTemplateRecipientsBadRequestIssueTypedDict", + "RecipientUpdateTemplateRecipientsDirection", "RecipientUpdateTemplateRecipientsField", "RecipientUpdateTemplateRecipientsFieldMetaCheckbox", "RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict", @@ -4836,6 +5038,7 @@ "TemplateCreateDocumentFromTemplateBadRequestErrorData", "TemplateCreateDocumentFromTemplateBadRequestIssue", "TemplateCreateDocumentFromTemplateBadRequestIssueTypedDict", + "TemplateCreateDocumentFromTemplateDirection", "TemplateCreateDocumentFromTemplateDistributionMethod", "TemplateCreateDocumentFromTemplateDocumentData", "TemplateCreateDocumentFromTemplateDocumentDataType", @@ -4930,6 +5133,110 @@ "TemplateCreateTemplateDirectLinkRequestTypedDict", "TemplateCreateTemplateDirectLinkResponse", "TemplateCreateTemplateDirectLinkResponseTypedDict", + "TemplateCreateTemplateTemporaryAccessAuth", + "TemplateCreateTemplateTemporaryActionAuth", + "TemplateCreateTemplateTemporaryAuthOptions", + "TemplateCreateTemplateTemporaryAuthOptionsTypedDict", + "TemplateCreateTemplateTemporaryBadRequestError", + "TemplateCreateTemplateTemporaryBadRequestErrorData", + "TemplateCreateTemplateTemporaryBadRequestIssue", + "TemplateCreateTemplateTemporaryBadRequestIssueTypedDict", + "TemplateCreateTemplateTemporaryDateFormat", + "TemplateCreateTemplateTemporaryDirectLink", + "TemplateCreateTemplateTemporaryDirectLinkTypedDict", + "TemplateCreateTemplateTemporaryDirection", + "TemplateCreateTemplateTemporaryDistributionMethodRequest", + "TemplateCreateTemplateTemporaryEmailSettingsRequest", + "TemplateCreateTemplateTemporaryEmailSettingsRequestTypedDict", + "TemplateCreateTemplateTemporaryField", + "TemplateCreateTemplateTemporaryFieldMetaCheckbox", + "TemplateCreateTemplateTemporaryFieldMetaCheckboxTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaDate", + "TemplateCreateTemplateTemporaryFieldMetaDateTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaDropdown", + "TemplateCreateTemplateTemporaryFieldMetaDropdownTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaEmail", + "TemplateCreateTemplateTemporaryFieldMetaEmailTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaInitials", + "TemplateCreateTemplateTemporaryFieldMetaInitialsTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaName", + "TemplateCreateTemplateTemporaryFieldMetaNameTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaNumber", + "TemplateCreateTemplateTemporaryFieldMetaNumberTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaRadio", + "TemplateCreateTemplateTemporaryFieldMetaRadioTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaText", + "TemplateCreateTemplateTemporaryFieldMetaTextTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaUnion", + "TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict", + "TemplateCreateTemplateTemporaryFieldType", + "TemplateCreateTemplateTemporaryFieldTypedDict", + "TemplateCreateTemplateTemporaryFolder", + "TemplateCreateTemplateTemporaryFolderType", + "TemplateCreateTemplateTemporaryFolderTypedDict", + "TemplateCreateTemplateTemporaryFolderVisibility", + "TemplateCreateTemplateTemporaryGlobalAccessAuthRequest", + "TemplateCreateTemplateTemporaryGlobalAccessAuthResponse", + "TemplateCreateTemplateTemporaryGlobalActionAuthRequest", + "TemplateCreateTemplateTemporaryGlobalActionAuthResponse", + "TemplateCreateTemplateTemporaryInternalServerError", + "TemplateCreateTemplateTemporaryInternalServerErrorData", + "TemplateCreateTemplateTemporaryInternalServerErrorIssue", + "TemplateCreateTemplateTemporaryInternalServerErrorIssueTypedDict", + "TemplateCreateTemplateTemporaryLanguage", + "TemplateCreateTemplateTemporaryMeta", + "TemplateCreateTemplateTemporaryMetaTypedDict", + "TemplateCreateTemplateTemporaryReadStatus", + "TemplateCreateTemplateTemporaryRecipient", + "TemplateCreateTemplateTemporaryRecipientAuthOptions", + "TemplateCreateTemplateTemporaryRecipientAuthOptionsTypedDict", + "TemplateCreateTemplateTemporaryRecipientTypedDict", + "TemplateCreateTemplateTemporaryRequest", + "TemplateCreateTemplateTemporaryRequestTypedDict", + "TemplateCreateTemplateTemporaryResponse", + "TemplateCreateTemplateTemporaryResponseTypedDict", + "TemplateCreateTemplateTemporaryRole", + "TemplateCreateTemplateTemporarySendStatus", + "TemplateCreateTemplateTemporarySigningOrderRequest", + "TemplateCreateTemplateTemporarySigningStatus", + "TemplateCreateTemplateTemporaryTemplate", + "TemplateCreateTemplateTemporaryTemplateDocumentData", + "TemplateCreateTemplateTemporaryTemplateDocumentDataType", + "TemplateCreateTemplateTemporaryTemplateDocumentDataTypedDict", + "TemplateCreateTemplateTemporaryTemplateMeta", + "TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod", + "TemplateCreateTemplateTemporaryTemplateMetaEmailSettings", + "TemplateCreateTemplateTemporaryTemplateMetaEmailSettingsTypedDict", + "TemplateCreateTemplateTemporaryTemplateMetaSigningOrder", + "TemplateCreateTemplateTemporaryTemplateMetaTypedDict", + "TemplateCreateTemplateTemporaryTemplateTypedDict", + "TemplateCreateTemplateTemporaryTextAlign1", + "TemplateCreateTemplateTemporaryTextAlign2", + "TemplateCreateTemplateTemporaryTextAlign3", + "TemplateCreateTemplateTemporaryTextAlign4", + "TemplateCreateTemplateTemporaryTextAlign5", + "TemplateCreateTemplateTemporaryTextAlign6", + "TemplateCreateTemplateTemporaryTypeCheckbox", + "TemplateCreateTemplateTemporaryTypeDate", + "TemplateCreateTemplateTemporaryTypeDropdown", + "TemplateCreateTemplateTemporaryTypeEmail", + "TemplateCreateTemplateTemporaryTypeInitials", + "TemplateCreateTemplateTemporaryTypeName", + "TemplateCreateTemplateTemporaryTypeNumber", + "TemplateCreateTemplateTemporaryTypeRadio", + "TemplateCreateTemplateTemporaryTypeRequest", + "TemplateCreateTemplateTemporaryTypeResponse", + "TemplateCreateTemplateTemporaryTypeText", + "TemplateCreateTemplateTemporaryUser", + "TemplateCreateTemplateTemporaryUserTypedDict", + "TemplateCreateTemplateTemporaryValue1", + "TemplateCreateTemplateTemporaryValue1TypedDict", + "TemplateCreateTemplateTemporaryValue2", + "TemplateCreateTemplateTemporaryValue2TypedDict", + "TemplateCreateTemplateTemporaryValue3", + "TemplateCreateTemplateTemporaryValue3TypedDict", + "TemplateCreateTemplateTemporaryVisibilityRequest", + "TemplateCreateTemplateTemporaryVisibilityResponse", "TemplateDeleteTemplateBadRequestError", "TemplateDeleteTemplateBadRequestErrorData", "TemplateDeleteTemplateBadRequestIssue", @@ -4954,9 +5261,6 @@ "TemplateDeleteTemplateRequestTypedDict", "TemplateDeleteTemplateResponse", "TemplateDeleteTemplateResponseTypedDict", - "TemplateDocumentData", - "TemplateDocumentDataType", - "TemplateDocumentDataTypedDict", "TemplateDuplicateTemplateAuthOptions", "TemplateDuplicateTemplateAuthOptionsTypedDict", "TemplateDuplicateTemplateBadRequestError", @@ -4988,6 +5292,7 @@ "TemplateFindTemplatesDataTypedDict", "TemplateFindTemplatesDirectLink", "TemplateFindTemplatesDirectLinkTypedDict", + "TemplateFindTemplatesDirection", "TemplateFindTemplatesDistributionMethod", "TemplateFindTemplatesField", "TemplateFindTemplatesFieldMetaCheckbox", @@ -5071,6 +5376,7 @@ "TemplateGetTemplateByIDBadRequestIssueTypedDict", "TemplateGetTemplateByIDDirectLink", "TemplateGetTemplateByIDDirectLinkTypedDict", + "TemplateGetTemplateByIDDirection", "TemplateGetTemplateByIDDistributionMethod", "TemplateGetTemplateByIDEmailSettings", "TemplateGetTemplateByIDEmailSettingsTypedDict", @@ -5124,6 +5430,9 @@ "TemplateGetTemplateByIDSendStatus", "TemplateGetTemplateByIDSigningOrder", "TemplateGetTemplateByIDSigningStatus", + "TemplateGetTemplateByIDTemplateDocumentData", + "TemplateGetTemplateByIDTemplateDocumentDataType", + "TemplateGetTemplateByIDTemplateDocumentDataTypedDict", "TemplateGetTemplateByIDTemplateMeta", "TemplateGetTemplateByIDTemplateMetaTypedDict", "TemplateGetTemplateByIDTextAlign1", @@ -5195,11 +5504,11 @@ "TemplateUpdateTemplateTypeResponse", "TemplateUpdateTemplateVisibilityRequest", "TemplateUpdateTemplateVisibilityResponse", + "Version", ] _dynamic_imports: dict[str, str] = { "APIError": ".apierror", - "Document": ".document_createdocumenttemporaryop", "DocumentAccessAuth": ".document_createdocumenttemporaryop", "DocumentActionAuth": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryAccessAuthRequest": ".document_createdocumenttemporaryop", @@ -5212,10 +5521,12 @@ "DocumentCreateDocumentTemporaryBadRequestIssueTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDateFormat": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDistributionMethodRequest": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryDocument": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDocumentData": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDocumentDataTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDocumentMeta": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDocumentMetaTypedDict": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryDocumentTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryEmailSettingsRequest": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryEmailSettingsRequestTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryFieldCheckbox": ".document_createdocumenttemporaryop", @@ -5256,6 +5567,7 @@ "DocumentCreateDocumentTemporaryReadStatus": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientAuthOptions": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientAuthOptionsTypedDict": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryRecipientDirection": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientFieldMetaCheckboxTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientFieldMetaDate": ".document_createdocumenttemporaryop", @@ -5319,6 +5631,7 @@ "DocumentCreateDocumentTemporaryValueRadio": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryValueRadioTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryVisibilityRequest": ".document_createdocumenttemporaryop", + "DocumentDirection": ".document_createdocumenttemporaryop", "DocumentDistributionMethod": ".document_createdocumenttemporaryop", "DocumentDocumentDataType": ".document_createdocumenttemporaryop", "DocumentEmailSettings": ".document_createdocumenttemporaryop", @@ -5353,7 +5666,6 @@ "DocumentTypeNumber": ".document_createdocumenttemporaryop", "DocumentTypeRadio": ".document_createdocumenttemporaryop", "DocumentTypeText": ".document_createdocumenttemporaryop", - "DocumentTypedDict": ".document_createdocumenttemporaryop", "DocumentValue1": ".document_createdocumenttemporaryop", "DocumentValue1TypedDict": ".document_createdocumenttemporaryop", "DocumentValue2": ".document_createdocumenttemporaryop", @@ -5381,241 +5693,259 @@ "FieldMetaDocumentTextTypedDict": ".document_createdocumenttemporaryop", "FormValuesRequest": ".document_createdocumenttemporaryop", "FormValuesRequestTypedDict": ".document_createdocumenttemporaryop", - "DocumentDeleteDocumentBadRequestError": ".document_deletedocumentop", - "DocumentDeleteDocumentBadRequestErrorData": ".document_deletedocumentop", - "DocumentDeleteDocumentBadRequestIssue": ".document_deletedocumentop", - "DocumentDeleteDocumentBadRequestIssueTypedDict": ".document_deletedocumentop", - "DocumentDeleteDocumentInternalServerError": ".document_deletedocumentop", - "DocumentDeleteDocumentInternalServerErrorData": ".document_deletedocumentop", - "DocumentDeleteDocumentInternalServerErrorIssue": ".document_deletedocumentop", - "DocumentDeleteDocumentInternalServerErrorIssueTypedDict": ".document_deletedocumentop", - "DocumentDeleteDocumentRequest": ".document_deletedocumentop", - "DocumentDeleteDocumentRequestTypedDict": ".document_deletedocumentop", - "DocumentDeleteDocumentResponse": ".document_deletedocumentop", - "DocumentDeleteDocumentResponseTypedDict": ".document_deletedocumentop", - "DocumentDuplicateDocumentBadRequestError": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentBadRequestErrorData": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentBadRequestIssue": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentBadRequestIssueTypedDict": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentInternalServerError": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentInternalServerErrorData": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentInternalServerErrorIssue": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentInternalServerErrorIssueTypedDict": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentRequest": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentRequestTypedDict": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentResponse": ".document_duplicatedocumentop", - "DocumentDuplicateDocumentResponseTypedDict": ".document_duplicatedocumentop", - "DataSource": ".document_finddocumentsop", - "DataStatus": ".document_finddocumentsop", - "DocumentFindDocumentsAccessAuth": ".document_finddocumentsop", - "DocumentFindDocumentsActionAuth": ".document_finddocumentsop", - "DocumentFindDocumentsAuthOptions": ".document_finddocumentsop", - "DocumentFindDocumentsAuthOptionsTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsBadRequestError": ".document_finddocumentsop", - "DocumentFindDocumentsBadRequestErrorData": ".document_finddocumentsop", - "DocumentFindDocumentsBadRequestIssue": ".document_finddocumentsop", - "DocumentFindDocumentsBadRequestIssueTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsData": ".document_finddocumentsop", - "DocumentFindDocumentsDataTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsFormValues": ".document_finddocumentsop", - "DocumentFindDocumentsFormValuesTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsGlobalAccessAuth": ".document_finddocumentsop", - "DocumentFindDocumentsGlobalActionAuth": ".document_finddocumentsop", - "DocumentFindDocumentsInternalServerError": ".document_finddocumentsop", - "DocumentFindDocumentsInternalServerErrorData": ".document_finddocumentsop", - "DocumentFindDocumentsInternalServerErrorIssue": ".document_finddocumentsop", - "DocumentFindDocumentsInternalServerErrorIssueTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsNotFoundError": ".document_finddocumentsop", - "DocumentFindDocumentsNotFoundErrorData": ".document_finddocumentsop", - "DocumentFindDocumentsNotFoundIssue": ".document_finddocumentsop", - "DocumentFindDocumentsNotFoundIssueTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsReadStatus": ".document_finddocumentsop", - "DocumentFindDocumentsRecipient": ".document_finddocumentsop", - "DocumentFindDocumentsRecipientAuthOptions": ".document_finddocumentsop", - "DocumentFindDocumentsRecipientAuthOptionsTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsRecipientTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsRequest": ".document_finddocumentsop", - "DocumentFindDocumentsRequestTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsResponse": ".document_finddocumentsop", - "DocumentFindDocumentsResponseTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsRole": ".document_finddocumentsop", - "DocumentFindDocumentsSendStatus": ".document_finddocumentsop", - "DocumentFindDocumentsSigningStatus": ".document_finddocumentsop", - "DocumentFindDocumentsTeam": ".document_finddocumentsop", - "DocumentFindDocumentsTeamTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsUser": ".document_finddocumentsop", - "DocumentFindDocumentsUserTypedDict": ".document_finddocumentsop", - "DocumentFindDocumentsVisibility": ".document_finddocumentsop", - "OrderByColumn": ".document_finddocumentsop", - "OrderByDirection": ".document_finddocumentsop", - "QueryParamSource": ".document_finddocumentsop", - "QueryParamStatus": ".document_finddocumentsop", - "DocumentGetDocumentWithDetailsByIDAccessAuth": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDActionAuth": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDAuthOptions": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDAuthOptionsTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDBadRequestError": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDBadRequestErrorData": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDBadRequestIssue": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDBadRequestIssueTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDDistributionMethod": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDDocumentData": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDDocumentDataType": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDDocumentDataTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDDocumentMeta": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDDocumentMetaTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDEmailSettings": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDEmailSettingsTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDField": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaCheckboxTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaDate": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaDateTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaDropdown": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaDropdownTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaEmail": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaEmailTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaInitials": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaInitialsTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaName": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaNameTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaNumber": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaNumberTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaRadio": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaRadioTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaText": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaTextTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaUnion": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldMetaUnionTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldType": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFieldTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFolder": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFolderType": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFolderTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFolderVisibility": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFormValues": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDFormValuesTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDGlobalAccessAuth": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDGlobalActionAuth": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDInternalServerError": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDInternalServerErrorData": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDInternalServerErrorIssue": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDInternalServerErrorIssueTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDNotFoundError": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDNotFoundErrorData": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDNotFoundIssue": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDNotFoundIssueTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDReadStatus": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDRecipient": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDRecipientAuthOptions": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDRecipientAuthOptionsTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDRecipientTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDRequest": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDRequestTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDResponse": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDResponseTypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDRole": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDSendStatus": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDSigningOrder": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDSigningStatus": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDSource": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDStatus": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTextAlign1": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTextAlign2": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTextAlign3": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTextAlign4": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTextAlign5": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTextAlign6": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTypeCheckbox": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTypeDate": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTypeDropdown": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTypeEmail": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTypeInitials": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTypeName": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTypeNumber": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTypeRadio": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDTypeText": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDValue1": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDValue1TypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDValue2": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDValue2TypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDValue3": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDValue3TypedDict": ".document_getdocumentwithdetailsbyidop", - "DocumentGetDocumentWithDetailsByIDVisibility": ".document_getdocumentwithdetailsbyidop", - "DocumentResendDocumentBadRequestError": ".document_resenddocumentop", - "DocumentResendDocumentBadRequestErrorData": ".document_resenddocumentop", - "DocumentResendDocumentBadRequestIssue": ".document_resenddocumentop", - "DocumentResendDocumentBadRequestIssueTypedDict": ".document_resenddocumentop", - "DocumentResendDocumentInternalServerError": ".document_resenddocumentop", - "DocumentResendDocumentInternalServerErrorData": ".document_resenddocumentop", - "DocumentResendDocumentInternalServerErrorIssue": ".document_resenddocumentop", - "DocumentResendDocumentInternalServerErrorIssueTypedDict": ".document_resenddocumentop", - "DocumentResendDocumentRequest": ".document_resenddocumentop", - "DocumentResendDocumentRequestTypedDict": ".document_resenddocumentop", - "DocumentResendDocumentResponse": ".document_resenddocumentop", - "DocumentResendDocumentResponseTypedDict": ".document_resenddocumentop", - "DocumentSendDocumentAuthOptions": ".document_senddocumentop", - "DocumentSendDocumentAuthOptionsTypedDict": ".document_senddocumentop", - "DocumentSendDocumentBadRequestError": ".document_senddocumentop", - "DocumentSendDocumentBadRequestErrorData": ".document_senddocumentop", - "DocumentSendDocumentBadRequestIssue": ".document_senddocumentop", - "DocumentSendDocumentBadRequestIssueTypedDict": ".document_senddocumentop", - "DocumentSendDocumentDateFormat": ".document_senddocumentop", - "DocumentSendDocumentDistributionMethod": ".document_senddocumentop", - "DocumentSendDocumentEmailSettings": ".document_senddocumentop", - "DocumentSendDocumentEmailSettingsTypedDict": ".document_senddocumentop", - "DocumentSendDocumentFormValues": ".document_senddocumentop", - "DocumentSendDocumentFormValuesTypedDict": ".document_senddocumentop", - "DocumentSendDocumentGlobalAccessAuth": ".document_senddocumentop", - "DocumentSendDocumentGlobalActionAuth": ".document_senddocumentop", - "DocumentSendDocumentInternalServerError": ".document_senddocumentop", - "DocumentSendDocumentInternalServerErrorData": ".document_senddocumentop", - "DocumentSendDocumentInternalServerErrorIssue": ".document_senddocumentop", - "DocumentSendDocumentInternalServerErrorIssueTypedDict": ".document_senddocumentop", - "DocumentSendDocumentLanguage": ".document_senddocumentop", - "DocumentSendDocumentMeta": ".document_senddocumentop", - "DocumentSendDocumentMetaTypedDict": ".document_senddocumentop", - "DocumentSendDocumentRequest": ".document_senddocumentop", - "DocumentSendDocumentRequestTypedDict": ".document_senddocumentop", - "DocumentSendDocumentResponse": ".document_senddocumentop", - "DocumentSendDocumentResponseTypedDict": ".document_senddocumentop", - "DocumentSendDocumentSource": ".document_senddocumentop", - "DocumentSendDocumentStatus": ".document_senddocumentop", - "DocumentSendDocumentVisibility": ".document_senddocumentop", - "DocumentUpdateDocumentAuthOptions": ".document_updatedocumentop", - "DocumentUpdateDocumentAuthOptionsTypedDict": ".document_updatedocumentop", - "DocumentUpdateDocumentBadRequestError": ".document_updatedocumentop", - "DocumentUpdateDocumentBadRequestErrorData": ".document_updatedocumentop", - "DocumentUpdateDocumentBadRequestIssue": ".document_updatedocumentop", - "DocumentUpdateDocumentBadRequestIssueTypedDict": ".document_updatedocumentop", - "DocumentUpdateDocumentData": ".document_updatedocumentop", - "DocumentUpdateDocumentDataTypedDict": ".document_updatedocumentop", - "DocumentUpdateDocumentDateFormat": ".document_updatedocumentop", - "DocumentUpdateDocumentDistributionMethod": ".document_updatedocumentop", - "DocumentUpdateDocumentEmailSettings": ".document_updatedocumentop", - "DocumentUpdateDocumentEmailSettingsTypedDict": ".document_updatedocumentop", - "DocumentUpdateDocumentFormValues": ".document_updatedocumentop", - "DocumentUpdateDocumentFormValuesTypedDict": ".document_updatedocumentop", - "DocumentUpdateDocumentGlobalAccessAuthRequest": ".document_updatedocumentop", - "DocumentUpdateDocumentGlobalAccessAuthResponse": ".document_updatedocumentop", - "DocumentUpdateDocumentGlobalActionAuthRequest": ".document_updatedocumentop", - "DocumentUpdateDocumentGlobalActionAuthResponse": ".document_updatedocumentop", - "DocumentUpdateDocumentInternalServerError": ".document_updatedocumentop", - "DocumentUpdateDocumentInternalServerErrorData": ".document_updatedocumentop", - "DocumentUpdateDocumentInternalServerErrorIssue": ".document_updatedocumentop", - "DocumentUpdateDocumentInternalServerErrorIssueTypedDict": ".document_updatedocumentop", - "DocumentUpdateDocumentLanguage": ".document_updatedocumentop", - "DocumentUpdateDocumentMeta": ".document_updatedocumentop", - "DocumentUpdateDocumentMetaTypedDict": ".document_updatedocumentop", - "DocumentUpdateDocumentRequest": ".document_updatedocumentop", - "DocumentUpdateDocumentRequestTypedDict": ".document_updatedocumentop", - "DocumentUpdateDocumentResponse": ".document_updatedocumentop", - "DocumentUpdateDocumentResponseTypedDict": ".document_updatedocumentop", - "DocumentUpdateDocumentSigningOrder": ".document_updatedocumentop", - "DocumentUpdateDocumentSource": ".document_updatedocumentop", - "DocumentUpdateDocumentStatus": ".document_updatedocumentop", - "DocumentUpdateDocumentVisibilityRequest": ".document_updatedocumentop", - "DocumentUpdateDocumentVisibilityResponse": ".document_updatedocumentop", + "DocumentDeleteBadRequestError": ".document_deleteop", + "DocumentDeleteBadRequestErrorData": ".document_deleteop", + "DocumentDeleteBadRequestIssue": ".document_deleteop", + "DocumentDeleteBadRequestIssueTypedDict": ".document_deleteop", + "DocumentDeleteInternalServerError": ".document_deleteop", + "DocumentDeleteInternalServerErrorData": ".document_deleteop", + "DocumentDeleteInternalServerErrorIssue": ".document_deleteop", + "DocumentDeleteInternalServerErrorIssueTypedDict": ".document_deleteop", + "DocumentDeleteRequest": ".document_deleteop", + "DocumentDeleteRequestTypedDict": ".document_deleteop", + "DocumentDeleteResponse": ".document_deleteop", + "DocumentDeleteResponseTypedDict": ".document_deleteop", + "DocumentDistributeAuthOptions": ".document_distributeop", + "DocumentDistributeAuthOptionsTypedDict": ".document_distributeop", + "DocumentDistributeBadRequestError": ".document_distributeop", + "DocumentDistributeBadRequestErrorData": ".document_distributeop", + "DocumentDistributeBadRequestIssue": ".document_distributeop", + "DocumentDistributeBadRequestIssueTypedDict": ".document_distributeop", + "DocumentDistributeDateFormat": ".document_distributeop", + "DocumentDistributeDistributionMethod": ".document_distributeop", + "DocumentDistributeEmailSettings": ".document_distributeop", + "DocumentDistributeEmailSettingsTypedDict": ".document_distributeop", + "DocumentDistributeFormValues": ".document_distributeop", + "DocumentDistributeFormValuesTypedDict": ".document_distributeop", + "DocumentDistributeGlobalAccessAuth": ".document_distributeop", + "DocumentDistributeGlobalActionAuth": ".document_distributeop", + "DocumentDistributeInternalServerError": ".document_distributeop", + "DocumentDistributeInternalServerErrorData": ".document_distributeop", + "DocumentDistributeInternalServerErrorIssue": ".document_distributeop", + "DocumentDistributeInternalServerErrorIssueTypedDict": ".document_distributeop", + "DocumentDistributeLanguage": ".document_distributeop", + "DocumentDistributeMeta": ".document_distributeop", + "DocumentDistributeMetaTypedDict": ".document_distributeop", + "DocumentDistributeRequest": ".document_distributeop", + "DocumentDistributeRequestTypedDict": ".document_distributeop", + "DocumentDistributeResponse": ".document_distributeop", + "DocumentDistributeResponseTypedDict": ".document_distributeop", + "DocumentDistributeSource": ".document_distributeop", + "DocumentDistributeStatus": ".document_distributeop", + "DocumentDistributeVisibility": ".document_distributeop", + "DocumentDownloadBadRequestError": ".document_downloadop", + "DocumentDownloadBadRequestErrorData": ".document_downloadop", + "DocumentDownloadBadRequestIssue": ".document_downloadop", + "DocumentDownloadBadRequestIssueTypedDict": ".document_downloadop", + "DocumentDownloadInternalServerError": ".document_downloadop", + "DocumentDownloadInternalServerErrorData": ".document_downloadop", + "DocumentDownloadInternalServerErrorIssue": ".document_downloadop", + "DocumentDownloadInternalServerErrorIssueTypedDict": ".document_downloadop", + "DocumentDownloadNotFoundError": ".document_downloadop", + "DocumentDownloadNotFoundErrorData": ".document_downloadop", + "DocumentDownloadNotFoundIssue": ".document_downloadop", + "DocumentDownloadNotFoundIssueTypedDict": ".document_downloadop", + "DocumentDownloadRequest": ".document_downloadop", + "DocumentDownloadRequestTypedDict": ".document_downloadop", + "DocumentDownloadResponse": ".document_downloadop", + "DocumentDownloadResponseTypedDict": ".document_downloadop", + "Version": ".document_downloadop", + "DocumentDuplicateBadRequestError": ".document_duplicateop", + "DocumentDuplicateBadRequestErrorData": ".document_duplicateop", + "DocumentDuplicateBadRequestIssue": ".document_duplicateop", + "DocumentDuplicateBadRequestIssueTypedDict": ".document_duplicateop", + "DocumentDuplicateInternalServerError": ".document_duplicateop", + "DocumentDuplicateInternalServerErrorData": ".document_duplicateop", + "DocumentDuplicateInternalServerErrorIssue": ".document_duplicateop", + "DocumentDuplicateInternalServerErrorIssueTypedDict": ".document_duplicateop", + "DocumentDuplicateRequest": ".document_duplicateop", + "DocumentDuplicateRequestTypedDict": ".document_duplicateop", + "DocumentDuplicateResponse": ".document_duplicateop", + "DocumentDuplicateResponseTypedDict": ".document_duplicateop", + "DataSource": ".document_findop", + "DataStatus": ".document_findop", + "DocumentFindAccessAuth": ".document_findop", + "DocumentFindActionAuth": ".document_findop", + "DocumentFindAuthOptions": ".document_findop", + "DocumentFindAuthOptionsTypedDict": ".document_findop", + "DocumentFindBadRequestError": ".document_findop", + "DocumentFindBadRequestErrorData": ".document_findop", + "DocumentFindBadRequestIssue": ".document_findop", + "DocumentFindBadRequestIssueTypedDict": ".document_findop", + "DocumentFindData": ".document_findop", + "DocumentFindDataTypedDict": ".document_findop", + "DocumentFindFormValues": ".document_findop", + "DocumentFindFormValuesTypedDict": ".document_findop", + "DocumentFindGlobalAccessAuth": ".document_findop", + "DocumentFindGlobalActionAuth": ".document_findop", + "DocumentFindInternalServerError": ".document_findop", + "DocumentFindInternalServerErrorData": ".document_findop", + "DocumentFindInternalServerErrorIssue": ".document_findop", + "DocumentFindInternalServerErrorIssueTypedDict": ".document_findop", + "DocumentFindNotFoundError": ".document_findop", + "DocumentFindNotFoundErrorData": ".document_findop", + "DocumentFindNotFoundIssue": ".document_findop", + "DocumentFindNotFoundIssueTypedDict": ".document_findop", + "DocumentFindReadStatus": ".document_findop", + "DocumentFindRecipient": ".document_findop", + "DocumentFindRecipientAuthOptions": ".document_findop", + "DocumentFindRecipientAuthOptionsTypedDict": ".document_findop", + "DocumentFindRecipientTypedDict": ".document_findop", + "DocumentFindRequest": ".document_findop", + "DocumentFindRequestTypedDict": ".document_findop", + "DocumentFindResponse": ".document_findop", + "DocumentFindResponseTypedDict": ".document_findop", + "DocumentFindRole": ".document_findop", + "DocumentFindSendStatus": ".document_findop", + "DocumentFindSigningStatus": ".document_findop", + "DocumentFindTeam": ".document_findop", + "DocumentFindTeamTypedDict": ".document_findop", + "DocumentFindUser": ".document_findop", + "DocumentFindUserTypedDict": ".document_findop", + "DocumentFindVisibility": ".document_findop", + "OrderByColumn": ".document_findop", + "OrderByDirection": ".document_findop", + "QueryParamSource": ".document_findop", + "QueryParamStatus": ".document_findop", + "DocumentGetAccessAuth": ".document_getop", + "DocumentGetActionAuth": ".document_getop", + "DocumentGetAuthOptions": ".document_getop", + "DocumentGetAuthOptionsTypedDict": ".document_getop", + "DocumentGetBadRequestError": ".document_getop", + "DocumentGetBadRequestErrorData": ".document_getop", + "DocumentGetBadRequestIssue": ".document_getop", + "DocumentGetBadRequestIssueTypedDict": ".document_getop", + "DocumentGetDirection": ".document_getop", + "DocumentGetDistributionMethod": ".document_getop", + "DocumentGetDocumentData": ".document_getop", + "DocumentGetDocumentDataType": ".document_getop", + "DocumentGetDocumentDataTypedDict": ".document_getop", + "DocumentGetDocumentMeta": ".document_getop", + "DocumentGetDocumentMetaTypedDict": ".document_getop", + "DocumentGetEmailSettings": ".document_getop", + "DocumentGetEmailSettingsTypedDict": ".document_getop", + "DocumentGetField": ".document_getop", + "DocumentGetFieldMetaCheckbox": ".document_getop", + "DocumentGetFieldMetaCheckboxTypedDict": ".document_getop", + "DocumentGetFieldMetaDate": ".document_getop", + "DocumentGetFieldMetaDateTypedDict": ".document_getop", + "DocumentGetFieldMetaDropdown": ".document_getop", + "DocumentGetFieldMetaDropdownTypedDict": ".document_getop", + "DocumentGetFieldMetaEmail": ".document_getop", + "DocumentGetFieldMetaEmailTypedDict": ".document_getop", + "DocumentGetFieldMetaInitials": ".document_getop", + "DocumentGetFieldMetaInitialsTypedDict": ".document_getop", + "DocumentGetFieldMetaName": ".document_getop", + "DocumentGetFieldMetaNameTypedDict": ".document_getop", + "DocumentGetFieldMetaNumber": ".document_getop", + "DocumentGetFieldMetaNumberTypedDict": ".document_getop", + "DocumentGetFieldMetaRadio": ".document_getop", + "DocumentGetFieldMetaRadioTypedDict": ".document_getop", + "DocumentGetFieldMetaText": ".document_getop", + "DocumentGetFieldMetaTextTypedDict": ".document_getop", + "DocumentGetFieldMetaUnion": ".document_getop", + "DocumentGetFieldMetaUnionTypedDict": ".document_getop", + "DocumentGetFieldType": ".document_getop", + "DocumentGetFieldTypedDict": ".document_getop", + "DocumentGetFolder": ".document_getop", + "DocumentGetFolderType": ".document_getop", + "DocumentGetFolderTypedDict": ".document_getop", + "DocumentGetFolderVisibility": ".document_getop", + "DocumentGetFormValues": ".document_getop", + "DocumentGetFormValuesTypedDict": ".document_getop", + "DocumentGetGlobalAccessAuth": ".document_getop", + "DocumentGetGlobalActionAuth": ".document_getop", + "DocumentGetInternalServerError": ".document_getop", + "DocumentGetInternalServerErrorData": ".document_getop", + "DocumentGetInternalServerErrorIssue": ".document_getop", + "DocumentGetInternalServerErrorIssueTypedDict": ".document_getop", + "DocumentGetNotFoundError": ".document_getop", + "DocumentGetNotFoundErrorData": ".document_getop", + "DocumentGetNotFoundIssue": ".document_getop", + "DocumentGetNotFoundIssueTypedDict": ".document_getop", + "DocumentGetReadStatus": ".document_getop", + "DocumentGetRecipient": ".document_getop", + "DocumentGetRecipientAuthOptions": ".document_getop", + "DocumentGetRecipientAuthOptionsTypedDict": ".document_getop", + "DocumentGetRecipientTypedDict": ".document_getop", + "DocumentGetRequest": ".document_getop", + "DocumentGetRequestTypedDict": ".document_getop", + "DocumentGetResponse": ".document_getop", + "DocumentGetResponseTypedDict": ".document_getop", + "DocumentGetRole": ".document_getop", + "DocumentGetSendStatus": ".document_getop", + "DocumentGetSigningOrder": ".document_getop", + "DocumentGetSigningStatus": ".document_getop", + "DocumentGetSource": ".document_getop", + "DocumentGetStatus": ".document_getop", + "DocumentGetTextAlign1": ".document_getop", + "DocumentGetTextAlign2": ".document_getop", + "DocumentGetTextAlign3": ".document_getop", + "DocumentGetTextAlign4": ".document_getop", + "DocumentGetTextAlign5": ".document_getop", + "DocumentGetTextAlign6": ".document_getop", + "DocumentGetTypeCheckbox": ".document_getop", + "DocumentGetTypeDate": ".document_getop", + "DocumentGetTypeDropdown": ".document_getop", + "DocumentGetTypeEmail": ".document_getop", + "DocumentGetTypeInitials": ".document_getop", + "DocumentGetTypeName": ".document_getop", + "DocumentGetTypeNumber": ".document_getop", + "DocumentGetTypeRadio": ".document_getop", + "DocumentGetTypeText": ".document_getop", + "DocumentGetValue1": ".document_getop", + "DocumentGetValue1TypedDict": ".document_getop", + "DocumentGetValue2": ".document_getop", + "DocumentGetValue2TypedDict": ".document_getop", + "DocumentGetValue3": ".document_getop", + "DocumentGetValue3TypedDict": ".document_getop", + "DocumentGetVisibility": ".document_getop", + "DocumentRedistributeBadRequestError": ".document_redistributeop", + "DocumentRedistributeBadRequestErrorData": ".document_redistributeop", + "DocumentRedistributeBadRequestIssue": ".document_redistributeop", + "DocumentRedistributeBadRequestIssueTypedDict": ".document_redistributeop", + "DocumentRedistributeInternalServerError": ".document_redistributeop", + "DocumentRedistributeInternalServerErrorData": ".document_redistributeop", + "DocumentRedistributeInternalServerErrorIssue": ".document_redistributeop", + "DocumentRedistributeInternalServerErrorIssueTypedDict": ".document_redistributeop", + "DocumentRedistributeRequest": ".document_redistributeop", + "DocumentRedistributeRequestTypedDict": ".document_redistributeop", + "DocumentRedistributeResponse": ".document_redistributeop", + "DocumentRedistributeResponseTypedDict": ".document_redistributeop", + "DocumentUpdateAuthOptions": ".document_updateop", + "DocumentUpdateAuthOptionsTypedDict": ".document_updateop", + "DocumentUpdateBadRequestError": ".document_updateop", + "DocumentUpdateBadRequestErrorData": ".document_updateop", + "DocumentUpdateBadRequestIssue": ".document_updateop", + "DocumentUpdateBadRequestIssueTypedDict": ".document_updateop", + "DocumentUpdateData": ".document_updateop", + "DocumentUpdateDataTypedDict": ".document_updateop", + "DocumentUpdateDateFormat": ".document_updateop", + "DocumentUpdateDistributionMethod": ".document_updateop", + "DocumentUpdateEmailSettings": ".document_updateop", + "DocumentUpdateEmailSettingsTypedDict": ".document_updateop", + "DocumentUpdateFormValues": ".document_updateop", + "DocumentUpdateFormValuesTypedDict": ".document_updateop", + "DocumentUpdateGlobalAccessAuthRequest": ".document_updateop", + "DocumentUpdateGlobalAccessAuthResponse": ".document_updateop", + "DocumentUpdateGlobalActionAuthRequest": ".document_updateop", + "DocumentUpdateGlobalActionAuthResponse": ".document_updateop", + "DocumentUpdateInternalServerError": ".document_updateop", + "DocumentUpdateInternalServerErrorData": ".document_updateop", + "DocumentUpdateInternalServerErrorIssue": ".document_updateop", + "DocumentUpdateInternalServerErrorIssueTypedDict": ".document_updateop", + "DocumentUpdateLanguage": ".document_updateop", + "DocumentUpdateMeta": ".document_updateop", + "DocumentUpdateMetaTypedDict": ".document_updateop", + "DocumentUpdateRequest": ".document_updateop", + "DocumentUpdateRequestTypedDict": ".document_updateop", + "DocumentUpdateResponse": ".document_updateop", + "DocumentUpdateResponseTypedDict": ".document_updateop", + "DocumentUpdateSigningOrder": ".document_updateop", + "DocumentUpdateSource": ".document_updateop", + "DocumentUpdateStatus": ".document_updateop", + "DocumentUpdateVisibilityRequest": ".document_updateop", + "DocumentUpdateVisibilityResponse": ".document_updateop", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestErrorData": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue": ".embeddingpresign_createembeddingpresigntokenop", @@ -5644,6 +5974,8 @@ "FieldCreateDocumentFieldBadRequestErrorData": ".field_createdocumentfieldop", "FieldCreateDocumentFieldBadRequestIssue": ".field_createdocumentfieldop", "FieldCreateDocumentFieldBadRequestIssueTypedDict": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldDirectionRequest": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldDirectionResponse": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldCheckbox": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldCheckboxTypedDict": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldDate": ".field_createdocumentfieldop", @@ -5772,6 +6104,8 @@ "FieldCreateDocumentFieldsBadRequestErrorData": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsBadRequestIssue": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsBadRequestIssueTypedDict": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsDirectionRequest": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsDirectionResponse": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldCheckbox": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldCheckboxTypedDict": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldDate": ".field_createdocumentfieldsop", @@ -5902,6 +6236,8 @@ "FieldCreateTemplateFieldBadRequestErrorData": ".field_createtemplatefieldop", "FieldCreateTemplateFieldBadRequestIssue": ".field_createtemplatefieldop", "FieldCreateTemplateFieldBadRequestIssueTypedDict": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldDirectionRequest": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldDirectionResponse": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldCheckbox": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldCheckboxTypedDict": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldDate": ".field_createtemplatefieldop", @@ -6030,6 +6366,8 @@ "FieldCreateTemplateFieldsBadRequestErrorData": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsBadRequestIssue": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsBadRequestIssueTypedDict": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsDirectionRequest": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsDirectionResponse": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldCheckbox": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldCheckboxTypedDict": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldDate": ".field_createtemplatefieldsop", @@ -6184,6 +6522,7 @@ "FieldGetDocumentFieldBadRequestErrorData": ".field_getdocumentfieldop", "FieldGetDocumentFieldBadRequestIssue": ".field_getdocumentfieldop", "FieldGetDocumentFieldBadRequestIssueTypedDict": ".field_getdocumentfieldop", + "FieldGetDocumentFieldDirection": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaCheckbox": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaCheckboxTypedDict": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaDate": ".field_getdocumentfieldop", @@ -6242,6 +6581,7 @@ "FieldGetTemplateFieldBadRequestErrorData": ".field_gettemplatefieldop", "FieldGetTemplateFieldBadRequestIssue": ".field_gettemplatefieldop", "FieldGetTemplateFieldBadRequestIssueTypedDict": ".field_gettemplatefieldop", + "FieldGetTemplateFieldDirection": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaCheckbox": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaCheckboxTypedDict": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaDate": ".field_gettemplatefieldop", @@ -6300,6 +6640,8 @@ "FieldUpdateDocumentFieldBadRequestErrorData": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldBadRequestIssue": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldBadRequestIssueTypedDict": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldDirectionRequest": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldDirectionResponse": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldCheckbox": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldCheckboxTypedDict": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldDate": ".field_updatedocumentfieldop", @@ -6428,6 +6770,8 @@ "FieldUpdateDocumentFieldsBadRequestErrorData": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsBadRequestIssue": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsBadRequestIssueTypedDict": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsDirectionRequest": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsDirectionResponse": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldCheckbox": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldCheckboxTypedDict": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldDate": ".field_updatedocumentfieldsop", @@ -6558,6 +6902,8 @@ "FieldUpdateTemplateFieldBadRequestErrorData": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldBadRequestIssue": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldBadRequestIssueTypedDict": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldDirectionRequest": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldDirectionResponse": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldCheckbox": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldCheckboxTypedDict": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldDate": ".field_updatetemplatefieldop", @@ -6686,6 +7032,8 @@ "FieldUpdateTemplateFieldsBadRequestErrorData": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsBadRequestIssue": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsBadRequestIssueTypedDict": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsDirectionRequest": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsDirectionResponse": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldCheckbox": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldCheckboxTypedDict": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldDate": ".field_updatetemplatefieldsop", @@ -6949,6 +7297,7 @@ "RecipientGetDocumentRecipientBadRequestErrorData": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientBadRequestIssue": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientBadRequestIssueTypedDict": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientDirection": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientField": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldMetaCheckbox": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict": ".recipient_getdocumentrecipientop", @@ -7017,6 +7366,7 @@ "RecipientGetTemplateRecipientBadRequestErrorData": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientBadRequestIssue": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientBadRequestIssueTypedDict": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientDirection": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientField": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldMetaCheckbox": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict": ".recipient_gettemplaterecipientop", @@ -7087,6 +7437,7 @@ "RecipientUpdateDocumentRecipientBadRequestErrorData": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientBadRequestIssue": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientBadRequestIssueTypedDict": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientDirection": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientField": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldMetaCheckbox": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict": ".recipient_updatedocumentrecipientop", @@ -7156,6 +7507,7 @@ "RecipientUpdateDocumentRecipientsBadRequestErrorData": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsBadRequestIssue": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsBadRequestIssueTypedDict": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsDirection": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsField": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldMetaCheckbox": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict": ".recipient_updatedocumentrecipientsop", @@ -7227,6 +7579,7 @@ "RecipientUpdateTemplateRecipientBadRequestErrorData": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientBadRequestIssue": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientBadRequestIssueTypedDict": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientDirection": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientField": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldMetaCheckbox": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict": ".recipient_updatetemplaterecipientop", @@ -7296,6 +7649,7 @@ "RecipientUpdateTemplateRecipientsBadRequestErrorData": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsBadRequestIssue": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsBadRequestIssueTypedDict": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsDirection": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsField": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldMetaCheckbox": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict": ".recipient_updatetemplaterecipientsop", @@ -7360,6 +7714,8 @@ "ResponseValidationError": ".responsevalidationerror", "Security": ".security", "SecurityTypedDict": ".security", + "CustomDocumentDatum": ".template_createdocumentfromtemplateop", + "CustomDocumentDatumTypedDict": ".template_createdocumentfromtemplateop", "PrefillField": ".template_createdocumentfromtemplateop", "PrefillFieldCheckbox": ".template_createdocumentfromtemplateop", "PrefillFieldCheckboxTypedDict": ".template_createdocumentfromtemplateop", @@ -7388,6 +7744,7 @@ "TemplateCreateDocumentFromTemplateBadRequestErrorData": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateBadRequestIssue": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateBadRequestIssueTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateDirection": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateDistributionMethod": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateDocumentData": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateDocumentDataType": ".template_createdocumentfromtemplateop", @@ -7482,6 +7839,110 @@ "TemplateCreateTemplateDirectLinkRequestTypedDict": ".template_createtemplatedirectlinkop", "TemplateCreateTemplateDirectLinkResponse": ".template_createtemplatedirectlinkop", "TemplateCreateTemplateDirectLinkResponseTypedDict": ".template_createtemplatedirectlinkop", + "TemplateCreateTemplateTemporaryAccessAuth": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryActionAuth": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryAuthOptions": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryAuthOptionsTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryBadRequestError": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryBadRequestErrorData": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryBadRequestIssue": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryBadRequestIssueTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryDateFormat": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryDirectLink": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryDirectLinkTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryDirection": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryDistributionMethodRequest": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryEmailSettingsRequest": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryEmailSettingsRequestTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryField": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaCheckbox": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaCheckboxTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaDate": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaDateTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaDropdown": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaDropdownTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaEmail": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaEmailTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaInitials": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaInitialsTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaName": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaNameTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaNumber": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaNumberTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaRadio": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaRadioTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaText": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaTextTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaUnion": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldType": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFolder": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFolderType": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFolderTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFolderVisibility": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryGlobalAccessAuthRequest": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryGlobalAccessAuthResponse": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryGlobalActionAuthRequest": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryGlobalActionAuthResponse": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryInternalServerError": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryInternalServerErrorData": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryInternalServerErrorIssue": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryInternalServerErrorIssueTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryLanguage": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryMeta": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryMetaTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryReadStatus": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryRecipient": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryRecipientAuthOptions": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryRecipientAuthOptionsTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryRecipientTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryRequest": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryRequestTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryResponse": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryResponseTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryRole": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporarySendStatus": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporarySigningOrderRequest": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporarySigningStatus": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplate": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplateDocumentData": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplateDocumentDataType": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplateDocumentDataTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplateMeta": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplateMetaEmailSettings": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplateMetaEmailSettingsTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplateMetaSigningOrder": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplateMetaTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTemplateTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTextAlign1": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTextAlign2": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTextAlign3": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTextAlign4": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTextAlign5": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTextAlign6": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeCheckbox": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeDate": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeDropdown": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeEmail": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeInitials": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeName": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeNumber": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeRadio": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeRequest": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeResponse": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeText": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryUser": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryUserTypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryValue1": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryValue1TypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryValue2": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryValue2TypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryValue3": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryValue3TypedDict": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryVisibilityRequest": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryVisibilityResponse": ".template_createtemplatetemporaryop", "TemplateDeleteTemplateDirectLinkBadRequestError": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateDirectLinkBadRequestErrorData": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateDirectLinkBadRequestIssue": ".template_deletetemplatedirectlinkop", @@ -7538,6 +7999,7 @@ "TemplateFindTemplatesDataTypedDict": ".template_findtemplatesop", "TemplateFindTemplatesDirectLink": ".template_findtemplatesop", "TemplateFindTemplatesDirectLinkTypedDict": ".template_findtemplatesop", + "TemplateFindTemplatesDirection": ".template_findtemplatesop", "TemplateFindTemplatesDistributionMethod": ".template_findtemplatesop", "TemplateFindTemplatesField": ".template_findtemplatesop", "TemplateFindTemplatesFieldMetaCheckbox": ".template_findtemplatesop", @@ -7611,9 +8073,6 @@ "TemplateFindTemplatesValue3": ".template_findtemplatesop", "TemplateFindTemplatesValue3TypedDict": ".template_findtemplatesop", "TemplateFindTemplatesVisibility": ".template_findtemplatesop", - "TemplateDocumentData": ".template_gettemplatebyidop", - "TemplateDocumentDataType": ".template_gettemplatebyidop", - "TemplateDocumentDataTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDAccessAuth": ".template_gettemplatebyidop", "TemplateGetTemplateByIDActionAuth": ".template_gettemplatebyidop", "TemplateGetTemplateByIDAuthOptions": ".template_gettemplatebyidop", @@ -7624,6 +8083,7 @@ "TemplateGetTemplateByIDBadRequestIssueTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDDirectLink": ".template_gettemplatebyidop", "TemplateGetTemplateByIDDirectLinkTypedDict": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDDirection": ".template_gettemplatebyidop", "TemplateGetTemplateByIDDistributionMethod": ".template_gettemplatebyidop", "TemplateGetTemplateByIDEmailSettings": ".template_gettemplatebyidop", "TemplateGetTemplateByIDEmailSettingsTypedDict": ".template_gettemplatebyidop", @@ -7677,6 +8137,9 @@ "TemplateGetTemplateByIDSendStatus": ".template_gettemplatebyidop", "TemplateGetTemplateByIDSigningOrder": ".template_gettemplatebyidop", "TemplateGetTemplateByIDSigningStatus": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDTemplateDocumentData": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDTemplateDocumentDataType": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDTemplateDocumentDataTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDTemplateMeta": ".template_gettemplatebyidop", "TemplateGetTemplateByIDTemplateMetaTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDTextAlign1": ".template_gettemplatebyidop", diff --git a/src/documenso_sdk/models/apierror.py b/src/documenso_sdk/models/apierror.py index 3be57ee..a35617d 100644 --- a/src/documenso_sdk/models/apierror.py +++ b/src/documenso_sdk/models/apierror.py @@ -2,12 +2,14 @@ import httpx from typing import Optional +from dataclasses import dataclass from documenso_sdk.models import DocumensoError MAX_MESSAGE_LEN = 10_000 +@dataclass(unsafe_hash=True) class APIError(DocumensoError): """The fallback error class if no more specific error class is matched.""" diff --git a/src/documenso_sdk/models/documensoerror.py b/src/documenso_sdk/models/documensoerror.py index a842ba8..a58fcd2 100644 --- a/src/documenso_sdk/models/documensoerror.py +++ b/src/documenso_sdk/models/documensoerror.py @@ -2,25 +2,29 @@ import httpx from typing import Optional +from dataclasses import dataclass, field +@dataclass(unsafe_hash=True) class DocumensoError(Exception): """The base class for all HTTP error responses.""" message: str status_code: int body: str - headers: httpx.Headers - raw_response: httpx.Response + headers: httpx.Headers = field(hash=False) + raw_response: httpx.Response = field(hash=False) def __init__( self, message: str, raw_response: httpx.Response, body: Optional[str] = None ): - self.message = message - self.status_code = raw_response.status_code - self.body = body if body is not None else raw_response.text - self.headers = raw_response.headers - self.raw_response = raw_response + object.__setattr__(self, "message", message) + object.__setattr__(self, "status_code", raw_response.status_code) + object.__setattr__( + self, "body", body if body is not None else raw_response.text + ) + object.__setattr__(self, "headers", raw_response.headers) + object.__setattr__(self, "raw_response", raw_response) def __str__(self): return self.message diff --git a/src/documenso_sdk/models/document_createdocumenttemporaryop.py b/src/documenso_sdk/models/document_createdocumenttemporaryop.py index 1bab755..aa88ed3 100644 --- a/src/documenso_sdk/models/document_createdocumenttemporaryop.py +++ b/src/documenso_sdk/models/document_createdocumenttemporaryop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -23,6 +30,7 @@ class DocumentCreateDocumentTemporaryGlobalAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class DocumentCreateDocumentTemporaryGlobalActionAuthRequest(str, Enum): @@ -54,6 +62,7 @@ class DocumentCreateDocumentTemporaryAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class DocumentCreateDocumentTemporaryActionAuthRequest(str, Enum): @@ -171,6 +180,11 @@ class DocumentCreateDocumentTemporaryValueCheckbox(BaseModel): value: str +class DocumentCreateDocumentTemporaryRecipientDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class DocumentCreateDocumentTemporaryRecipientFieldMetaCheckboxTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeCheckbox2 label: NotRequired[str] @@ -180,6 +194,7 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaCheckboxTypedDict(TypedDi values: NotRequired[List[DocumentCreateDocumentTemporaryValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[DocumentCreateDocumentTemporaryRecipientDirection] class DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox(BaseModel): @@ -203,6 +218,10 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[DocumentCreateDocumentTemporaryRecipientDirection] = ( + DocumentCreateDocumentTemporaryRecipientDirection.VERTICAL + ) + class DocumentCreateDocumentTemporaryFieldCheckboxTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeCheckbox1 @@ -351,10 +370,10 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaNumberTypedDict(TypedDict placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[DocumentCreateDocumentTemporaryTextAlignNumber] @@ -370,13 +389,19 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -385,6 +410,47 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaNumber(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class DocumentCreateDocumentTemporaryFieldNumberTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeNumber1 @@ -1002,16 +1068,28 @@ class DocumentCreateDocumentTemporaryRecipientRequest(BaseModel): class DocumentCreateDocumentTemporaryDateFormat(str, Enum): r"""The date format to use for date fields and signing the document.""" - YYYY_MM_DD_HH_MM_A = "yyyy-MM-dd hh:mm a" - YYYY_MM_DD = "yyyy-MM-dd" - DD_MM_YYYY_HH_MM_A = "dd/MM/yyyy hh:mm a" - MM_DD_YYYY_HH_MM_A = "MM/dd/yyyy hh:mm a" - YYYY_MM_DD_HH_MM = "yyyy-MM-dd HH:mm" - YY_MM_DD_HH_MM_A = "yy-MM-dd hh:mm a" - YYYY_MM_DD_HH_MM_SS = "yyyy-MM-dd HH:mm:ss" - MMMM_DD_YYYY_HH_MM_A = "MMMM dd, yyyy hh:mm a" - EEEE_MMMM_DD_YYYY_HH_MM_A = "EEEE, MMMM dd, yyyy hh:mm a" - YYYY_MM_DD_T_HH_MM_SS_SSSXXX = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" + YYYY_M_MDD_HH_MM_A = "yyyy-MM-dd hh:mm a" + YYYY_M_MDD = "yyyy-MM-dd" + DD_MM_SLASH_YYYY = "dd/MM/yyyy" + MM_DD_SLASH_YYYY = "MM/dd/yyyy" + YY_M_MDD = "yy-MM-dd" + MMMM_DD_COMMA_YYYY = "MMMM dd, yyyy" + EEEE_MMMM_DD_COMMA_YYYY = "EEEE, MMMM dd, yyyy" + DD_MM_SLASH_YYYY_HH_MM_A = "dd/MM/yyyy hh:mm a" + DD_MM_SLASH_YYYY_H_HMM = "dd/MM/yyyy HH:mm" + MM_DD_SLASH_YYYY_HH_MM_A = "MM/dd/yyyy hh:mm a" + MM_DD_SLASH_YYYY_H_HMM = "MM/dd/yyyy HH:mm" + DD_DOT_MM_DOT_YYYY = "dd.MM.yyyy" + DD_DOT_MM_DOT_YYYY_H_HMM = "dd.MM.yyyy HH:mm" + YYYY_M_MDD_H_HMM = "yyyy-MM-dd HH:mm" + YY_M_MDD_HH_MM_A = "yy-MM-dd hh:mm a" + YY_M_MDD_H_HMM = "yy-MM-dd HH:mm" + YYYY_M_MDD_H_HMMSS = "yyyy-MM-dd HH:mm:ss" + MMMM_DD_COMMA_YYYY_HH_MM_A = "MMMM dd, yyyy hh:mm a" + MMMM_DD_COMMA_YYYY_H_HMM = "MMMM dd, yyyy HH:mm" + EEEE_MMMM_DD_COMMA_YYYY_HH_MM_A = "EEEE, MMMM dd, yyyy hh:mm a" + EEEE_MMMM_DD_COMMA_YYYY_H_HMM = "EEEE, MMMM dd, yyyy HH:mm" + ISO8601_FULL = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" class DocumentCreateDocumentTemporaryDistributionMethodRequest(str, Enum): @@ -1105,18 +1183,21 @@ class DocumentCreateDocumentTemporaryMetaTypedDict(TypedDict): ] r"""The distribution method to use when sending the document to the recipients.""" signing_order: NotRequired[DocumentCreateDocumentTemporarySigningOrderRequest] + allow_dictate_next_signer: NotRequired[bool] redirect_url: NotRequired[str] r"""The URL to which the recipient should be redirected after signing the document.""" language: NotRequired[DocumentCreateDocumentTemporaryLanguage] r"""The language to use for email communications with recipients.""" typed_signature_enabled: NotRequired[bool] r"""Whether to allow recipients to sign using a typed signature.""" - draw_signature_enabled: NotRequired[bool] - r"""Whether to allow recipients to sign using a draw signature.""" upload_signature_enabled: NotRequired[bool] r"""Whether to allow recipients to sign using an uploaded signature.""" + draw_signature_enabled: NotRequired[bool] + r"""Whether to allow recipients to sign using a draw signature.""" + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] email_settings: NotRequired[ - DocumentCreateDocumentTemporaryEmailSettingsRequestTypedDict + Nullable[DocumentCreateDocumentTemporaryEmailSettingsRequestTypedDict] ] @@ -1147,6 +1228,10 @@ class DocumentCreateDocumentTemporaryMeta(BaseModel): pydantic.Field(alias="signingOrder"), ] = None + allow_dictate_next_signer: Annotated[ + Optional[bool], pydantic.Field(alias="allowDictateNextSigner") + ] = None + redirect_url: Annotated[Optional[str], pydantic.Field(alias="redirectUrl")] = None r"""The URL to which the recipient should be redirected after signing the document.""" @@ -1158,20 +1243,72 @@ class DocumentCreateDocumentTemporaryMeta(BaseModel): ] = None r"""Whether to allow recipients to sign using a typed signature.""" + upload_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="uploadSignatureEnabled") + ] = None + r"""Whether to allow recipients to sign using an uploaded signature.""" + draw_signature_enabled: Annotated[ Optional[bool], pydantic.Field(alias="drawSignatureEnabled") ] = None r"""Whether to allow recipients to sign using a draw signature.""" - upload_signature_enabled: Annotated[ - Optional[bool], pydantic.Field(alias="uploadSignatureEnabled") - ] = None - r"""Whether to allow recipients to sign using an uploaded signature.""" + email_id: Annotated[OptionalNullable[str], pydantic.Field(alias="emailId")] = UNSET + + email_reply_to: Annotated[ + OptionalNullable[str], pydantic.Field(alias="emailReplyTo") + ] = UNSET email_settings: Annotated[ - Optional[DocumentCreateDocumentTemporaryEmailSettingsRequest], + OptionalNullable[DocumentCreateDocumentTemporaryEmailSettingsRequest], pydantic.Field(alias="emailSettings"), - ] = None + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "subject", + "message", + "timezone", + "dateFormat", + "distributionMethod", + "signingOrder", + "allowDictateNextSigner", + "redirectUrl", + "language", + "typedSignatureEnabled", + "uploadSignatureEnabled", + "drawSignatureEnabled", + "emailId", + "emailReplyTo", + "emailSettings", + ] + nullable_fields = ["emailId", "emailReplyTo", "emailSettings"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m class DocumentCreateDocumentTemporaryRequestTypedDict(TypedDict): @@ -1188,6 +1325,8 @@ class DocumentCreateDocumentTemporaryRequestTypedDict(TypedDict): List[DocumentCreateDocumentTemporaryGlobalActionAuthRequest] ] form_values: NotRequired[Dict[str, FormValuesRequestTypedDict]] + folder_id: NotRequired[str] + r"""The ID of the folder to create the document in. If not provided, the document will be created in the root folder.""" recipients: NotRequired[ List[DocumentCreateDocumentTemporaryRecipientRequestTypedDict] ] @@ -1218,6 +1357,9 @@ class DocumentCreateDocumentTemporaryRequest(BaseModel): Optional[Dict[str, FormValuesRequest]], pydantic.Field(alias="formValues") ] = None + folder_id: Annotated[Optional[str], pydantic.Field(alias="folderId")] = None + r"""The ID of the folder to create the document in. If not provided, the document will be created in the root folder.""" + recipients: Optional[List[DocumentCreateDocumentTemporaryRecipientRequest]] = None meta: Optional[DocumentCreateDocumentTemporaryMeta] = None @@ -1241,10 +1383,11 @@ class DocumentCreateDocumentTemporaryInternalServerErrorData(BaseModel): ) +@dataclass(unsafe_hash=True) class DocumentCreateDocumentTemporaryInternalServerError(DocumensoError): r"""Internal server error""" - data: DocumentCreateDocumentTemporaryInternalServerErrorData + data: DocumentCreateDocumentTemporaryInternalServerErrorData = field(hash=False) def __init__( self, @@ -1255,7 +1398,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class DocumentCreateDocumentTemporaryBadRequestIssueTypedDict(TypedDict): @@ -1274,10 +1417,11 @@ class DocumentCreateDocumentTemporaryBadRequestErrorData(BaseModel): issues: Optional[List[DocumentCreateDocumentTemporaryBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class DocumentCreateDocumentTemporaryBadRequestError(DocumensoError): r"""Invalid input data""" - data: DocumentCreateDocumentTemporaryBadRequestErrorData + data: DocumentCreateDocumentTemporaryBadRequestErrorData = field(hash=False) def __init__( self, @@ -1288,7 +1432,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class DocumentVisibility(str, Enum): @@ -1314,6 +1458,7 @@ class DocumentGlobalAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class DocumentGlobalActionAuth(str, Enum): @@ -1359,6 +1504,7 @@ class DocumentCreateDocumentTemporaryDocumentDataTypedDict(TypedDict): id: str data: str initial_data: str + envelope_item_id: str class DocumentCreateDocumentTemporaryDocumentData(BaseModel): @@ -1370,6 +1516,8 @@ class DocumentCreateDocumentTemporaryDocumentData(BaseModel): initial_data: Annotated[str, pydantic.Field(alias="initialData")] + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + class DocumentSigningOrder(str, Enum): PARALLEL = "PARALLEL" @@ -1442,9 +1590,7 @@ class DocumentCreateDocumentTemporaryDocumentMetaTypedDict(TypedDict): subject: Nullable[str] message: Nullable[str] timezone: Nullable[str] - password: Nullable[str] date_format: Nullable[str] - document_id: float redirect_url: Nullable[str] typed_signature_enabled: bool upload_signature_enabled: bool @@ -1452,6 +1598,10 @@ class DocumentCreateDocumentTemporaryDocumentMetaTypedDict(TypedDict): allow_dictate_next_signer: bool language: str email_settings: Nullable[DocumentEmailSettingsTypedDict] + email_id: Nullable[str] + email_reply_to: Nullable[str] + password: NotRequired[Nullable[str]] + document_id: NotRequired[float] class DocumentCreateDocumentTemporaryDocumentMeta(BaseModel): @@ -1469,12 +1619,8 @@ class DocumentCreateDocumentTemporaryDocumentMeta(BaseModel): timezone: Nullable[str] - password: Nullable[str] - date_format: Annotated[Nullable[str], pydantic.Field(alias="dateFormat")] - document_id: Annotated[float, pydantic.Field(alias="documentId")] - redirect_url: Annotated[Nullable[str], pydantic.Field(alias="redirectUrl")] typed_signature_enabled: Annotated[ @@ -1499,19 +1645,29 @@ class DocumentCreateDocumentTemporaryDocumentMeta(BaseModel): Nullable[DocumentEmailSettings], pydantic.Field(alias="emailSettings") ] + email_id: Annotated[Nullable[str], pydantic.Field(alias="emailId")] + + email_reply_to: Annotated[Nullable[str], pydantic.Field(alias="emailReplyTo")] + + password: OptionalNullable[str] = None + + document_id: Annotated[Optional[float], pydantic.Field(alias="documentId")] = -1 + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["password", "documentId"] nullable_fields = [ "subject", "message", "timezone", - "password", "dateFormat", "redirectUrl", "emailSettings", + "emailId", + "emailReplyTo", + "password", ] - null_default_fields = [] + null_default_fields = ["password"] serialized = handler(self) @@ -1642,6 +1798,7 @@ class DocumentAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class DocumentActionAuth(str, Enum): @@ -1666,13 +1823,12 @@ class DocumentCreateDocumentTemporaryRecipientAuthOptions(BaseModel): class DocumentRecipientTypedDict(TypedDict): + envelope_id: str role: DocumentRole read_status: DocumentCreateDocumentTemporaryReadStatus signing_status: DocumentCreateDocumentTemporarySigningStatus send_status: DocumentCreateDocumentTemporarySendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -1683,9 +1839,13 @@ class DocumentRecipientTypedDict(TypedDict): signing_order: Nullable[float] r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class DocumentRecipient(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: DocumentRole read_status: Annotated[ @@ -1703,10 +1863,6 @@ class DocumentRecipient(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -1731,18 +1887,26 @@ class DocumentRecipient(BaseModel): rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -1841,6 +2005,11 @@ class DocumentValue2(BaseModel): value: str +class DocumentDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldMetaDocumentCheckboxTypedDict(TypedDict): type: DocumentTypeCheckbox label: NotRequired[str] @@ -1850,6 +2019,7 @@ class FieldMetaDocumentCheckboxTypedDict(TypedDict): values: NotRequired[List[DocumentValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[DocumentDirection] class FieldMetaDocumentCheckbox(BaseModel): @@ -1873,6 +2043,8 @@ class FieldMetaDocumentCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[DocumentDirection] = DocumentDirection.VERTICAL + class DocumentTypeRadio(str, Enum): RADIO = "radio" @@ -1931,10 +2103,10 @@ class FieldMetaDocumentNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[DocumentTextAlign6] @@ -1950,13 +2122,19 @@ class FieldMetaDocumentNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -1964,6 +2142,47 @@ class FieldMetaDocumentNumber(BaseModel): Optional[DocumentTextAlign6], pydantic.Field(alias="textAlign") ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class DocumentTypeText(str, Enum): TEXT = "text" @@ -2172,8 +2391,8 @@ class FieldMetaDocumentInitials(BaseModel): FieldMetaDocumentEmailTypedDict, FieldMetaDocumentDateTypedDict, FieldMetaDocumentDropdownTypedDict, - FieldMetaDocumentCheckboxTypedDict, FieldMetaDocumentTextTypedDict, + FieldMetaDocumentCheckboxTypedDict, FieldMetaDocumentNumberTypedDict, ], ) @@ -2188,19 +2407,19 @@ class FieldMetaDocumentInitials(BaseModel): FieldMetaDocumentEmail, FieldMetaDocumentDate, FieldMetaDocumentDropdown, - FieldMetaDocumentCheckbox, FieldMetaDocumentText, + FieldMetaDocumentCheckbox, FieldMetaDocumentNumber, ], ) class DocumentFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: DocumentFieldType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -2211,19 +2430,21 @@ class DocumentFieldTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class DocumentField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: DocumentFieldType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -2245,10 +2466,25 @@ class DocumentField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -2276,7 +2512,7 @@ def serialize_model(self, handler): return m -class DocumentTypedDict(TypedDict): +class DocumentCreateDocumentTemporaryDocumentTypedDict(TypedDict): visibility: DocumentVisibility status: DocumentCreateDocumentTemporaryStatus source: DocumentCreateDocumentTemporarySource @@ -2288,22 +2524,24 @@ class DocumentTypedDict(TypedDict): auth_options: Nullable[DocumentCreateDocumentTemporaryAuthOptionsTypedDict] form_values: Nullable[Dict[str, DocumentFormValuesTypedDict]] title: str - document_data_id: str created_at: str updated_at: str completed_at: Nullable[str] deleted_at: Nullable[str] team_id: float - template_id: Nullable[float] folder_id: Nullable[str] + envelope_id: str document_data: DocumentCreateDocumentTemporaryDocumentDataTypedDict - document_meta: Nullable[DocumentCreateDocumentTemporaryDocumentMetaTypedDict] + document_meta: DocumentCreateDocumentTemporaryDocumentMetaTypedDict folder: Nullable[DocumentCreateDocumentTemporaryFolderTypedDict] recipients: List[DocumentRecipientTypedDict] fields: List[DocumentFieldTypedDict] + template_id: NotRequired[Nullable[float]] + r"""The ID of the template that the document was created from, if any.""" + document_data_id: NotRequired[str] -class Document(BaseModel): +class DocumentCreateDocumentTemporaryDocument(BaseModel): visibility: DocumentVisibility status: DocumentCreateDocumentTemporaryStatus @@ -2329,8 +2567,6 @@ class Document(BaseModel): title: str - document_data_id: Annotated[str, pydantic.Field(alias="documentDataId")] - created_at: Annotated[str, pydantic.Field(alias="createdAt")] updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] @@ -2341,17 +2577,17 @@ class Document(BaseModel): team_id: Annotated[float, pydantic.Field(alias="teamId")] - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + document_data: Annotated[ DocumentCreateDocumentTemporaryDocumentData, pydantic.Field(alias="documentData"), ] document_meta: Annotated[ - Nullable[DocumentCreateDocumentTemporaryDocumentMeta], + DocumentCreateDocumentTemporaryDocumentMeta, pydantic.Field(alias="documentMeta"), ] @@ -2361,18 +2597,26 @@ class Document(BaseModel): fields: List[DocumentField] + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + r"""The ID of the template that the document was created from, if any.""" + + document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="documentDataId") + ] = "" + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["templateId", "documentDataId"] nullable_fields = [ "externalId", "authOptions", "formValues", "completedAt", "deletedAt", - "templateId", "folderId", - "documentMeta", + "templateId", "folder", ] null_default_fields = [] @@ -2405,7 +2649,7 @@ def serialize_model(self, handler): class DocumentCreateDocumentTemporaryResponseTypedDict(TypedDict): r"""Successful response""" - document: DocumentTypedDict + document: DocumentCreateDocumentTemporaryDocumentTypedDict upload_url: str r"""The URL to upload the document PDF to. Use a PUT request with the file via form-data""" @@ -2413,7 +2657,7 @@ class DocumentCreateDocumentTemporaryResponseTypedDict(TypedDict): class DocumentCreateDocumentTemporaryResponse(BaseModel): r"""Successful response""" - document: Document + document: DocumentCreateDocumentTemporaryDocument upload_url: Annotated[str, pydantic.Field(alias="uploadUrl")] r"""The URL to upload the document PDF to. Use a PUT request with the file via form-data""" diff --git a/src/documenso_sdk/models/document_deletedocumentop.py b/src/documenso_sdk/models/document_deleteop.py similarity index 51% rename from src/documenso_sdk/models/document_deletedocumentop.py rename to src/documenso_sdk/models/document_deleteop.py index 0581b79..c0a2045 100644 --- a/src/documenso_sdk/models/document_deletedocumentop.py +++ b/src/documenso_sdk/models/document_deleteop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -9,87 +10,89 @@ from typing_extensions import Annotated, TypedDict -class DocumentDeleteDocumentRequestTypedDict(TypedDict): +class DocumentDeleteRequestTypedDict(TypedDict): document_id: float -class DocumentDeleteDocumentRequest(BaseModel): +class DocumentDeleteRequest(BaseModel): document_id: Annotated[float, pydantic.Field(alias="documentId")] -class DocumentDeleteDocumentInternalServerErrorIssueTypedDict(TypedDict): +class DocumentDeleteInternalServerErrorIssueTypedDict(TypedDict): message: str -class DocumentDeleteDocumentInternalServerErrorIssue(BaseModel): +class DocumentDeleteInternalServerErrorIssue(BaseModel): message: str -class DocumentDeleteDocumentInternalServerErrorData(BaseModel): +class DocumentDeleteInternalServerErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentDeleteDocumentInternalServerErrorIssue]] = None + issues: Optional[List[DocumentDeleteInternalServerErrorIssue]] = None -class DocumentDeleteDocumentInternalServerError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentDeleteInternalServerError(DocumensoError): r"""Internal server error""" - data: DocumentDeleteDocumentInternalServerErrorData + data: DocumentDeleteInternalServerErrorData = field(hash=False) def __init__( self, - data: DocumentDeleteDocumentInternalServerErrorData, + data: DocumentDeleteInternalServerErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentDeleteDocumentBadRequestIssueTypedDict(TypedDict): +class DocumentDeleteBadRequestIssueTypedDict(TypedDict): message: str -class DocumentDeleteDocumentBadRequestIssue(BaseModel): +class DocumentDeleteBadRequestIssue(BaseModel): message: str -class DocumentDeleteDocumentBadRequestErrorData(BaseModel): +class DocumentDeleteBadRequestErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentDeleteDocumentBadRequestIssue]] = None + issues: Optional[List[DocumentDeleteBadRequestIssue]] = None -class DocumentDeleteDocumentBadRequestError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentDeleteBadRequestError(DocumensoError): r"""Invalid input data""" - data: DocumentDeleteDocumentBadRequestErrorData + data: DocumentDeleteBadRequestErrorData = field(hash=False) def __init__( self, - data: DocumentDeleteDocumentBadRequestErrorData, + data: DocumentDeleteBadRequestErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentDeleteDocumentResponseTypedDict(TypedDict): +class DocumentDeleteResponseTypedDict(TypedDict): r"""Successful response""" success: bool -class DocumentDeleteDocumentResponse(BaseModel): +class DocumentDeleteResponse(BaseModel): r"""Successful response""" success: bool diff --git a/src/documenso_sdk/models/document_senddocumentop.py b/src/documenso_sdk/models/document_distributeop.py similarity index 57% rename from src/documenso_sdk/models/document_senddocumentop.py rename to src/documenso_sdk/models/document_distributeop.py index 989cdd8..9e9e3b2 100644 --- a/src/documenso_sdk/models/document_senddocumentop.py +++ b/src/documenso_sdk/models/document_distributeop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -11,29 +18,41 @@ from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict -class DocumentSendDocumentDateFormat(str, Enum): +class DocumentDistributeDateFormat(str, Enum): r"""The date format to use for date fields and signing the document.""" - YYYY_MM_DD_HH_MM_A = "yyyy-MM-dd hh:mm a" - YYYY_MM_DD = "yyyy-MM-dd" - DD_MM_YYYY_HH_MM_A = "dd/MM/yyyy hh:mm a" - MM_DD_YYYY_HH_MM_A = "MM/dd/yyyy hh:mm a" - YYYY_MM_DD_HH_MM = "yyyy-MM-dd HH:mm" - YY_MM_DD_HH_MM_A = "yy-MM-dd hh:mm a" - YYYY_MM_DD_HH_MM_SS = "yyyy-MM-dd HH:mm:ss" - MMMM_DD_YYYY_HH_MM_A = "MMMM dd, yyyy hh:mm a" - EEEE_MMMM_DD_YYYY_HH_MM_A = "EEEE, MMMM dd, yyyy hh:mm a" - YYYY_MM_DD_T_HH_MM_SS_SSSXXX = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" - - -class DocumentSendDocumentDistributionMethod(str, Enum): + YYYY_M_MDD_HH_MM_A = "yyyy-MM-dd hh:mm a" + YYYY_M_MDD = "yyyy-MM-dd" + DD_MM_SLASH_YYYY = "dd/MM/yyyy" + MM_DD_SLASH_YYYY = "MM/dd/yyyy" + YY_M_MDD = "yy-MM-dd" + MMMM_DD_COMMA_YYYY = "MMMM dd, yyyy" + EEEE_MMMM_DD_COMMA_YYYY = "EEEE, MMMM dd, yyyy" + DD_MM_SLASH_YYYY_HH_MM_A = "dd/MM/yyyy hh:mm a" + DD_MM_SLASH_YYYY_H_HMM = "dd/MM/yyyy HH:mm" + MM_DD_SLASH_YYYY_HH_MM_A = "MM/dd/yyyy hh:mm a" + MM_DD_SLASH_YYYY_H_HMM = "MM/dd/yyyy HH:mm" + DD_DOT_MM_DOT_YYYY = "dd.MM.yyyy" + DD_DOT_MM_DOT_YYYY_H_HMM = "dd.MM.yyyy HH:mm" + YYYY_M_MDD_H_HMM = "yyyy-MM-dd HH:mm" + YY_M_MDD_HH_MM_A = "yy-MM-dd hh:mm a" + YY_M_MDD_H_HMM = "yy-MM-dd HH:mm" + YYYY_M_MDD_H_HMMSS = "yyyy-MM-dd HH:mm:ss" + MMMM_DD_COMMA_YYYY_HH_MM_A = "MMMM dd, yyyy hh:mm a" + MMMM_DD_COMMA_YYYY_H_HMM = "MMMM dd, yyyy HH:mm" + EEEE_MMMM_DD_COMMA_YYYY_HH_MM_A = "EEEE, MMMM dd, yyyy hh:mm a" + EEEE_MMMM_DD_COMMA_YYYY_H_HMM = "EEEE, MMMM dd, yyyy HH:mm" + ISO8601_FULL = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" + + +class DocumentDistributeDistributionMethod(str, Enum): r"""The distribution method to use when sending the document to the recipients.""" EMAIL = "EMAIL" NONE = "NONE" -class DocumentSendDocumentLanguage(str, Enum): +class DocumentDistributeLanguage(str, Enum): r"""The language to use for email communications with recipients.""" DE = "de" @@ -44,7 +63,7 @@ class DocumentSendDocumentLanguage(str, Enum): PL = "pl" -class DocumentSendDocumentEmailSettingsTypedDict(TypedDict): +class DocumentDistributeEmailSettingsTypedDict(TypedDict): recipient_signing_request: NotRequired[bool] r"""Whether to send an email to all recipients that the document is ready for them to sign.""" recipient_removed: NotRequired[bool] @@ -61,7 +80,7 @@ class DocumentSendDocumentEmailSettingsTypedDict(TypedDict): r"""Whether to send an email to the document owner when the document is complete.""" -class DocumentSendDocumentEmailSettings(BaseModel): +class DocumentDistributeEmailSettings(BaseModel): recipient_signing_request: Annotated[ Optional[bool], pydantic.Field(alias="recipientSigningRequest") ] = True @@ -98,25 +117,27 @@ class DocumentSendDocumentEmailSettings(BaseModel): r"""Whether to send an email to the document owner when the document is complete.""" -class DocumentSendDocumentMetaTypedDict(TypedDict): +class DocumentDistributeMetaTypedDict(TypedDict): subject: NotRequired[str] r"""The subject of the email that will be sent to the recipients.""" message: NotRequired[str] r"""The message of the email that will be sent to the recipients.""" timezone: NotRequired[str] r"""The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne""" - date_format: NotRequired[DocumentSendDocumentDateFormat] + date_format: NotRequired[DocumentDistributeDateFormat] r"""The date format to use for date fields and signing the document.""" - distribution_method: NotRequired[DocumentSendDocumentDistributionMethod] + distribution_method: NotRequired[DocumentDistributeDistributionMethod] r"""The distribution method to use when sending the document to the recipients.""" redirect_url: NotRequired[str] r"""The URL to which the recipient should be redirected after signing the document.""" - language: NotRequired[DocumentSendDocumentLanguage] + language: NotRequired[DocumentDistributeLanguage] r"""The language to use for email communications with recipients.""" - email_settings: NotRequired[DocumentSendDocumentEmailSettingsTypedDict] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[DocumentDistributeEmailSettingsTypedDict] -class DocumentSendDocumentMeta(BaseModel): +class DocumentDistributeMeta(BaseModel): subject: Optional[str] = None r"""The subject of the email that will be sent to the recipients.""" @@ -127,12 +148,12 @@ class DocumentSendDocumentMeta(BaseModel): r"""The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne""" date_format: Annotated[ - Optional[DocumentSendDocumentDateFormat], pydantic.Field(alias="dateFormat") + Optional[DocumentDistributeDateFormat], pydantic.Field(alias="dateFormat") ] = None r"""The date format to use for date fields and signing the document.""" distribution_method: Annotated[ - Optional[DocumentSendDocumentDistributionMethod], + Optional[DocumentDistributeDistributionMethod], pydantic.Field(alias="distributionMethod"), ] = None r"""The distribution method to use when sending the document to the recipients.""" @@ -140,120 +161,169 @@ class DocumentSendDocumentMeta(BaseModel): redirect_url: Annotated[Optional[str], pydantic.Field(alias="redirectUrl")] = None r"""The URL to which the recipient should be redirected after signing the document.""" - language: Optional[DocumentSendDocumentLanguage] = None + language: Optional[DocumentDistributeLanguage] = None r"""The language to use for email communications with recipients.""" + email_id: Annotated[OptionalNullable[str], pydantic.Field(alias="emailId")] = UNSET + + email_reply_to: Annotated[ + OptionalNullable[str], pydantic.Field(alias="emailReplyTo") + ] = UNSET + email_settings: Annotated[ - Optional[DocumentSendDocumentEmailSettings], - pydantic.Field(alias="emailSettings"), + Optional[DocumentDistributeEmailSettings], pydantic.Field(alias="emailSettings") ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "subject", + "message", + "timezone", + "dateFormat", + "distributionMethod", + "redirectUrl", + "language", + "emailId", + "emailReplyTo", + "emailSettings", + ] + nullable_fields = ["emailId", "emailReplyTo"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val -class DocumentSendDocumentRequestTypedDict(TypedDict): + return m + + +class DocumentDistributeRequestTypedDict(TypedDict): document_id: float r"""The ID of the document to send.""" - meta: NotRequired[DocumentSendDocumentMetaTypedDict] + meta: NotRequired[DocumentDistributeMetaTypedDict] -class DocumentSendDocumentRequest(BaseModel): +class DocumentDistributeRequest(BaseModel): document_id: Annotated[float, pydantic.Field(alias="documentId")] r"""The ID of the document to send.""" - meta: Optional[DocumentSendDocumentMeta] = None + meta: Optional[DocumentDistributeMeta] = None -class DocumentSendDocumentInternalServerErrorIssueTypedDict(TypedDict): +class DocumentDistributeInternalServerErrorIssueTypedDict(TypedDict): message: str -class DocumentSendDocumentInternalServerErrorIssue(BaseModel): +class DocumentDistributeInternalServerErrorIssue(BaseModel): message: str -class DocumentSendDocumentInternalServerErrorData(BaseModel): +class DocumentDistributeInternalServerErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentSendDocumentInternalServerErrorIssue]] = None + issues: Optional[List[DocumentDistributeInternalServerErrorIssue]] = None -class DocumentSendDocumentInternalServerError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentDistributeInternalServerError(DocumensoError): r"""Internal server error""" - data: DocumentSendDocumentInternalServerErrorData + data: DocumentDistributeInternalServerErrorData = field(hash=False) def __init__( self, - data: DocumentSendDocumentInternalServerErrorData, + data: DocumentDistributeInternalServerErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentSendDocumentBadRequestIssueTypedDict(TypedDict): +class DocumentDistributeBadRequestIssueTypedDict(TypedDict): message: str -class DocumentSendDocumentBadRequestIssue(BaseModel): +class DocumentDistributeBadRequestIssue(BaseModel): message: str -class DocumentSendDocumentBadRequestErrorData(BaseModel): +class DocumentDistributeBadRequestErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentSendDocumentBadRequestIssue]] = None + issues: Optional[List[DocumentDistributeBadRequestIssue]] = None -class DocumentSendDocumentBadRequestError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentDistributeBadRequestError(DocumensoError): r"""Invalid input data""" - data: DocumentSendDocumentBadRequestErrorData + data: DocumentDistributeBadRequestErrorData = field(hash=False) def __init__( self, - data: DocumentSendDocumentBadRequestErrorData, + data: DocumentDistributeBadRequestErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentSendDocumentVisibility(str, Enum): +class DocumentDistributeVisibility(str, Enum): EVERYONE = "EVERYONE" MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" ADMIN = "ADMIN" -class DocumentSendDocumentStatus(str, Enum): +class DocumentDistributeStatus(str, Enum): DRAFT = "DRAFT" PENDING = "PENDING" COMPLETED = "COMPLETED" REJECTED = "REJECTED" -class DocumentSendDocumentSource(str, Enum): +class DocumentDistributeSource(str, Enum): DOCUMENT = "DOCUMENT" TEMPLATE = "TEMPLATE" TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" -class DocumentSendDocumentGlobalAccessAuth(str, Enum): +class DocumentDistributeGlobalAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" -class DocumentSendDocumentGlobalActionAuth(str, Enum): +class DocumentDistributeGlobalActionAuth(str, Enum): r"""The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only.""" ACCOUNT = "ACCOUNT" @@ -262,66 +332,68 @@ class DocumentSendDocumentGlobalActionAuth(str, Enum): PASSWORD = "PASSWORD" -class DocumentSendDocumentAuthOptionsTypedDict(TypedDict): - global_access_auth: List[DocumentSendDocumentGlobalAccessAuth] - global_action_auth: List[DocumentSendDocumentGlobalActionAuth] +class DocumentDistributeAuthOptionsTypedDict(TypedDict): + global_access_auth: List[DocumentDistributeGlobalAccessAuth] + global_action_auth: List[DocumentDistributeGlobalActionAuth] -class DocumentSendDocumentAuthOptions(BaseModel): +class DocumentDistributeAuthOptions(BaseModel): global_access_auth: Annotated[ - List[DocumentSendDocumentGlobalAccessAuth], + List[DocumentDistributeGlobalAccessAuth], pydantic.Field(alias="globalAccessAuth"), ] global_action_auth: Annotated[ - List[DocumentSendDocumentGlobalActionAuth], + List[DocumentDistributeGlobalActionAuth], pydantic.Field(alias="globalActionAuth"), ] -DocumentSendDocumentFormValuesTypedDict = TypeAliasType( - "DocumentSendDocumentFormValuesTypedDict", Union[str, bool, float] +DocumentDistributeFormValuesTypedDict = TypeAliasType( + "DocumentDistributeFormValuesTypedDict", Union[str, bool, float] ) -DocumentSendDocumentFormValues = TypeAliasType( - "DocumentSendDocumentFormValues", Union[str, bool, float] +DocumentDistributeFormValues = TypeAliasType( + "DocumentDistributeFormValues", Union[str, bool, float] ) -class DocumentSendDocumentResponseTypedDict(TypedDict): +class DocumentDistributeResponseTypedDict(TypedDict): r"""Successful response""" - visibility: DocumentSendDocumentVisibility - status: DocumentSendDocumentStatus - source: DocumentSendDocumentSource + visibility: DocumentDistributeVisibility + status: DocumentDistributeStatus + source: DocumentDistributeSource id: float external_id: Nullable[str] r"""A custom external ID you can use to identify the document.""" user_id: float r"""The ID of the user that created this document.""" - auth_options: Nullable[DocumentSendDocumentAuthOptionsTypedDict] - form_values: Nullable[Dict[str, DocumentSendDocumentFormValuesTypedDict]] + auth_options: Nullable[DocumentDistributeAuthOptionsTypedDict] + form_values: Nullable[Dict[str, DocumentDistributeFormValuesTypedDict]] title: str - document_data_id: str created_at: str updated_at: str completed_at: Nullable[str] deleted_at: Nullable[str] team_id: float - template_id: Nullable[float] folder_id: Nullable[str] use_legacy_field_insertion: bool + envelope_id: str + document_data_id: NotRequired[str] + template_id: NotRequired[Nullable[float]] + r"""The ID of the template that the document was created from, if any.""" -class DocumentSendDocumentResponse(BaseModel): +class DocumentDistributeResponse(BaseModel): r"""Successful response""" - visibility: DocumentSendDocumentVisibility + visibility: DocumentDistributeVisibility - status: DocumentSendDocumentStatus + status: DocumentDistributeStatus - source: DocumentSendDocumentSource + source: DocumentDistributeSource id: float @@ -332,18 +404,16 @@ class DocumentSendDocumentResponse(BaseModel): r"""The ID of the user that created this document.""" auth_options: Annotated[ - Nullable[DocumentSendDocumentAuthOptions], pydantic.Field(alias="authOptions") + Nullable[DocumentDistributeAuthOptions], pydantic.Field(alias="authOptions") ] form_values: Annotated[ - Nullable[Dict[str, DocumentSendDocumentFormValues]], + Nullable[Dict[str, DocumentDistributeFormValues]], pydantic.Field(alias="formValues"), ] title: str - document_data_id: Annotated[str, pydantic.Field(alias="documentDataId")] - created_at: Annotated[str, pydantic.Field(alias="createdAt")] updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] @@ -354,25 +424,34 @@ class DocumentSendDocumentResponse(BaseModel): team_id: Annotated[float, pydantic.Field(alias="teamId")] - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] use_legacy_field_insertion: Annotated[ bool, pydantic.Field(alias="useLegacyFieldInsertion") ] + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="documentDataId") + ] = "" + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + r"""The ID of the template that the document was created from, if any.""" + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentDataId", "templateId"] nullable_fields = [ "externalId", "authOptions", "formValues", "completedAt", "deletedAt", - "templateId", "folderId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/document_downloadop.py b/src/documenso_sdk/models/document_downloadop.py new file mode 100644 index 0000000..97d4dc4 --- /dev/null +++ b/src/documenso_sdk/models/document_downloadop.py @@ -0,0 +1,167 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from dataclasses import dataclass, field +from documenso_sdk.models import DocumensoError +from documenso_sdk.types import BaseModel +from documenso_sdk.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata +from enum import Enum +import httpx +import pydantic +from typing import List, Optional +from typing_extensions import Annotated, NotRequired, TypedDict + + +class Version(str, Enum): + r"""The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.""" + + ORIGINAL = "original" + SIGNED = "signed" + + +class DocumentDownloadRequestTypedDict(TypedDict): + document_id: float + r"""The ID of the document to download.""" + version: NotRequired[Version] + r"""The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.""" + + +class DocumentDownloadRequest(BaseModel): + document_id: Annotated[ + float, + pydantic.Field(alias="documentId"), + FieldMetadata(path=PathParamMetadata(style="simple", explode=False)), + ] + r"""The ID of the document to download.""" + + version: Annotated[ + Optional[Version], + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = Version.SIGNED + r"""The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.""" + + +class DocumentDownloadInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentDownloadInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentDownloadInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDownloadInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDownloadInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentDownloadInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDownloadInternalServerErrorData, + raw_response: httpx.Response, + body: Optional[str] = None, + ): + fallback = body or raw_response.text + message = str(data.message) or fallback + super().__init__(message, raw_response, body) + object.__setattr__(self, "data", data) + + +class DocumentDownloadNotFoundIssueTypedDict(TypedDict): + message: str + + +class DocumentDownloadNotFoundIssue(BaseModel): + message: str + + +class DocumentDownloadNotFoundErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDownloadNotFoundIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDownloadNotFoundError(DocumensoError): + r"""Not found""" + + data: DocumentDownloadNotFoundErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDownloadNotFoundErrorData, + raw_response: httpx.Response, + body: Optional[str] = None, + ): + fallback = body or raw_response.text + message = str(data.message) or fallback + super().__init__(message, raw_response, body) + object.__setattr__(self, "data", data) + + +class DocumentDownloadBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentDownloadBadRequestIssue(BaseModel): + message: str + + +class DocumentDownloadBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDownloadBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDownloadBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentDownloadBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDownloadBadRequestErrorData, + raw_response: httpx.Response, + body: Optional[str] = None, + ): + fallback = body or raw_response.text + message = str(data.message) or fallback + super().__init__(message, raw_response, body) + object.__setattr__(self, "data", data) + + +class DocumentDownloadResponseTypedDict(TypedDict): + r"""Successful response""" + + download_url: str + r"""Pre-signed URL for downloading the PDF file""" + filename: str + r"""The filename of the PDF file""" + content_type: str + r"""MIME type of the file""" + + +class DocumentDownloadResponse(BaseModel): + r"""Successful response""" + + download_url: Annotated[str, pydantic.Field(alias="downloadUrl")] + r"""Pre-signed URL for downloading the PDF file""" + + filename: str + r"""The filename of the PDF file""" + + content_type: Annotated[str, pydantic.Field(alias="contentType")] + r"""MIME type of the file""" diff --git a/src/documenso_sdk/models/document_duplicatedocumentop.py b/src/documenso_sdk/models/document_duplicatedocumentop.py deleted file mode 100644 index 30bd9dc..0000000 --- a/src/documenso_sdk/models/document_duplicatedocumentop.py +++ /dev/null @@ -1,95 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" - -from __future__ import annotations -from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel -import httpx -import pydantic -from typing import List, Optional -from typing_extensions import Annotated, TypedDict - - -class DocumentDuplicateDocumentRequestTypedDict(TypedDict): - document_id: float - - -class DocumentDuplicateDocumentRequest(BaseModel): - document_id: Annotated[float, pydantic.Field(alias="documentId")] - - -class DocumentDuplicateDocumentInternalServerErrorIssueTypedDict(TypedDict): - message: str - - -class DocumentDuplicateDocumentInternalServerErrorIssue(BaseModel): - message: str - - -class DocumentDuplicateDocumentInternalServerErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentDuplicateDocumentInternalServerErrorIssue]] = None - - -class DocumentDuplicateDocumentInternalServerError(DocumensoError): - r"""Internal server error""" - - data: DocumentDuplicateDocumentInternalServerErrorData - - def __init__( - self, - data: DocumentDuplicateDocumentInternalServerErrorData, - raw_response: httpx.Response, - body: Optional[str] = None, - ): - fallback = body or raw_response.text - message = str(data.message) or fallback - super().__init__(message, raw_response, body) - self.data = data - - -class DocumentDuplicateDocumentBadRequestIssueTypedDict(TypedDict): - message: str - - -class DocumentDuplicateDocumentBadRequestIssue(BaseModel): - message: str - - -class DocumentDuplicateDocumentBadRequestErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentDuplicateDocumentBadRequestIssue]] = None - - -class DocumentDuplicateDocumentBadRequestError(DocumensoError): - r"""Invalid input data""" - - data: DocumentDuplicateDocumentBadRequestErrorData - - def __init__( - self, - data: DocumentDuplicateDocumentBadRequestErrorData, - raw_response: httpx.Response, - body: Optional[str] = None, - ): - fallback = body or raw_response.text - message = str(data.message) or fallback - super().__init__(message, raw_response, body) - self.data = data - - -class DocumentDuplicateDocumentResponseTypedDict(TypedDict): - r"""Successful response""" - - document_id: float - - -class DocumentDuplicateDocumentResponse(BaseModel): - r"""Successful response""" - - document_id: Annotated[float, pydantic.Field(alias="documentId")] diff --git a/src/documenso_sdk/models/document_duplicateop.py b/src/documenso_sdk/models/document_duplicateop.py new file mode 100644 index 0000000..5d2294e --- /dev/null +++ b/src/documenso_sdk/models/document_duplicateop.py @@ -0,0 +1,105 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from dataclasses import dataclass, field +from documenso_sdk.models import DocumensoError +from documenso_sdk.types import BaseModel +import httpx +import pydantic +from typing import List, Optional +from typing_extensions import Annotated, TypedDict + + +class DocumentDuplicateRequestTypedDict(TypedDict): + document_id: float + + +class DocumentDuplicateRequest(BaseModel): + document_id: Annotated[float, pydantic.Field(alias="documentId")] + + +class DocumentDuplicateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentDuplicateInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentDuplicateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDuplicateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDuplicateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentDuplicateInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDuplicateInternalServerErrorData, + raw_response: httpx.Response, + body: Optional[str] = None, + ): + fallback = body or raw_response.text + message = str(data.message) or fallback + super().__init__(message, raw_response, body) + object.__setattr__(self, "data", data) + + +class DocumentDuplicateBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentDuplicateBadRequestIssue(BaseModel): + message: str + + +class DocumentDuplicateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDuplicateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDuplicateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentDuplicateBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDuplicateBadRequestErrorData, + raw_response: httpx.Response, + body: Optional[str] = None, + ): + fallback = body or raw_response.text + message = str(data.message) or fallback + super().__init__(message, raw_response, body) + object.__setattr__(self, "data", data) + + +class DocumentDuplicateResponseTypedDict(TypedDict): + r"""Successful response""" + + id: str + r"""The envelope ID""" + document_id: float + r"""The legacy document ID""" + + +class DocumentDuplicateResponse(BaseModel): + r"""Successful response""" + + id: str + r"""The envelope ID""" + + document_id: Annotated[float, pydantic.Field(alias="documentId")] + r"""The legacy document ID""" diff --git a/src/documenso_sdk/models/document_finddocumentsop.py b/src/documenso_sdk/models/document_findop.py similarity index 69% rename from src/documenso_sdk/models/document_finddocumentsop.py rename to src/documenso_sdk/models/document_findop.py index 69c2345..a3e0c10 100644 --- a/src/documenso_sdk/models/document_finddocumentsop.py +++ b/src/documenso_sdk/models/document_findop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from documenso_sdk.utils import FieldMetadata, QueryParamMetadata from enum import Enum import httpx @@ -38,7 +45,7 @@ class OrderByDirection(str, Enum): DESC = "desc" -class DocumentFindDocumentsRequestTypedDict(TypedDict): +class DocumentFindRequestTypedDict(TypedDict): query: NotRequired[str] r"""The search query.""" page: NotRequired[float] @@ -57,7 +64,7 @@ class DocumentFindDocumentsRequestTypedDict(TypedDict): order_by_direction: NotRequired[OrderByDirection] -class DocumentFindDocumentsRequest(BaseModel): +class DocumentFindRequest(BaseModel): query: Annotated[ Optional[str], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), @@ -116,106 +123,109 @@ class DocumentFindDocumentsRequest(BaseModel): ] = OrderByDirection.DESC -class DocumentFindDocumentsInternalServerErrorIssueTypedDict(TypedDict): +class DocumentFindInternalServerErrorIssueTypedDict(TypedDict): message: str -class DocumentFindDocumentsInternalServerErrorIssue(BaseModel): +class DocumentFindInternalServerErrorIssue(BaseModel): message: str -class DocumentFindDocumentsInternalServerErrorData(BaseModel): +class DocumentFindInternalServerErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentFindDocumentsInternalServerErrorIssue]] = None + issues: Optional[List[DocumentFindInternalServerErrorIssue]] = None -class DocumentFindDocumentsInternalServerError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentFindInternalServerError(DocumensoError): r"""Internal server error""" - data: DocumentFindDocumentsInternalServerErrorData + data: DocumentFindInternalServerErrorData = field(hash=False) def __init__( self, - data: DocumentFindDocumentsInternalServerErrorData, + data: DocumentFindInternalServerErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentFindDocumentsNotFoundIssueTypedDict(TypedDict): +class DocumentFindNotFoundIssueTypedDict(TypedDict): message: str -class DocumentFindDocumentsNotFoundIssue(BaseModel): +class DocumentFindNotFoundIssue(BaseModel): message: str -class DocumentFindDocumentsNotFoundErrorData(BaseModel): +class DocumentFindNotFoundErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentFindDocumentsNotFoundIssue]] = None + issues: Optional[List[DocumentFindNotFoundIssue]] = None -class DocumentFindDocumentsNotFoundError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentFindNotFoundError(DocumensoError): r"""Not found""" - data: DocumentFindDocumentsNotFoundErrorData + data: DocumentFindNotFoundErrorData = field(hash=False) def __init__( self, - data: DocumentFindDocumentsNotFoundErrorData, + data: DocumentFindNotFoundErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentFindDocumentsBadRequestIssueTypedDict(TypedDict): +class DocumentFindBadRequestIssueTypedDict(TypedDict): message: str -class DocumentFindDocumentsBadRequestIssue(BaseModel): +class DocumentFindBadRequestIssue(BaseModel): message: str -class DocumentFindDocumentsBadRequestErrorData(BaseModel): +class DocumentFindBadRequestErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentFindDocumentsBadRequestIssue]] = None + issues: Optional[List[DocumentFindBadRequestIssue]] = None -class DocumentFindDocumentsBadRequestError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentFindBadRequestError(DocumensoError): r"""Invalid input data""" - data: DocumentFindDocumentsBadRequestErrorData + data: DocumentFindBadRequestErrorData = field(hash=False) def __init__( self, - data: DocumentFindDocumentsBadRequestErrorData, + data: DocumentFindBadRequestErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentFindDocumentsVisibility(str, Enum): +class DocumentFindVisibility(str, Enum): EVERYONE = "EVERYONE" MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" ADMIN = "ADMIN" @@ -234,13 +244,14 @@ class DataSource(str, Enum): TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" -class DocumentFindDocumentsGlobalAccessAuth(str, Enum): +class DocumentFindGlobalAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" -class DocumentFindDocumentsGlobalActionAuth(str, Enum): +class DocumentFindGlobalActionAuth(str, Enum): r"""The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only.""" ACCOUNT = "ACCOUNT" @@ -249,40 +260,38 @@ class DocumentFindDocumentsGlobalActionAuth(str, Enum): PASSWORD = "PASSWORD" -class DocumentFindDocumentsAuthOptionsTypedDict(TypedDict): - global_access_auth: List[DocumentFindDocumentsGlobalAccessAuth] - global_action_auth: List[DocumentFindDocumentsGlobalActionAuth] +class DocumentFindAuthOptionsTypedDict(TypedDict): + global_access_auth: List[DocumentFindGlobalAccessAuth] + global_action_auth: List[DocumentFindGlobalActionAuth] -class DocumentFindDocumentsAuthOptions(BaseModel): +class DocumentFindAuthOptions(BaseModel): global_access_auth: Annotated[ - List[DocumentFindDocumentsGlobalAccessAuth], - pydantic.Field(alias="globalAccessAuth"), + List[DocumentFindGlobalAccessAuth], pydantic.Field(alias="globalAccessAuth") ] global_action_auth: Annotated[ - List[DocumentFindDocumentsGlobalActionAuth], - pydantic.Field(alias="globalActionAuth"), + List[DocumentFindGlobalActionAuth], pydantic.Field(alias="globalActionAuth") ] -DocumentFindDocumentsFormValuesTypedDict = TypeAliasType( - "DocumentFindDocumentsFormValuesTypedDict", Union[str, bool, float] +DocumentFindFormValuesTypedDict = TypeAliasType( + "DocumentFindFormValuesTypedDict", Union[str, bool, float] ) -DocumentFindDocumentsFormValues = TypeAliasType( - "DocumentFindDocumentsFormValues", Union[str, bool, float] +DocumentFindFormValues = TypeAliasType( + "DocumentFindFormValues", Union[str, bool, float] ) -class DocumentFindDocumentsUserTypedDict(TypedDict): +class DocumentFindUserTypedDict(TypedDict): id: float name: Nullable[str] email: str -class DocumentFindDocumentsUser(BaseModel): +class DocumentFindUser(BaseModel): id: float name: Nullable[str] @@ -320,7 +329,7 @@ def serialize_model(self, handler): return m -class DocumentFindDocumentsRole(str, Enum): +class DocumentFindRole(str, Enum): CC = "CC" SIGNER = "SIGNER" VIEWER = "VIEWER" @@ -328,29 +337,30 @@ class DocumentFindDocumentsRole(str, Enum): ASSISTANT = "ASSISTANT" -class DocumentFindDocumentsReadStatus(str, Enum): +class DocumentFindReadStatus(str, Enum): NOT_OPENED = "NOT_OPENED" OPENED = "OPENED" -class DocumentFindDocumentsSigningStatus(str, Enum): +class DocumentFindSigningStatus(str, Enum): NOT_SIGNED = "NOT_SIGNED" SIGNED = "SIGNED" REJECTED = "REJECTED" -class DocumentFindDocumentsSendStatus(str, Enum): +class DocumentFindSendStatus(str, Enum): NOT_SENT = "NOT_SENT" SENT = "SENT" -class DocumentFindDocumentsAccessAuth(str, Enum): +class DocumentFindAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" -class DocumentFindDocumentsActionAuth(str, Enum): +class DocumentFindActionAuth(str, Enum): r"""The type of authentication required for the recipient to sign the document.""" ACCOUNT = "ACCOUNT" @@ -360,62 +370,57 @@ class DocumentFindDocumentsActionAuth(str, Enum): EXPLICIT_NONE = "EXPLICIT_NONE" -class DocumentFindDocumentsRecipientAuthOptionsTypedDict(TypedDict): - access_auth: List[DocumentFindDocumentsAccessAuth] - action_auth: List[DocumentFindDocumentsActionAuth] +class DocumentFindRecipientAuthOptionsTypedDict(TypedDict): + access_auth: List[DocumentFindAccessAuth] + action_auth: List[DocumentFindActionAuth] -class DocumentFindDocumentsRecipientAuthOptions(BaseModel): +class DocumentFindRecipientAuthOptions(BaseModel): access_auth: Annotated[ - List[DocumentFindDocumentsAccessAuth], pydantic.Field(alias="accessAuth") + List[DocumentFindAccessAuth], pydantic.Field(alias="accessAuth") ] action_auth: Annotated[ - List[DocumentFindDocumentsActionAuth], pydantic.Field(alias="actionAuth") + List[DocumentFindActionAuth], pydantic.Field(alias="actionAuth") ] -class DocumentFindDocumentsRecipientTypedDict(TypedDict): - role: DocumentFindDocumentsRole - read_status: DocumentFindDocumentsReadStatus - signing_status: DocumentFindDocumentsSigningStatus - send_status: DocumentFindDocumentsSendStatus +class DocumentFindRecipientTypedDict(TypedDict): + envelope_id: str + role: DocumentFindRole + read_status: DocumentFindReadStatus + signing_status: DocumentFindSigningStatus + send_status: DocumentFindSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str document_deleted_at: Nullable[str] expired: Nullable[str] signed_at: Nullable[str] - auth_options: Nullable[DocumentFindDocumentsRecipientAuthOptionsTypedDict] + auth_options: Nullable[DocumentFindRecipientAuthOptionsTypedDict] signing_order: Nullable[float] r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] -class DocumentFindDocumentsRecipient(BaseModel): - role: DocumentFindDocumentsRole +class DocumentFindRecipient(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] - read_status: Annotated[ - DocumentFindDocumentsReadStatus, pydantic.Field(alias="readStatus") - ] + role: DocumentFindRole + + read_status: Annotated[DocumentFindReadStatus, pydantic.Field(alias="readStatus")] signing_status: Annotated[ - DocumentFindDocumentsSigningStatus, pydantic.Field(alias="signingStatus") + DocumentFindSigningStatus, pydantic.Field(alias="signingStatus") ] - send_status: Annotated[ - DocumentFindDocumentsSendStatus, pydantic.Field(alias="sendStatus") - ] + send_status: Annotated[DocumentFindSendStatus, pydantic.Field(alias="sendStatus")] id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -431,8 +436,7 @@ class DocumentFindDocumentsRecipient(BaseModel): signed_at: Annotated[Nullable[str], pydantic.Field(alias="signedAt")] auth_options: Annotated[ - Nullable[DocumentFindDocumentsRecipientAuthOptions], - pydantic.Field(alias="authOptions"), + Nullable[DocumentFindRecipientAuthOptions], pydantic.Field(alias="authOptions") ] signing_order: Annotated[Nullable[float], pydantic.Field(alias="signingOrder")] @@ -440,18 +444,26 @@ class DocumentFindDocumentsRecipient(BaseModel): rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -480,19 +492,19 @@ def serialize_model(self, handler): return m -class DocumentFindDocumentsTeamTypedDict(TypedDict): +class DocumentFindTeamTypedDict(TypedDict): id: float url: str -class DocumentFindDocumentsTeam(BaseModel): +class DocumentFindTeam(BaseModel): id: float url: str -class DocumentFindDocumentsDataTypedDict(TypedDict): - visibility: DocumentFindDocumentsVisibility +class DocumentFindDataTypedDict(TypedDict): + visibility: DocumentFindVisibility status: DataStatus source: DataSource id: float @@ -500,25 +512,27 @@ class DocumentFindDocumentsDataTypedDict(TypedDict): r"""A custom external ID you can use to identify the document.""" user_id: float r"""The ID of the user that created this document.""" - auth_options: Nullable[DocumentFindDocumentsAuthOptionsTypedDict] - form_values: Nullable[Dict[str, DocumentFindDocumentsFormValuesTypedDict]] + auth_options: Nullable[DocumentFindAuthOptionsTypedDict] + form_values: Nullable[Dict[str, DocumentFindFormValuesTypedDict]] title: str - document_data_id: str created_at: str updated_at: str completed_at: Nullable[str] deleted_at: Nullable[str] team_id: float - template_id: Nullable[float] folder_id: Nullable[str] use_legacy_field_insertion: bool - user: DocumentFindDocumentsUserTypedDict - recipients: List[DocumentFindDocumentsRecipientTypedDict] - team: Nullable[DocumentFindDocumentsTeamTypedDict] + envelope_id: str + user: DocumentFindUserTypedDict + recipients: List[DocumentFindRecipientTypedDict] + team: Nullable[DocumentFindTeamTypedDict] + document_data_id: NotRequired[str] + template_id: NotRequired[Nullable[float]] + r"""The ID of the template that the document was created from, if any.""" -class DocumentFindDocumentsData(BaseModel): - visibility: DocumentFindDocumentsVisibility +class DocumentFindData(BaseModel): + visibility: DocumentFindVisibility status: DataStatus @@ -533,18 +547,15 @@ class DocumentFindDocumentsData(BaseModel): r"""The ID of the user that created this document.""" auth_options: Annotated[ - Nullable[DocumentFindDocumentsAuthOptions], pydantic.Field(alias="authOptions") + Nullable[DocumentFindAuthOptions], pydantic.Field(alias="authOptions") ] form_values: Annotated[ - Nullable[Dict[str, DocumentFindDocumentsFormValues]], - pydantic.Field(alias="formValues"), + Nullable[Dict[str, DocumentFindFormValues]], pydantic.Field(alias="formValues") ] title: str - document_data_id: Annotated[str, pydantic.Field(alias="documentDataId")] - created_at: Annotated[str, pydantic.Field(alias="createdAt")] updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] @@ -555,31 +566,40 @@ class DocumentFindDocumentsData(BaseModel): team_id: Annotated[float, pydantic.Field(alias="teamId")] - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] use_legacy_field_insertion: Annotated[ bool, pydantic.Field(alias="useLegacyFieldInsertion") ] - user: DocumentFindDocumentsUser + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + user: DocumentFindUser - recipients: List[DocumentFindDocumentsRecipient] + recipients: List[DocumentFindRecipient] - team: Nullable[DocumentFindDocumentsTeam] + team: Nullable[DocumentFindTeam] + + document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="documentDataId") + ] = "" + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + r"""The ID of the template that the document was created from, if any.""" @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentDataId", "templateId"] nullable_fields = [ "externalId", "authOptions", "formValues", "completedAt", "deletedAt", - "templateId", "folderId", + "templateId", "team", ] null_default_fields = [] @@ -609,10 +629,10 @@ def serialize_model(self, handler): return m -class DocumentFindDocumentsResponseTypedDict(TypedDict): +class DocumentFindResponseTypedDict(TypedDict): r"""Successful response""" - data: List[DocumentFindDocumentsDataTypedDict] + data: List[DocumentFindDataTypedDict] count: float r"""The total number of items.""" current_page: float @@ -623,10 +643,10 @@ class DocumentFindDocumentsResponseTypedDict(TypedDict): r"""The total number of pages.""" -class DocumentFindDocumentsResponse(BaseModel): +class DocumentFindResponse(BaseModel): r"""Successful response""" - data: List[DocumentFindDocumentsData] + data: List[DocumentFindData] count: float r"""The total number of items.""" diff --git a/src/documenso_sdk/models/document_getdocumentwithdetailsbyidop.py b/src/documenso_sdk/models/document_getop.py similarity index 56% rename from src/documenso_sdk/models/document_getdocumentwithdetailsbyidop.py rename to src/documenso_sdk/models/document_getop.py index 4873cb5..9c8e74a 100644 --- a/src/documenso_sdk/models/document_getdocumentwithdetailsbyidop.py +++ b/src/documenso_sdk/models/document_getop.py @@ -1,9 +1,16 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL -from documenso_sdk.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) +from documenso_sdk.utils import FieldMetadata, PathParamMetadata from enum import Enum import httpx import pydantic @@ -12,154 +19,147 @@ from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict -class DocumentGetDocumentWithDetailsByIDRequestTypedDict(TypedDict): +class DocumentGetRequestTypedDict(TypedDict): document_id: float - folder_id: NotRequired[str] - r"""Filter documents by folder ID""" -class DocumentGetDocumentWithDetailsByIDRequest(BaseModel): +class DocumentGetRequest(BaseModel): document_id: Annotated[ float, pydantic.Field(alias="documentId"), FieldMetadata(path=PathParamMetadata(style="simple", explode=False)), ] - folder_id: Annotated[ - Optional[str], - pydantic.Field(alias="folderId"), - FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), - ] = None - r"""Filter documents by folder ID""" - -class DocumentGetDocumentWithDetailsByIDInternalServerErrorIssueTypedDict(TypedDict): +class DocumentGetInternalServerErrorIssueTypedDict(TypedDict): message: str -class DocumentGetDocumentWithDetailsByIDInternalServerErrorIssue(BaseModel): +class DocumentGetInternalServerErrorIssue(BaseModel): message: str -class DocumentGetDocumentWithDetailsByIDInternalServerErrorData(BaseModel): +class DocumentGetInternalServerErrorData(BaseModel): message: str code: str - issues: Optional[ - List[DocumentGetDocumentWithDetailsByIDInternalServerErrorIssue] - ] = None + issues: Optional[List[DocumentGetInternalServerErrorIssue]] = None -class DocumentGetDocumentWithDetailsByIDInternalServerError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentGetInternalServerError(DocumensoError): r"""Internal server error""" - data: DocumentGetDocumentWithDetailsByIDInternalServerErrorData + data: DocumentGetInternalServerErrorData = field(hash=False) def __init__( self, - data: DocumentGetDocumentWithDetailsByIDInternalServerErrorData, + data: DocumentGetInternalServerErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentGetDocumentWithDetailsByIDNotFoundIssueTypedDict(TypedDict): +class DocumentGetNotFoundIssueTypedDict(TypedDict): message: str -class DocumentGetDocumentWithDetailsByIDNotFoundIssue(BaseModel): +class DocumentGetNotFoundIssue(BaseModel): message: str -class DocumentGetDocumentWithDetailsByIDNotFoundErrorData(BaseModel): +class DocumentGetNotFoundErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentGetDocumentWithDetailsByIDNotFoundIssue]] = None + issues: Optional[List[DocumentGetNotFoundIssue]] = None -class DocumentGetDocumentWithDetailsByIDNotFoundError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentGetNotFoundError(DocumensoError): r"""Not found""" - data: DocumentGetDocumentWithDetailsByIDNotFoundErrorData + data: DocumentGetNotFoundErrorData = field(hash=False) def __init__( self, - data: DocumentGetDocumentWithDetailsByIDNotFoundErrorData, + data: DocumentGetNotFoundErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentGetDocumentWithDetailsByIDBadRequestIssueTypedDict(TypedDict): +class DocumentGetBadRequestIssueTypedDict(TypedDict): message: str -class DocumentGetDocumentWithDetailsByIDBadRequestIssue(BaseModel): +class DocumentGetBadRequestIssue(BaseModel): message: str -class DocumentGetDocumentWithDetailsByIDBadRequestErrorData(BaseModel): +class DocumentGetBadRequestErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentGetDocumentWithDetailsByIDBadRequestIssue]] = None + issues: Optional[List[DocumentGetBadRequestIssue]] = None -class DocumentGetDocumentWithDetailsByIDBadRequestError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentGetBadRequestError(DocumensoError): r"""Invalid input data""" - data: DocumentGetDocumentWithDetailsByIDBadRequestErrorData + data: DocumentGetBadRequestErrorData = field(hash=False) def __init__( self, - data: DocumentGetDocumentWithDetailsByIDBadRequestErrorData, + data: DocumentGetBadRequestErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentGetDocumentWithDetailsByIDVisibility(str, Enum): +class DocumentGetVisibility(str, Enum): EVERYONE = "EVERYONE" MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" ADMIN = "ADMIN" -class DocumentGetDocumentWithDetailsByIDStatus(str, Enum): +class DocumentGetStatus(str, Enum): DRAFT = "DRAFT" PENDING = "PENDING" COMPLETED = "COMPLETED" REJECTED = "REJECTED" -class DocumentGetDocumentWithDetailsByIDSource(str, Enum): +class DocumentGetSource(str, Enum): DOCUMENT = "DOCUMENT" TEMPLATE = "TEMPLATE" TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" -class DocumentGetDocumentWithDetailsByIDGlobalAccessAuth(str, Enum): +class DocumentGetGlobalAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" -class DocumentGetDocumentWithDetailsByIDGlobalActionAuth(str, Enum): +class DocumentGetGlobalActionAuth(str, Enum): r"""The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only.""" ACCOUNT = "ACCOUNT" @@ -168,48 +168,45 @@ class DocumentGetDocumentWithDetailsByIDGlobalActionAuth(str, Enum): PASSWORD = "PASSWORD" -class DocumentGetDocumentWithDetailsByIDAuthOptionsTypedDict(TypedDict): - global_access_auth: List[DocumentGetDocumentWithDetailsByIDGlobalAccessAuth] - global_action_auth: List[DocumentGetDocumentWithDetailsByIDGlobalActionAuth] +class DocumentGetAuthOptionsTypedDict(TypedDict): + global_access_auth: List[DocumentGetGlobalAccessAuth] + global_action_auth: List[DocumentGetGlobalActionAuth] -class DocumentGetDocumentWithDetailsByIDAuthOptions(BaseModel): +class DocumentGetAuthOptions(BaseModel): global_access_auth: Annotated[ - List[DocumentGetDocumentWithDetailsByIDGlobalAccessAuth], - pydantic.Field(alias="globalAccessAuth"), + List[DocumentGetGlobalAccessAuth], pydantic.Field(alias="globalAccessAuth") ] global_action_auth: Annotated[ - List[DocumentGetDocumentWithDetailsByIDGlobalActionAuth], - pydantic.Field(alias="globalActionAuth"), + List[DocumentGetGlobalActionAuth], pydantic.Field(alias="globalActionAuth") ] -DocumentGetDocumentWithDetailsByIDFormValuesTypedDict = TypeAliasType( - "DocumentGetDocumentWithDetailsByIDFormValuesTypedDict", Union[str, bool, float] +DocumentGetFormValuesTypedDict = TypeAliasType( + "DocumentGetFormValuesTypedDict", Union[str, bool, float] ) -DocumentGetDocumentWithDetailsByIDFormValues = TypeAliasType( - "DocumentGetDocumentWithDetailsByIDFormValues", Union[str, bool, float] -) +DocumentGetFormValues = TypeAliasType("DocumentGetFormValues", Union[str, bool, float]) -class DocumentGetDocumentWithDetailsByIDDocumentDataType(str, Enum): +class DocumentGetDocumentDataType(str, Enum): S3_PATH = "S3_PATH" BYTES = "BYTES" BYTES_64 = "BYTES_64" -class DocumentGetDocumentWithDetailsByIDDocumentDataTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDDocumentDataType +class DocumentGetDocumentDataTypedDict(TypedDict): + type: DocumentGetDocumentDataType id: str data: str initial_data: str + envelope_item_id: str -class DocumentGetDocumentWithDetailsByIDDocumentData(BaseModel): - type: DocumentGetDocumentWithDetailsByIDDocumentDataType +class DocumentGetDocumentData(BaseModel): + type: DocumentGetDocumentDataType id: str @@ -217,18 +214,20 @@ class DocumentGetDocumentWithDetailsByIDDocumentData(BaseModel): initial_data: Annotated[str, pydantic.Field(alias="initialData")] + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] -class DocumentGetDocumentWithDetailsByIDSigningOrder(str, Enum): + +class DocumentGetSigningOrder(str, Enum): PARALLEL = "PARALLEL" SEQUENTIAL = "SEQUENTIAL" -class DocumentGetDocumentWithDetailsByIDDistributionMethod(str, Enum): +class DocumentGetDistributionMethod(str, Enum): EMAIL = "EMAIL" NONE = "NONE" -class DocumentGetDocumentWithDetailsByIDEmailSettingsTypedDict(TypedDict): +class DocumentGetEmailSettingsTypedDict(TypedDict): recipient_signing_request: NotRequired[bool] r"""Whether to send an email to all recipients that the document is ready for them to sign.""" recipient_removed: NotRequired[bool] @@ -245,7 +244,7 @@ class DocumentGetDocumentWithDetailsByIDEmailSettingsTypedDict(TypedDict): r"""Whether to send an email to the document owner when the document is complete.""" -class DocumentGetDocumentWithDetailsByIDEmailSettings(BaseModel): +class DocumentGetEmailSettings(BaseModel): recipient_signing_request: Annotated[ Optional[bool], pydantic.Field(alias="recipientSigningRequest") ] = True @@ -282,34 +281,34 @@ class DocumentGetDocumentWithDetailsByIDEmailSettings(BaseModel): r"""Whether to send an email to the document owner when the document is complete.""" -class DocumentGetDocumentWithDetailsByIDDocumentMetaTypedDict(TypedDict): - signing_order: DocumentGetDocumentWithDetailsByIDSigningOrder - distribution_method: DocumentGetDocumentWithDetailsByIDDistributionMethod +class DocumentGetDocumentMetaTypedDict(TypedDict): + signing_order: DocumentGetSigningOrder + distribution_method: DocumentGetDistributionMethod id: str subject: Nullable[str] message: Nullable[str] timezone: Nullable[str] - password: Nullable[str] date_format: Nullable[str] - document_id: float redirect_url: Nullable[str] typed_signature_enabled: bool upload_signature_enabled: bool draw_signature_enabled: bool allow_dictate_next_signer: bool language: str - email_settings: Nullable[DocumentGetDocumentWithDetailsByIDEmailSettingsTypedDict] + email_settings: Nullable[DocumentGetEmailSettingsTypedDict] + email_id: Nullable[str] + email_reply_to: Nullable[str] + password: NotRequired[Nullable[str]] + document_id: NotRequired[float] -class DocumentGetDocumentWithDetailsByIDDocumentMeta(BaseModel): +class DocumentGetDocumentMeta(BaseModel): signing_order: Annotated[ - DocumentGetDocumentWithDetailsByIDSigningOrder, - pydantic.Field(alias="signingOrder"), + DocumentGetSigningOrder, pydantic.Field(alias="signingOrder") ] distribution_method: Annotated[ - DocumentGetDocumentWithDetailsByIDDistributionMethod, - pydantic.Field(alias="distributionMethod"), + DocumentGetDistributionMethod, pydantic.Field(alias="distributionMethod") ] id: str @@ -320,12 +319,8 @@ class DocumentGetDocumentWithDetailsByIDDocumentMeta(BaseModel): timezone: Nullable[str] - password: Nullable[str] - date_format: Annotated[Nullable[str], pydantic.Field(alias="dateFormat")] - document_id: Annotated[float, pydantic.Field(alias="documentId")] - redirect_url: Annotated[Nullable[str], pydantic.Field(alias="redirectUrl")] typed_signature_enabled: Annotated[ @@ -347,23 +342,32 @@ class DocumentGetDocumentWithDetailsByIDDocumentMeta(BaseModel): language: str email_settings: Annotated[ - Nullable[DocumentGetDocumentWithDetailsByIDEmailSettings], - pydantic.Field(alias="emailSettings"), + Nullable[DocumentGetEmailSettings], pydantic.Field(alias="emailSettings") ] + email_id: Annotated[Nullable[str], pydantic.Field(alias="emailId")] + + email_reply_to: Annotated[Nullable[str], pydantic.Field(alias="emailReplyTo")] + + password: OptionalNullable[str] = None + + document_id: Annotated[Optional[float], pydantic.Field(alias="documentId")] = -1 + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["password", "documentId"] nullable_fields = [ "subject", "message", "timezone", - "password", "dateFormat", "redirectUrl", "emailSettings", + "emailId", + "emailReplyTo", + "password", ] - null_default_fields = [] + null_default_fields = ["password"] serialized = handler(self) @@ -390,22 +394,22 @@ def serialize_model(self, handler): return m -class DocumentGetDocumentWithDetailsByIDFolderType(str, Enum): +class DocumentGetFolderType(str, Enum): DOCUMENT = "DOCUMENT" TEMPLATE = "TEMPLATE" -class DocumentGetDocumentWithDetailsByIDFolderVisibility(str, Enum): +class DocumentGetFolderVisibility(str, Enum): EVERYONE = "EVERYONE" MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" ADMIN = "ADMIN" -class DocumentGetDocumentWithDetailsByIDFolderTypedDict(TypedDict): +class DocumentGetFolderTypedDict(TypedDict): id: str name: str - type: DocumentGetDocumentWithDetailsByIDFolderType - visibility: DocumentGetDocumentWithDetailsByIDFolderVisibility + type: DocumentGetFolderType + visibility: DocumentGetFolderVisibility user_id: float team_id: float pinned: bool @@ -414,14 +418,14 @@ class DocumentGetDocumentWithDetailsByIDFolderTypedDict(TypedDict): updated_at: str -class DocumentGetDocumentWithDetailsByIDFolder(BaseModel): +class DocumentGetFolder(BaseModel): id: str name: str - type: DocumentGetDocumentWithDetailsByIDFolderType + type: DocumentGetFolderType - visibility: DocumentGetDocumentWithDetailsByIDFolderVisibility + visibility: DocumentGetFolderVisibility user_id: Annotated[float, pydantic.Field(alias="userId")] @@ -466,7 +470,7 @@ def serialize_model(self, handler): return m -class DocumentGetDocumentWithDetailsByIDRole(str, Enum): +class DocumentGetRole(str, Enum): CC = "CC" SIGNER = "SIGNER" VIEWER = "VIEWER" @@ -474,29 +478,30 @@ class DocumentGetDocumentWithDetailsByIDRole(str, Enum): ASSISTANT = "ASSISTANT" -class DocumentGetDocumentWithDetailsByIDReadStatus(str, Enum): +class DocumentGetReadStatus(str, Enum): NOT_OPENED = "NOT_OPENED" OPENED = "OPENED" -class DocumentGetDocumentWithDetailsByIDSigningStatus(str, Enum): +class DocumentGetSigningStatus(str, Enum): NOT_SIGNED = "NOT_SIGNED" SIGNED = "SIGNED" REJECTED = "REJECTED" -class DocumentGetDocumentWithDetailsByIDSendStatus(str, Enum): +class DocumentGetSendStatus(str, Enum): NOT_SENT = "NOT_SENT" SENT = "SENT" -class DocumentGetDocumentWithDetailsByIDAccessAuth(str, Enum): +class DocumentGetAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" -class DocumentGetDocumentWithDetailsByIDActionAuth(str, Enum): +class DocumentGetActionAuth(str, Enum): r"""The type of authentication required for the recipient to sign the document.""" ACCOUNT = "ACCOUNT" @@ -506,67 +511,57 @@ class DocumentGetDocumentWithDetailsByIDActionAuth(str, Enum): EXPLICIT_NONE = "EXPLICIT_NONE" -class DocumentGetDocumentWithDetailsByIDRecipientAuthOptionsTypedDict(TypedDict): - access_auth: List[DocumentGetDocumentWithDetailsByIDAccessAuth] - action_auth: List[DocumentGetDocumentWithDetailsByIDActionAuth] +class DocumentGetRecipientAuthOptionsTypedDict(TypedDict): + access_auth: List[DocumentGetAccessAuth] + action_auth: List[DocumentGetActionAuth] -class DocumentGetDocumentWithDetailsByIDRecipientAuthOptions(BaseModel): +class DocumentGetRecipientAuthOptions(BaseModel): access_auth: Annotated[ - List[DocumentGetDocumentWithDetailsByIDAccessAuth], - pydantic.Field(alias="accessAuth"), + List[DocumentGetAccessAuth], pydantic.Field(alias="accessAuth") ] action_auth: Annotated[ - List[DocumentGetDocumentWithDetailsByIDActionAuth], - pydantic.Field(alias="actionAuth"), + List[DocumentGetActionAuth], pydantic.Field(alias="actionAuth") ] -class DocumentGetDocumentWithDetailsByIDRecipientTypedDict(TypedDict): - role: DocumentGetDocumentWithDetailsByIDRole - read_status: DocumentGetDocumentWithDetailsByIDReadStatus - signing_status: DocumentGetDocumentWithDetailsByIDSigningStatus - send_status: DocumentGetDocumentWithDetailsByIDSendStatus +class DocumentGetRecipientTypedDict(TypedDict): + envelope_id: str + role: DocumentGetRole + read_status: DocumentGetReadStatus + signing_status: DocumentGetSigningStatus + send_status: DocumentGetSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str document_deleted_at: Nullable[str] expired: Nullable[str] signed_at: Nullable[str] - auth_options: Nullable[ - DocumentGetDocumentWithDetailsByIDRecipientAuthOptionsTypedDict - ] + auth_options: Nullable[DocumentGetRecipientAuthOptionsTypedDict] signing_order: Nullable[float] r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] -class DocumentGetDocumentWithDetailsByIDRecipient(BaseModel): - role: DocumentGetDocumentWithDetailsByIDRole +class DocumentGetRecipient(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] - read_status: Annotated[ - DocumentGetDocumentWithDetailsByIDReadStatus, pydantic.Field(alias="readStatus") - ] + role: DocumentGetRole + + read_status: Annotated[DocumentGetReadStatus, pydantic.Field(alias="readStatus")] signing_status: Annotated[ - DocumentGetDocumentWithDetailsByIDSigningStatus, - pydantic.Field(alias="signingStatus"), + DocumentGetSigningStatus, pydantic.Field(alias="signingStatus") ] - send_status: Annotated[ - DocumentGetDocumentWithDetailsByIDSendStatus, pydantic.Field(alias="sendStatus") - ] + send_status: Annotated[DocumentGetSendStatus, pydantic.Field(alias="sendStatus")] id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -582,8 +577,7 @@ class DocumentGetDocumentWithDetailsByIDRecipient(BaseModel): signed_at: Annotated[Nullable[str], pydantic.Field(alias="signedAt")] auth_options: Annotated[ - Nullable[DocumentGetDocumentWithDetailsByIDRecipientAuthOptions], - pydantic.Field(alias="authOptions"), + Nullable[DocumentGetRecipientAuthOptions], pydantic.Field(alias="authOptions") ] signing_order: Annotated[Nullable[float], pydantic.Field(alias="signingOrder")] @@ -591,18 +585,26 @@ class DocumentGetDocumentWithDetailsByIDRecipient(BaseModel): rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -631,7 +633,7 @@ def serialize_model(self, handler): return m -class DocumentGetDocumentWithDetailsByIDFieldType(str, Enum): +class DocumentGetFieldType(str, Enum): SIGNATURE = "SIGNATURE" FREE_SIGNATURE = "FREE_SIGNATURE" INITIALS = "INITIALS" @@ -645,30 +647,30 @@ class DocumentGetDocumentWithDetailsByIDFieldType(str, Enum): DROPDOWN = "DROPDOWN" -class DocumentGetDocumentWithDetailsByIDTypeDropdown(str, Enum): +class DocumentGetTypeDropdown(str, Enum): DROPDOWN = "dropdown" -class DocumentGetDocumentWithDetailsByIDValue3TypedDict(TypedDict): +class DocumentGetValue3TypedDict(TypedDict): value: str -class DocumentGetDocumentWithDetailsByIDValue3(BaseModel): +class DocumentGetValue3(BaseModel): value: str -class DocumentGetDocumentWithDetailsByIDFieldMetaDropdownTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeDropdown +class DocumentGetFieldMetaDropdownTypedDict(TypedDict): + type: DocumentGetTypeDropdown label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - values: NotRequired[List[DocumentGetDocumentWithDetailsByIDValue3TypedDict]] + values: NotRequired[List[DocumentGetValue3TypedDict]] default_value: NotRequired[str] -class DocumentGetDocumentWithDetailsByIDFieldMetaDropdown(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeDropdown +class DocumentGetFieldMetaDropdown(BaseModel): + type: DocumentGetTypeDropdown label: Optional[str] = None @@ -678,22 +680,22 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - values: Optional[List[DocumentGetDocumentWithDetailsByIDValue3]] = None + values: Optional[List[DocumentGetValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None -class DocumentGetDocumentWithDetailsByIDTypeCheckbox(str, Enum): +class DocumentGetTypeCheckbox(str, Enum): CHECKBOX = "checkbox" -class DocumentGetDocumentWithDetailsByIDValue2TypedDict(TypedDict): +class DocumentGetValue2TypedDict(TypedDict): id: float checked: bool value: str -class DocumentGetDocumentWithDetailsByIDValue2(BaseModel): +class DocumentGetValue2(BaseModel): id: float checked: bool @@ -701,19 +703,25 @@ class DocumentGetDocumentWithDetailsByIDValue2(BaseModel): value: str -class DocumentGetDocumentWithDetailsByIDFieldMetaCheckboxTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeCheckbox +class DocumentGetDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class DocumentGetFieldMetaCheckboxTypedDict(TypedDict): + type: DocumentGetTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - values: NotRequired[List[DocumentGetDocumentWithDetailsByIDValue2TypedDict]] + values: NotRequired[List[DocumentGetValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[DocumentGetDirection] -class DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeCheckbox +class DocumentGetFieldMetaCheckbox(BaseModel): + type: DocumentGetTypeCheckbox label: Optional[str] = None @@ -723,7 +731,7 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - values: Optional[List[DocumentGetDocumentWithDetailsByIDValue2]] = None + values: Optional[List[DocumentGetValue2]] = None validation_rule: Annotated[ Optional[str], pydantic.Field(alias="validationRule") @@ -733,18 +741,20 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[DocumentGetDirection] = DocumentGetDirection.VERTICAL + -class DocumentGetDocumentWithDetailsByIDTypeRadio(str, Enum): +class DocumentGetTypeRadio(str, Enum): RADIO = "radio" -class DocumentGetDocumentWithDetailsByIDValue1TypedDict(TypedDict): +class DocumentGetValue1TypedDict(TypedDict): id: float checked: bool value: str -class DocumentGetDocumentWithDetailsByIDValue1(BaseModel): +class DocumentGetValue1(BaseModel): id: float checked: bool @@ -752,17 +762,17 @@ class DocumentGetDocumentWithDetailsByIDValue1(BaseModel): value: str -class DocumentGetDocumentWithDetailsByIDFieldMetaRadioTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeRadio +class DocumentGetFieldMetaRadioTypedDict(TypedDict): + type: DocumentGetTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - values: NotRequired[List[DocumentGetDocumentWithDetailsByIDValue1TypedDict]] + values: NotRequired[List[DocumentGetValue1TypedDict]] -class DocumentGetDocumentWithDetailsByIDFieldMetaRadio(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeRadio +class DocumentGetFieldMetaRadio(BaseModel): + type: DocumentGetTypeRadio label: Optional[str] = None @@ -772,35 +782,35 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - values: Optional[List[DocumentGetDocumentWithDetailsByIDValue1]] = None + values: Optional[List[DocumentGetValue1]] = None -class DocumentGetDocumentWithDetailsByIDTypeNumber(str, Enum): +class DocumentGetTypeNumber(str, Enum): NUMBER = "number" -class DocumentGetDocumentWithDetailsByIDTextAlign6(str, Enum): +class DocumentGetTextAlign6(str, Enum): LEFT = "left" CENTER = "center" RIGHT = "right" -class DocumentGetDocumentWithDetailsByIDFieldMetaNumberTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeNumber +class DocumentGetFieldMetaNumberTypedDict(TypedDict): + type: DocumentGetTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign6] + text_align: NotRequired[DocumentGetTextAlign6] -class DocumentGetDocumentWithDetailsByIDFieldMetaNumber(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeNumber +class DocumentGetFieldMetaNumber(BaseModel): + type: DocumentGetTypeNumber label: Optional[str] = None @@ -810,34 +820,80 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None text_align: Annotated[ - Optional[DocumentGetDocumentWithDetailsByIDTextAlign6], - pydantic.Field(alias="textAlign"), + Optional[DocumentGetTextAlign6], pydantic.Field(alias="textAlign") ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + -class DocumentGetDocumentWithDetailsByIDTypeText(str, Enum): +class DocumentGetTypeText(str, Enum): TEXT = "text" -class DocumentGetDocumentWithDetailsByIDTextAlign5(str, Enum): +class DocumentGetTextAlign5(str, Enum): LEFT = "left" CENTER = "center" RIGHT = "right" -class DocumentGetDocumentWithDetailsByIDFieldMetaTextTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeText +class DocumentGetFieldMetaTextTypedDict(TypedDict): + type: DocumentGetTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] @@ -845,11 +901,11 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaTextTypedDict(TypedDict): text: NotRequired[str] character_limit: NotRequired[float] font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign5] + text_align: NotRequired[DocumentGetTextAlign5] -class DocumentGetDocumentWithDetailsByIDFieldMetaText(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeText +class DocumentGetFieldMetaText(BaseModel): + type: DocumentGetTypeText label: Optional[str] = None @@ -868,33 +924,32 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaText(BaseModel): font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None text_align: Annotated[ - Optional[DocumentGetDocumentWithDetailsByIDTextAlign5], - pydantic.Field(alias="textAlign"), + Optional[DocumentGetTextAlign5], pydantic.Field(alias="textAlign") ] = None -class DocumentGetDocumentWithDetailsByIDTypeDate(str, Enum): +class DocumentGetTypeDate(str, Enum): DATE = "date" -class DocumentGetDocumentWithDetailsByIDTextAlign4(str, Enum): +class DocumentGetTextAlign4(str, Enum): LEFT = "left" CENTER = "center" RIGHT = "right" -class DocumentGetDocumentWithDetailsByIDFieldMetaDateTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeDate +class DocumentGetFieldMetaDateTypedDict(TypedDict): + type: DocumentGetTypeDate label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign4] + text_align: NotRequired[DocumentGetTextAlign4] -class DocumentGetDocumentWithDetailsByIDFieldMetaDate(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeDate +class DocumentGetFieldMetaDate(BaseModel): + type: DocumentGetTypeDate label: Optional[str] = None @@ -907,33 +962,32 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaDate(BaseModel): font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None text_align: Annotated[ - Optional[DocumentGetDocumentWithDetailsByIDTextAlign4], - pydantic.Field(alias="textAlign"), + Optional[DocumentGetTextAlign4], pydantic.Field(alias="textAlign") ] = None -class DocumentGetDocumentWithDetailsByIDTypeEmail(str, Enum): +class DocumentGetTypeEmail(str, Enum): EMAIL = "email" -class DocumentGetDocumentWithDetailsByIDTextAlign3(str, Enum): +class DocumentGetTextAlign3(str, Enum): LEFT = "left" CENTER = "center" RIGHT = "right" -class DocumentGetDocumentWithDetailsByIDFieldMetaEmailTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeEmail +class DocumentGetFieldMetaEmailTypedDict(TypedDict): + type: DocumentGetTypeEmail label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign3] + text_align: NotRequired[DocumentGetTextAlign3] -class DocumentGetDocumentWithDetailsByIDFieldMetaEmail(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeEmail +class DocumentGetFieldMetaEmail(BaseModel): + type: DocumentGetTypeEmail label: Optional[str] = None @@ -946,33 +1000,32 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaEmail(BaseModel): font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None text_align: Annotated[ - Optional[DocumentGetDocumentWithDetailsByIDTextAlign3], - pydantic.Field(alias="textAlign"), + Optional[DocumentGetTextAlign3], pydantic.Field(alias="textAlign") ] = None -class DocumentGetDocumentWithDetailsByIDTypeName(str, Enum): +class DocumentGetTypeName(str, Enum): NAME = "name" -class DocumentGetDocumentWithDetailsByIDTextAlign2(str, Enum): +class DocumentGetTextAlign2(str, Enum): LEFT = "left" CENTER = "center" RIGHT = "right" -class DocumentGetDocumentWithDetailsByIDFieldMetaNameTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeName +class DocumentGetFieldMetaNameTypedDict(TypedDict): + type: DocumentGetTypeName label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign2] + text_align: NotRequired[DocumentGetTextAlign2] -class DocumentGetDocumentWithDetailsByIDFieldMetaName(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeName +class DocumentGetFieldMetaName(BaseModel): + type: DocumentGetTypeName label: Optional[str] = None @@ -985,33 +1038,32 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaName(BaseModel): font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None text_align: Annotated[ - Optional[DocumentGetDocumentWithDetailsByIDTextAlign2], - pydantic.Field(alias="textAlign"), + Optional[DocumentGetTextAlign2], pydantic.Field(alias="textAlign") ] = None -class DocumentGetDocumentWithDetailsByIDTypeInitials(str, Enum): +class DocumentGetTypeInitials(str, Enum): INITIALS = "initials" -class DocumentGetDocumentWithDetailsByIDTextAlign1(str, Enum): +class DocumentGetTextAlign1(str, Enum): LEFT = "left" CENTER = "center" RIGHT = "right" -class DocumentGetDocumentWithDetailsByIDFieldMetaInitialsTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeInitials +class DocumentGetFieldMetaInitialsTypedDict(TypedDict): + type: DocumentGetTypeInitials label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign1] + text_align: NotRequired[DocumentGetTextAlign1] -class DocumentGetDocumentWithDetailsByIDFieldMetaInitials(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeInitials +class DocumentGetFieldMetaInitials(BaseModel): + type: DocumentGetTypeInitials label: Optional[str] = None @@ -1024,71 +1076,72 @@ class DocumentGetDocumentWithDetailsByIDFieldMetaInitials(BaseModel): font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None text_align: Annotated[ - Optional[DocumentGetDocumentWithDetailsByIDTextAlign1], - pydantic.Field(alias="textAlign"), + Optional[DocumentGetTextAlign1], pydantic.Field(alias="textAlign") ] = None -DocumentGetDocumentWithDetailsByIDFieldMetaUnionTypedDict = TypeAliasType( - "DocumentGetDocumentWithDetailsByIDFieldMetaUnionTypedDict", +DocumentGetFieldMetaUnionTypedDict = TypeAliasType( + "DocumentGetFieldMetaUnionTypedDict", Union[ - DocumentGetDocumentWithDetailsByIDFieldMetaRadioTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaInitialsTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaNameTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaEmailTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaDateTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaDropdownTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaCheckboxTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaTextTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaNumberTypedDict, + DocumentGetFieldMetaRadioTypedDict, + DocumentGetFieldMetaInitialsTypedDict, + DocumentGetFieldMetaNameTypedDict, + DocumentGetFieldMetaEmailTypedDict, + DocumentGetFieldMetaDateTypedDict, + DocumentGetFieldMetaDropdownTypedDict, + DocumentGetFieldMetaTextTypedDict, + DocumentGetFieldMetaCheckboxTypedDict, + DocumentGetFieldMetaNumberTypedDict, ], ) -DocumentGetDocumentWithDetailsByIDFieldMetaUnion = TypeAliasType( - "DocumentGetDocumentWithDetailsByIDFieldMetaUnion", +DocumentGetFieldMetaUnion = TypeAliasType( + "DocumentGetFieldMetaUnion", Union[ - DocumentGetDocumentWithDetailsByIDFieldMetaRadio, - DocumentGetDocumentWithDetailsByIDFieldMetaInitials, - DocumentGetDocumentWithDetailsByIDFieldMetaName, - DocumentGetDocumentWithDetailsByIDFieldMetaEmail, - DocumentGetDocumentWithDetailsByIDFieldMetaDate, - DocumentGetDocumentWithDetailsByIDFieldMetaDropdown, - DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox, - DocumentGetDocumentWithDetailsByIDFieldMetaText, - DocumentGetDocumentWithDetailsByIDFieldMetaNumber, + DocumentGetFieldMetaRadio, + DocumentGetFieldMetaInitials, + DocumentGetFieldMetaName, + DocumentGetFieldMetaEmail, + DocumentGetFieldMetaDate, + DocumentGetFieldMetaDropdown, + DocumentGetFieldMetaText, + DocumentGetFieldMetaCheckbox, + DocumentGetFieldMetaNumber, ], ) -class DocumentGetDocumentWithDetailsByIDFieldTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDFieldType +class DocumentGetFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str + type: DocumentGetFieldType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" custom_text: str inserted: bool - field_meta: Nullable[DocumentGetDocumentWithDetailsByIDFieldMetaUnionTypedDict] + field_meta: Nullable[DocumentGetFieldMetaUnionTypedDict] position_x: NotRequired[Any] position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] -class DocumentGetDocumentWithDetailsByIDField(BaseModel): - type: DocumentGetDocumentWithDetailsByIDFieldType +class DocumentGetField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] - id: float + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] - secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] + type: DocumentGetFieldType - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] + id: float - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] + secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] @@ -1100,8 +1153,7 @@ class DocumentGetDocumentWithDetailsByIDField(BaseModel): inserted: bool field_meta: Annotated[ - Nullable[DocumentGetDocumentWithDetailsByIDFieldMetaUnion], - pydantic.Field(alias="fieldMeta"), + Nullable[DocumentGetFieldMetaUnion], pydantic.Field(alias="fieldMeta") ] position_x: Annotated[Optional[Any], pydantic.Field(alias="positionX")] = None @@ -1112,10 +1164,25 @@ class DocumentGetDocumentWithDetailsByIDField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -1143,45 +1210,45 @@ def serialize_model(self, handler): return m -class DocumentGetDocumentWithDetailsByIDResponseTypedDict(TypedDict): +class DocumentGetResponseTypedDict(TypedDict): r"""Successful response""" - visibility: DocumentGetDocumentWithDetailsByIDVisibility - status: DocumentGetDocumentWithDetailsByIDStatus - source: DocumentGetDocumentWithDetailsByIDSource + visibility: DocumentGetVisibility + status: DocumentGetStatus + source: DocumentGetSource id: float external_id: Nullable[str] r"""A custom external ID you can use to identify the document.""" user_id: float r"""The ID of the user that created this document.""" - auth_options: Nullable[DocumentGetDocumentWithDetailsByIDAuthOptionsTypedDict] - form_values: Nullable[ - Dict[str, DocumentGetDocumentWithDetailsByIDFormValuesTypedDict] - ] + auth_options: Nullable[DocumentGetAuthOptionsTypedDict] + form_values: Nullable[Dict[str, DocumentGetFormValuesTypedDict]] title: str - document_data_id: str created_at: str updated_at: str completed_at: Nullable[str] deleted_at: Nullable[str] team_id: float - template_id: Nullable[float] folder_id: Nullable[str] - document_data: DocumentGetDocumentWithDetailsByIDDocumentDataTypedDict - document_meta: Nullable[DocumentGetDocumentWithDetailsByIDDocumentMetaTypedDict] - folder: Nullable[DocumentGetDocumentWithDetailsByIDFolderTypedDict] - recipients: List[DocumentGetDocumentWithDetailsByIDRecipientTypedDict] - fields: List[DocumentGetDocumentWithDetailsByIDFieldTypedDict] - - -class DocumentGetDocumentWithDetailsByIDResponse(BaseModel): + envelope_id: str + document_data: DocumentGetDocumentDataTypedDict + document_meta: DocumentGetDocumentMetaTypedDict + folder: Nullable[DocumentGetFolderTypedDict] + recipients: List[DocumentGetRecipientTypedDict] + fields: List[DocumentGetFieldTypedDict] + template_id: NotRequired[Nullable[float]] + r"""The ID of the template that the document was created from, if any.""" + document_data_id: NotRequired[str] + + +class DocumentGetResponse(BaseModel): r"""Successful response""" - visibility: DocumentGetDocumentWithDetailsByIDVisibility + visibility: DocumentGetVisibility - status: DocumentGetDocumentWithDetailsByIDStatus + status: DocumentGetStatus - source: DocumentGetDocumentWithDetailsByIDSource + source: DocumentGetSource id: float @@ -1192,19 +1259,15 @@ class DocumentGetDocumentWithDetailsByIDResponse(BaseModel): r"""The ID of the user that created this document.""" auth_options: Annotated[ - Nullable[DocumentGetDocumentWithDetailsByIDAuthOptions], - pydantic.Field(alias="authOptions"), + Nullable[DocumentGetAuthOptions], pydantic.Field(alias="authOptions") ] form_values: Annotated[ - Nullable[Dict[str, DocumentGetDocumentWithDetailsByIDFormValues]], - pydantic.Field(alias="formValues"), + Nullable[Dict[str, DocumentGetFormValues]], pydantic.Field(alias="formValues") ] title: str - document_data_id: Annotated[str, pydantic.Field(alias="documentDataId")] - created_at: Annotated[str, pydantic.Field(alias="createdAt")] updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] @@ -1215,38 +1278,44 @@ class DocumentGetDocumentWithDetailsByIDResponse(BaseModel): team_id: Annotated[float, pydantic.Field(alias="teamId")] - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + document_data: Annotated[ - DocumentGetDocumentWithDetailsByIDDocumentData, - pydantic.Field(alias="documentData"), + DocumentGetDocumentData, pydantic.Field(alias="documentData") ] document_meta: Annotated[ - Nullable[DocumentGetDocumentWithDetailsByIDDocumentMeta], - pydantic.Field(alias="documentMeta"), + DocumentGetDocumentMeta, pydantic.Field(alias="documentMeta") ] - folder: Nullable[DocumentGetDocumentWithDetailsByIDFolder] + folder: Nullable[DocumentGetFolder] - recipients: List[DocumentGetDocumentWithDetailsByIDRecipient] + recipients: List[DocumentGetRecipient] - fields: List[DocumentGetDocumentWithDetailsByIDField] + fields: List[DocumentGetField] + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + r"""The ID of the template that the document was created from, if any.""" + + document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="documentDataId") + ] = "" @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["templateId", "documentDataId"] nullable_fields = [ "externalId", "authOptions", "formValues", "completedAt", "deletedAt", - "templateId", "folderId", - "documentMeta", + "templateId", "folder", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/document_resenddocumentop.py b/src/documenso_sdk/models/document_redistributeop.py similarity index 52% rename from src/documenso_sdk/models/document_resenddocumentop.py rename to src/documenso_sdk/models/document_redistributeop.py index a8791ce..b4b9d20 100644 --- a/src/documenso_sdk/models/document_resenddocumentop.py +++ b/src/documenso_sdk/models/document_redistributeop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -9,92 +10,94 @@ from typing_extensions import Annotated, TypedDict -class DocumentResendDocumentRequestTypedDict(TypedDict): +class DocumentRedistributeRequestTypedDict(TypedDict): document_id: float recipients: List[float] r"""The IDs of the recipients to redistribute the document to.""" -class DocumentResendDocumentRequest(BaseModel): +class DocumentRedistributeRequest(BaseModel): document_id: Annotated[float, pydantic.Field(alias="documentId")] recipients: List[float] r"""The IDs of the recipients to redistribute the document to.""" -class DocumentResendDocumentInternalServerErrorIssueTypedDict(TypedDict): +class DocumentRedistributeInternalServerErrorIssueTypedDict(TypedDict): message: str -class DocumentResendDocumentInternalServerErrorIssue(BaseModel): +class DocumentRedistributeInternalServerErrorIssue(BaseModel): message: str -class DocumentResendDocumentInternalServerErrorData(BaseModel): +class DocumentRedistributeInternalServerErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentResendDocumentInternalServerErrorIssue]] = None + issues: Optional[List[DocumentRedistributeInternalServerErrorIssue]] = None -class DocumentResendDocumentInternalServerError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentRedistributeInternalServerError(DocumensoError): r"""Internal server error""" - data: DocumentResendDocumentInternalServerErrorData + data: DocumentRedistributeInternalServerErrorData = field(hash=False) def __init__( self, - data: DocumentResendDocumentInternalServerErrorData, + data: DocumentRedistributeInternalServerErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentResendDocumentBadRequestIssueTypedDict(TypedDict): +class DocumentRedistributeBadRequestIssueTypedDict(TypedDict): message: str -class DocumentResendDocumentBadRequestIssue(BaseModel): +class DocumentRedistributeBadRequestIssue(BaseModel): message: str -class DocumentResendDocumentBadRequestErrorData(BaseModel): +class DocumentRedistributeBadRequestErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentResendDocumentBadRequestIssue]] = None + issues: Optional[List[DocumentRedistributeBadRequestIssue]] = None -class DocumentResendDocumentBadRequestError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentRedistributeBadRequestError(DocumensoError): r"""Invalid input data""" - data: DocumentResendDocumentBadRequestErrorData + data: DocumentRedistributeBadRequestErrorData = field(hash=False) def __init__( self, - data: DocumentResendDocumentBadRequestErrorData, + data: DocumentRedistributeBadRequestErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentResendDocumentResponseTypedDict(TypedDict): +class DocumentRedistributeResponseTypedDict(TypedDict): r"""Successful response""" success: bool -class DocumentResendDocumentResponse(BaseModel): +class DocumentRedistributeResponse(BaseModel): r"""Successful response""" success: bool diff --git a/src/documenso_sdk/models/document_updatedocumentop.py b/src/documenso_sdk/models/document_updateop.py similarity index 62% rename from src/documenso_sdk/models/document_updatedocumentop.py rename to src/documenso_sdk/models/document_updateop.py index 4b67989..54a505b 100644 --- a/src/documenso_sdk/models/document_updatedocumentop.py +++ b/src/documenso_sdk/models/document_updateop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import ( BaseModel, @@ -17,7 +18,7 @@ from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict -class DocumentUpdateDocumentVisibilityRequest(str, Enum): +class DocumentUpdateVisibilityRequest(str, Enum): r"""The visibility of the document.""" EVERYONE = "EVERYONE" @@ -25,13 +26,14 @@ class DocumentUpdateDocumentVisibilityRequest(str, Enum): ADMIN = "ADMIN" -class DocumentUpdateDocumentGlobalAccessAuthRequest(str, Enum): +class DocumentUpdateGlobalAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" -class DocumentUpdateDocumentGlobalActionAuthRequest(str, Enum): +class DocumentUpdateGlobalActionAuthRequest(str, Enum): r"""The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only.""" ACCOUNT = "ACCOUNT" @@ -40,19 +42,20 @@ class DocumentUpdateDocumentGlobalActionAuthRequest(str, Enum): PASSWORD = "PASSWORD" -class DocumentUpdateDocumentDataTypedDict(TypedDict): +class DocumentUpdateDataTypedDict(TypedDict): title: NotRequired[str] r"""The title of the document.""" external_id: NotRequired[Nullable[str]] r"""The external ID of the document.""" - visibility: NotRequired[DocumentUpdateDocumentVisibilityRequest] + visibility: NotRequired[DocumentUpdateVisibilityRequest] r"""The visibility of the document.""" - global_access_auth: NotRequired[List[DocumentUpdateDocumentGlobalAccessAuthRequest]] - global_action_auth: NotRequired[List[DocumentUpdateDocumentGlobalActionAuthRequest]] + global_access_auth: NotRequired[List[DocumentUpdateGlobalAccessAuthRequest]] + global_action_auth: NotRequired[List[DocumentUpdateGlobalActionAuthRequest]] use_legacy_field_insertion: NotRequired[bool] + folder_id: NotRequired[Nullable[str]] -class DocumentUpdateDocumentData(BaseModel): +class DocumentUpdateData(BaseModel): title: Optional[str] = None r"""The title of the document.""" @@ -61,16 +64,16 @@ class DocumentUpdateDocumentData(BaseModel): ] = UNSET r"""The external ID of the document.""" - visibility: Optional[DocumentUpdateDocumentVisibilityRequest] = None + visibility: Optional[DocumentUpdateVisibilityRequest] = None r"""The visibility of the document.""" global_access_auth: Annotated[ - Optional[List[DocumentUpdateDocumentGlobalAccessAuthRequest]], + Optional[List[DocumentUpdateGlobalAccessAuthRequest]], pydantic.Field(alias="globalAccessAuth"), ] = None global_action_auth: Annotated[ - Optional[List[DocumentUpdateDocumentGlobalActionAuthRequest]], + Optional[List[DocumentUpdateGlobalActionAuthRequest]], pydantic.Field(alias="globalActionAuth"), ] = None @@ -78,6 +81,10 @@ class DocumentUpdateDocumentData(BaseModel): Optional[bool], pydantic.Field(alias="useLegacyFieldInsertion") ] = None + folder_id: Annotated[OptionalNullable[str], pydantic.Field(alias="folderId")] = ( + UNSET + ) + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ @@ -87,8 +94,9 @@ def serialize_model(self, handler): "globalAccessAuth", "globalActionAuth", "useLegacyFieldInsertion", + "folderId", ] - nullable_fields = ["externalId"] + nullable_fields = ["externalId", "folderId"] null_default_fields = [] serialized = handler(self) @@ -116,34 +124,46 @@ def serialize_model(self, handler): return m -class DocumentUpdateDocumentDateFormat(str, Enum): +class DocumentUpdateDateFormat(str, Enum): r"""The date format to use for date fields and signing the document.""" - YYYY_MM_DD_HH_MM_A = "yyyy-MM-dd hh:mm a" - YYYY_MM_DD = "yyyy-MM-dd" - DD_MM_YYYY_HH_MM_A = "dd/MM/yyyy hh:mm a" - MM_DD_YYYY_HH_MM_A = "MM/dd/yyyy hh:mm a" - YYYY_MM_DD_HH_MM = "yyyy-MM-dd HH:mm" - YY_MM_DD_HH_MM_A = "yy-MM-dd hh:mm a" - YYYY_MM_DD_HH_MM_SS = "yyyy-MM-dd HH:mm:ss" - MMMM_DD_YYYY_HH_MM_A = "MMMM dd, yyyy hh:mm a" - EEEE_MMMM_DD_YYYY_HH_MM_A = "EEEE, MMMM dd, yyyy hh:mm a" - YYYY_MM_DD_T_HH_MM_SS_SSSXXX = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" - - -class DocumentUpdateDocumentDistributionMethod(str, Enum): + YYYY_M_MDD_HH_MM_A = "yyyy-MM-dd hh:mm a" + YYYY_M_MDD = "yyyy-MM-dd" + DD_MM_SLASH_YYYY = "dd/MM/yyyy" + MM_DD_SLASH_YYYY = "MM/dd/yyyy" + YY_M_MDD = "yy-MM-dd" + MMMM_DD_COMMA_YYYY = "MMMM dd, yyyy" + EEEE_MMMM_DD_COMMA_YYYY = "EEEE, MMMM dd, yyyy" + DD_MM_SLASH_YYYY_HH_MM_A = "dd/MM/yyyy hh:mm a" + DD_MM_SLASH_YYYY_H_HMM = "dd/MM/yyyy HH:mm" + MM_DD_SLASH_YYYY_HH_MM_A = "MM/dd/yyyy hh:mm a" + MM_DD_SLASH_YYYY_H_HMM = "MM/dd/yyyy HH:mm" + DD_DOT_MM_DOT_YYYY = "dd.MM.yyyy" + DD_DOT_MM_DOT_YYYY_H_HMM = "dd.MM.yyyy HH:mm" + YYYY_M_MDD_H_HMM = "yyyy-MM-dd HH:mm" + YY_M_MDD_HH_MM_A = "yy-MM-dd hh:mm a" + YY_M_MDD_H_HMM = "yy-MM-dd HH:mm" + YYYY_M_MDD_H_HMMSS = "yyyy-MM-dd HH:mm:ss" + MMMM_DD_COMMA_YYYY_HH_MM_A = "MMMM dd, yyyy hh:mm a" + MMMM_DD_COMMA_YYYY_H_HMM = "MMMM dd, yyyy HH:mm" + EEEE_MMMM_DD_COMMA_YYYY_HH_MM_A = "EEEE, MMMM dd, yyyy hh:mm a" + EEEE_MMMM_DD_COMMA_YYYY_H_HMM = "EEEE, MMMM dd, yyyy HH:mm" + ISO8601_FULL = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" + + +class DocumentUpdateDistributionMethod(str, Enum): r"""The distribution method to use when sending the document to the recipients.""" EMAIL = "EMAIL" NONE = "NONE" -class DocumentUpdateDocumentSigningOrder(str, Enum): +class DocumentUpdateSigningOrder(str, Enum): PARALLEL = "PARALLEL" SEQUENTIAL = "SEQUENTIAL" -class DocumentUpdateDocumentLanguage(str, Enum): +class DocumentUpdateLanguage(str, Enum): r"""The language to use for email communications with recipients.""" DE = "de" @@ -154,7 +174,7 @@ class DocumentUpdateDocumentLanguage(str, Enum): PL = "pl" -class DocumentUpdateDocumentEmailSettingsTypedDict(TypedDict): +class DocumentUpdateEmailSettingsTypedDict(TypedDict): recipient_signing_request: NotRequired[bool] r"""Whether to send an email to all recipients that the document is ready for them to sign.""" recipient_removed: NotRequired[bool] @@ -171,7 +191,7 @@ class DocumentUpdateDocumentEmailSettingsTypedDict(TypedDict): r"""Whether to send an email to the document owner when the document is complete.""" -class DocumentUpdateDocumentEmailSettings(BaseModel): +class DocumentUpdateEmailSettings(BaseModel): recipient_signing_request: Annotated[ Optional[bool], pydantic.Field(alias="recipientSigningRequest") ] = True @@ -208,22 +228,22 @@ class DocumentUpdateDocumentEmailSettings(BaseModel): r"""Whether to send an email to the document owner when the document is complete.""" -class DocumentUpdateDocumentMetaTypedDict(TypedDict): +class DocumentUpdateMetaTypedDict(TypedDict): subject: NotRequired[str] r"""The subject of the email that will be sent to the recipients.""" message: NotRequired[str] r"""The message of the email that will be sent to the recipients.""" timezone: NotRequired[str] r"""The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne""" - date_format: NotRequired[DocumentUpdateDocumentDateFormat] + date_format: NotRequired[DocumentUpdateDateFormat] r"""The date format to use for date fields and signing the document.""" - distribution_method: NotRequired[DocumentUpdateDocumentDistributionMethod] + distribution_method: NotRequired[DocumentUpdateDistributionMethod] r"""The distribution method to use when sending the document to the recipients.""" - signing_order: NotRequired[DocumentUpdateDocumentSigningOrder] + signing_order: NotRequired[DocumentUpdateSigningOrder] allow_dictate_next_signer: NotRequired[bool] redirect_url: NotRequired[str] r"""The URL to which the recipient should be redirected after signing the document.""" - language: NotRequired[DocumentUpdateDocumentLanguage] + language: NotRequired[DocumentUpdateLanguage] r"""The language to use for email communications with recipients.""" typed_signature_enabled: NotRequired[bool] r"""Whether to allow recipients to sign using a typed signature.""" @@ -231,10 +251,12 @@ class DocumentUpdateDocumentMetaTypedDict(TypedDict): r"""Whether to allow recipients to sign using an uploaded signature.""" draw_signature_enabled: NotRequired[bool] r"""Whether to allow recipients to sign using a draw signature.""" - email_settings: NotRequired[DocumentUpdateDocumentEmailSettingsTypedDict] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[Nullable[DocumentUpdateEmailSettingsTypedDict]] -class DocumentUpdateDocumentMeta(BaseModel): +class DocumentUpdateMeta(BaseModel): subject: Optional[str] = None r"""The subject of the email that will be sent to the recipients.""" @@ -245,19 +267,18 @@ class DocumentUpdateDocumentMeta(BaseModel): r"""The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne""" date_format: Annotated[ - Optional[DocumentUpdateDocumentDateFormat], pydantic.Field(alias="dateFormat") + Optional[DocumentUpdateDateFormat], pydantic.Field(alias="dateFormat") ] = None r"""The date format to use for date fields and signing the document.""" distribution_method: Annotated[ - Optional[DocumentUpdateDocumentDistributionMethod], + Optional[DocumentUpdateDistributionMethod], pydantic.Field(alias="distributionMethod"), ] = None r"""The distribution method to use when sending the document to the recipients.""" signing_order: Annotated[ - Optional[DocumentUpdateDocumentSigningOrder], - pydantic.Field(alias="signingOrder"), + Optional[DocumentUpdateSigningOrder], pydantic.Field(alias="signingOrder") ] = None allow_dictate_next_signer: Annotated[ @@ -267,7 +288,7 @@ class DocumentUpdateDocumentMeta(BaseModel): redirect_url: Annotated[Optional[str], pydantic.Field(alias="redirectUrl")] = None r"""The URL to which the recipient should be redirected after signing the document.""" - language: Optional[DocumentUpdateDocumentLanguage] = None + language: Optional[DocumentUpdateLanguage] = None r"""The language to use for email communications with recipients.""" typed_signature_enabled: Annotated[ @@ -285,118 +306,173 @@ class DocumentUpdateDocumentMeta(BaseModel): ] = None r"""Whether to allow recipients to sign using a draw signature.""" + email_id: Annotated[OptionalNullable[str], pydantic.Field(alias="emailId")] = UNSET + + email_reply_to: Annotated[ + OptionalNullable[str], pydantic.Field(alias="emailReplyTo") + ] = UNSET + email_settings: Annotated[ - Optional[DocumentUpdateDocumentEmailSettings], + OptionalNullable[DocumentUpdateEmailSettings], pydantic.Field(alias="emailSettings"), - ] = None + ] = UNSET + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "subject", + "message", + "timezone", + "dateFormat", + "distributionMethod", + "signingOrder", + "allowDictateNextSigner", + "redirectUrl", + "language", + "typedSignatureEnabled", + "uploadSignatureEnabled", + "drawSignatureEnabled", + "emailId", + "emailReplyTo", + "emailSettings", + ] + nullable_fields = ["emailId", "emailReplyTo", "emailSettings"] + null_default_fields = [] + + serialized = handler(self) + + m = {} -class DocumentUpdateDocumentRequestTypedDict(TypedDict): + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class DocumentUpdateRequestTypedDict(TypedDict): document_id: float - data: NotRequired[DocumentUpdateDocumentDataTypedDict] - meta: NotRequired[DocumentUpdateDocumentMetaTypedDict] + data: NotRequired[DocumentUpdateDataTypedDict] + meta: NotRequired[DocumentUpdateMetaTypedDict] -class DocumentUpdateDocumentRequest(BaseModel): +class DocumentUpdateRequest(BaseModel): document_id: Annotated[float, pydantic.Field(alias="documentId")] - data: Optional[DocumentUpdateDocumentData] = None + data: Optional[DocumentUpdateData] = None - meta: Optional[DocumentUpdateDocumentMeta] = None + meta: Optional[DocumentUpdateMeta] = None -class DocumentUpdateDocumentInternalServerErrorIssueTypedDict(TypedDict): +class DocumentUpdateInternalServerErrorIssueTypedDict(TypedDict): message: str -class DocumentUpdateDocumentInternalServerErrorIssue(BaseModel): +class DocumentUpdateInternalServerErrorIssue(BaseModel): message: str -class DocumentUpdateDocumentInternalServerErrorData(BaseModel): +class DocumentUpdateInternalServerErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentUpdateDocumentInternalServerErrorIssue]] = None + issues: Optional[List[DocumentUpdateInternalServerErrorIssue]] = None -class DocumentUpdateDocumentInternalServerError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentUpdateInternalServerError(DocumensoError): r"""Internal server error""" - data: DocumentUpdateDocumentInternalServerErrorData + data: DocumentUpdateInternalServerErrorData = field(hash=False) def __init__( self, - data: DocumentUpdateDocumentInternalServerErrorData, + data: DocumentUpdateInternalServerErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentUpdateDocumentBadRequestIssueTypedDict(TypedDict): +class DocumentUpdateBadRequestIssueTypedDict(TypedDict): message: str -class DocumentUpdateDocumentBadRequestIssue(BaseModel): +class DocumentUpdateBadRequestIssue(BaseModel): message: str -class DocumentUpdateDocumentBadRequestErrorData(BaseModel): +class DocumentUpdateBadRequestErrorData(BaseModel): message: str code: str - issues: Optional[List[DocumentUpdateDocumentBadRequestIssue]] = None + issues: Optional[List[DocumentUpdateBadRequestIssue]] = None -class DocumentUpdateDocumentBadRequestError(DocumensoError): +@dataclass(unsafe_hash=True) +class DocumentUpdateBadRequestError(DocumensoError): r"""Invalid input data""" - data: DocumentUpdateDocumentBadRequestErrorData + data: DocumentUpdateBadRequestErrorData = field(hash=False) def __init__( self, - data: DocumentUpdateDocumentBadRequestErrorData, + data: DocumentUpdateBadRequestErrorData, raw_response: httpx.Response, body: Optional[str] = None, ): fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) -class DocumentUpdateDocumentVisibilityResponse(str, Enum): +class DocumentUpdateVisibilityResponse(str, Enum): EVERYONE = "EVERYONE" MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" ADMIN = "ADMIN" -class DocumentUpdateDocumentStatus(str, Enum): +class DocumentUpdateStatus(str, Enum): DRAFT = "DRAFT" PENDING = "PENDING" COMPLETED = "COMPLETED" REJECTED = "REJECTED" -class DocumentUpdateDocumentSource(str, Enum): +class DocumentUpdateSource(str, Enum): DOCUMENT = "DOCUMENT" TEMPLATE = "TEMPLATE" TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" -class DocumentUpdateDocumentGlobalAccessAuthResponse(str, Enum): +class DocumentUpdateGlobalAccessAuthResponse(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" -class DocumentUpdateDocumentGlobalActionAuthResponse(str, Enum): +class DocumentUpdateGlobalActionAuthResponse(str, Enum): r"""The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only.""" ACCOUNT = "ACCOUNT" @@ -405,66 +481,68 @@ class DocumentUpdateDocumentGlobalActionAuthResponse(str, Enum): PASSWORD = "PASSWORD" -class DocumentUpdateDocumentAuthOptionsTypedDict(TypedDict): - global_access_auth: List[DocumentUpdateDocumentGlobalAccessAuthResponse] - global_action_auth: List[DocumentUpdateDocumentGlobalActionAuthResponse] +class DocumentUpdateAuthOptionsTypedDict(TypedDict): + global_access_auth: List[DocumentUpdateGlobalAccessAuthResponse] + global_action_auth: List[DocumentUpdateGlobalActionAuthResponse] -class DocumentUpdateDocumentAuthOptions(BaseModel): +class DocumentUpdateAuthOptions(BaseModel): global_access_auth: Annotated[ - List[DocumentUpdateDocumentGlobalAccessAuthResponse], + List[DocumentUpdateGlobalAccessAuthResponse], pydantic.Field(alias="globalAccessAuth"), ] global_action_auth: Annotated[ - List[DocumentUpdateDocumentGlobalActionAuthResponse], + List[DocumentUpdateGlobalActionAuthResponse], pydantic.Field(alias="globalActionAuth"), ] -DocumentUpdateDocumentFormValuesTypedDict = TypeAliasType( - "DocumentUpdateDocumentFormValuesTypedDict", Union[str, bool, float] +DocumentUpdateFormValuesTypedDict = TypeAliasType( + "DocumentUpdateFormValuesTypedDict", Union[str, bool, float] ) -DocumentUpdateDocumentFormValues = TypeAliasType( - "DocumentUpdateDocumentFormValues", Union[str, bool, float] +DocumentUpdateFormValues = TypeAliasType( + "DocumentUpdateFormValues", Union[str, bool, float] ) -class DocumentUpdateDocumentResponseTypedDict(TypedDict): +class DocumentUpdateResponseTypedDict(TypedDict): r"""Successful response""" - visibility: DocumentUpdateDocumentVisibilityResponse - status: DocumentUpdateDocumentStatus - source: DocumentUpdateDocumentSource + visibility: DocumentUpdateVisibilityResponse + status: DocumentUpdateStatus + source: DocumentUpdateSource id: float external_id: Nullable[str] r"""A custom external ID you can use to identify the document.""" user_id: float r"""The ID of the user that created this document.""" - auth_options: Nullable[DocumentUpdateDocumentAuthOptionsTypedDict] - form_values: Nullable[Dict[str, DocumentUpdateDocumentFormValuesTypedDict]] + auth_options: Nullable[DocumentUpdateAuthOptionsTypedDict] + form_values: Nullable[Dict[str, DocumentUpdateFormValuesTypedDict]] title: str - document_data_id: str created_at: str updated_at: str completed_at: Nullable[str] deleted_at: Nullable[str] team_id: float - template_id: Nullable[float] folder_id: Nullable[str] use_legacy_field_insertion: bool + envelope_id: str + document_data_id: NotRequired[str] + template_id: NotRequired[Nullable[float]] + r"""The ID of the template that the document was created from, if any.""" -class DocumentUpdateDocumentResponse(BaseModel): +class DocumentUpdateResponse(BaseModel): r"""Successful response""" - visibility: DocumentUpdateDocumentVisibilityResponse + visibility: DocumentUpdateVisibilityResponse - status: DocumentUpdateDocumentStatus + status: DocumentUpdateStatus - source: DocumentUpdateDocumentSource + source: DocumentUpdateSource id: float @@ -475,18 +553,16 @@ class DocumentUpdateDocumentResponse(BaseModel): r"""The ID of the user that created this document.""" auth_options: Annotated[ - Nullable[DocumentUpdateDocumentAuthOptions], pydantic.Field(alias="authOptions") + Nullable[DocumentUpdateAuthOptions], pydantic.Field(alias="authOptions") ] form_values: Annotated[ - Nullable[Dict[str, DocumentUpdateDocumentFormValues]], + Nullable[Dict[str, DocumentUpdateFormValues]], pydantic.Field(alias="formValues"), ] title: str - document_data_id: Annotated[str, pydantic.Field(alias="documentDataId")] - created_at: Annotated[str, pydantic.Field(alias="createdAt")] updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] @@ -497,25 +573,34 @@ class DocumentUpdateDocumentResponse(BaseModel): team_id: Annotated[float, pydantic.Field(alias="teamId")] - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] use_legacy_field_insertion: Annotated[ bool, pydantic.Field(alias="useLegacyFieldInsertion") ] + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="documentDataId") + ] = "" + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + r"""The ID of the template that the document was created from, if any.""" + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentDataId", "templateId"] nullable_fields = [ "externalId", "authOptions", "formValues", "completedAt", "deletedAt", - "templateId", "folderId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/embeddingpresign_createembeddingpresigntokenop.py b/src/documenso_sdk/models/embeddingpresign_createembeddingpresigntokenop.py index c23a9a1..58da9c7 100644 --- a/src/documenso_sdk/models/embeddingpresign_createembeddingpresigntokenop.py +++ b/src/documenso_sdk/models/embeddingpresign_createembeddingpresigntokenop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -39,10 +40,13 @@ class EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData(BaseMod ] = None +@dataclass(unsafe_hash=True) class EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError(DocumensoError): r"""Internal server error""" - data: EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData + data: EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData = field( + hash=False + ) def __init__( self, @@ -53,7 +57,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssueTypedDict(TypedDict): @@ -74,10 +78,13 @@ class EmbeddingPresignCreateEmbeddingPresignTokenBadRequestErrorData(BaseModel): ] = None +@dataclass(unsafe_hash=True) class EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError(DocumensoError): r"""Invalid input data""" - data: EmbeddingPresignCreateEmbeddingPresignTokenBadRequestErrorData + data: EmbeddingPresignCreateEmbeddingPresignTokenBadRequestErrorData = field( + hash=False + ) def __init__( self, @@ -88,7 +95,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class EmbeddingPresignCreateEmbeddingPresignTokenResponseTypedDict(TypedDict): diff --git a/src/documenso_sdk/models/embeddingpresign_verifyembeddingpresigntokenop.py b/src/documenso_sdk/models/embeddingpresign_verifyembeddingpresigntokenop.py index 5a5f8ce..e7c3e63 100644 --- a/src/documenso_sdk/models/embeddingpresign_verifyembeddingpresigntokenop.py +++ b/src/documenso_sdk/models/embeddingpresign_verifyembeddingpresigntokenop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -38,10 +39,13 @@ class EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData(BaseMod ] = None +@dataclass(unsafe_hash=True) class EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError(DocumensoError): r"""Internal server error""" - data: EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData + data: EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData = field( + hash=False + ) def __init__( self, @@ -52,7 +56,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssueTypedDict(TypedDict): @@ -73,10 +77,13 @@ class EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestErrorData(BaseModel): ] = None +@dataclass(unsafe_hash=True) class EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError(DocumensoError): r"""Invalid input data""" - data: EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestErrorData + data: EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestErrorData = field( + hash=False + ) def __init__( self, @@ -87,7 +94,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class EmbeddingPresignVerifyEmbeddingPresignTokenResponseTypedDict(TypedDict): diff --git a/src/documenso_sdk/models/field_createdocumentfieldop.py b/src/documenso_sdk/models/field_createdocumentfieldop.py index 8d71d39..91bece8 100644 --- a/src/documenso_sdk/models/field_createdocumentfieldop.py +++ b/src/documenso_sdk/models/field_createdocumentfieldop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -119,6 +126,11 @@ class FieldCreateDocumentFieldValueCheckbox(BaseModel): value: str +class FieldCreateDocumentFieldDirectionRequest(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeCheckboxRequest2 label: NotRequired[str] @@ -128,6 +140,7 @@ class FieldCreateDocumentFieldFieldMetaCheckboxRequestTypedDict(TypedDict): values: NotRequired[List[FieldCreateDocumentFieldValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateDocumentFieldDirectionRequest] class FieldCreateDocumentFieldFieldMetaCheckboxRequest(BaseModel): @@ -151,6 +164,10 @@ class FieldCreateDocumentFieldFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateDocumentFieldDirectionRequest] = ( + FieldCreateDocumentFieldDirectionRequest.VERTICAL + ) + class FieldCreateDocumentFieldFieldCheckboxTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeCheckboxRequest1 @@ -305,10 +322,10 @@ class FieldCreateDocumentFieldFieldMetaNumberRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldCreateDocumentFieldTextAlignNumber] @@ -324,13 +341,19 @@ class FieldCreateDocumentFieldFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -339,6 +362,47 @@ class FieldCreateDocumentFieldFieldMetaNumberRequest(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldCreateDocumentFieldFieldNumberTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeNumberRequest1 @@ -974,10 +1038,11 @@ class FieldCreateDocumentFieldInternalServerErrorData(BaseModel): issues: Optional[List[FieldCreateDocumentFieldInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldCreateDocumentFieldInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldCreateDocumentFieldInternalServerErrorData + data: FieldCreateDocumentFieldInternalServerErrorData = field(hash=False) def __init__( self, @@ -988,7 +1053,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldCreateDocumentFieldBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1072,11 @@ class FieldCreateDocumentFieldBadRequestErrorData(BaseModel): issues: Optional[List[FieldCreateDocumentFieldBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldCreateDocumentFieldBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldCreateDocumentFieldBadRequestErrorData + data: FieldCreateDocumentFieldBadRequestErrorData = field(hash=False) def __init__( self, @@ -1021,7 +1087,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldCreateDocumentFieldTypeResponse(str, Enum): @@ -1094,6 +1160,11 @@ class FieldCreateDocumentFieldValueResponse2(BaseModel): value: str +class FieldCreateDocumentFieldDirectionResponse(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldCreateDocumentFieldFieldMetaTypeCheckbox label: NotRequired[str] @@ -1103,6 +1174,7 @@ class FieldCreateDocumentFieldFieldMetaCheckboxResponseTypedDict(TypedDict): values: NotRequired[List[FieldCreateDocumentFieldValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateDocumentFieldDirectionResponse] class FieldCreateDocumentFieldFieldMetaCheckboxResponse(BaseModel): @@ -1126,6 +1198,10 @@ class FieldCreateDocumentFieldFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateDocumentFieldDirectionResponse] = ( + FieldCreateDocumentFieldDirectionResponse.VERTICAL + ) + class FieldCreateDocumentFieldFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1184,10 +1260,10 @@ class FieldCreateDocumentFieldFieldMetaNumberResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldCreateDocumentFieldTextAlignResponse6] @@ -1203,13 +1279,19 @@ class FieldCreateDocumentFieldFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -1218,6 +1300,47 @@ class FieldCreateDocumentFieldFieldMetaNumberResponse(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldCreateDocumentFieldFieldMetaTypeText(str, Enum): TEXT = "text" @@ -1431,8 +1554,8 @@ class FieldCreateDocumentFieldFieldMetaInitialsResponse(BaseModel): FieldCreateDocumentFieldFieldMetaEmailResponseTypedDict, FieldCreateDocumentFieldFieldMetaDateResponseTypedDict, FieldCreateDocumentFieldFieldMetaDropdownResponseTypedDict, - FieldCreateDocumentFieldFieldMetaCheckboxResponseTypedDict, FieldCreateDocumentFieldFieldMetaTextResponseTypedDict, + FieldCreateDocumentFieldFieldMetaCheckboxResponseTypedDict, FieldCreateDocumentFieldFieldMetaNumberResponseTypedDict, ], ) @@ -1447,8 +1570,8 @@ class FieldCreateDocumentFieldFieldMetaInitialsResponse(BaseModel): FieldCreateDocumentFieldFieldMetaEmailResponse, FieldCreateDocumentFieldFieldMetaDateResponse, FieldCreateDocumentFieldFieldMetaDropdownResponse, - FieldCreateDocumentFieldFieldMetaCheckboxResponse, FieldCreateDocumentFieldFieldMetaTextResponse, + FieldCreateDocumentFieldFieldMetaCheckboxResponse, FieldCreateDocumentFieldFieldMetaNumberResponse, ], ) @@ -1457,11 +1580,11 @@ class FieldCreateDocumentFieldFieldMetaInitialsResponse(BaseModel): class FieldCreateDocumentFieldResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str + envelope_item_id: str type: FieldCreateDocumentFieldTypeResponse id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -1472,21 +1595,23 @@ class FieldCreateDocumentFieldResponseTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class FieldCreateDocumentFieldResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: FieldCreateDocumentFieldTypeResponse id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -1509,10 +1634,25 @@ class FieldCreateDocumentFieldResponse(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/field_createdocumentfieldsop.py b/src/documenso_sdk/models/field_createdocumentfieldsop.py index e13bc21..ecc3296 100644 --- a/src/documenso_sdk/models/field_createdocumentfieldsop.py +++ b/src/documenso_sdk/models/field_createdocumentfieldsop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -119,6 +126,11 @@ class FieldCreateDocumentFieldsValueCheckbox(BaseModel): value: str +class FieldCreateDocumentFieldsDirectionRequest(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeCheckboxRequest2 label: NotRequired[str] @@ -128,6 +140,7 @@ class FieldCreateDocumentFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): values: NotRequired[List[FieldCreateDocumentFieldsValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateDocumentFieldsDirectionRequest] class FieldCreateDocumentFieldsFieldMetaCheckboxRequest(BaseModel): @@ -151,6 +164,10 @@ class FieldCreateDocumentFieldsFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateDocumentFieldsDirectionRequest] = ( + FieldCreateDocumentFieldsDirectionRequest.VERTICAL + ) + class FieldCreateDocumentFieldsFieldCheckboxTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeCheckboxRequest1 @@ -305,10 +322,10 @@ class FieldCreateDocumentFieldsFieldMetaNumberRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldCreateDocumentFieldsTextAlignNumber] @@ -324,13 +341,19 @@ class FieldCreateDocumentFieldsFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -339,6 +362,47 @@ class FieldCreateDocumentFieldsFieldMetaNumberRequest(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldCreateDocumentFieldsFieldNumberTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeNumberRequest1 @@ -974,10 +1038,11 @@ class FieldCreateDocumentFieldsInternalServerErrorData(BaseModel): issues: Optional[List[FieldCreateDocumentFieldsInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldCreateDocumentFieldsInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldCreateDocumentFieldsInternalServerErrorData + data: FieldCreateDocumentFieldsInternalServerErrorData = field(hash=False) def __init__( self, @@ -988,7 +1053,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldCreateDocumentFieldsBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1072,11 @@ class FieldCreateDocumentFieldsBadRequestErrorData(BaseModel): issues: Optional[List[FieldCreateDocumentFieldsBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldCreateDocumentFieldsBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldCreateDocumentFieldsBadRequestErrorData + data: FieldCreateDocumentFieldsBadRequestErrorData = field(hash=False) def __init__( self, @@ -1021,7 +1087,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldCreateDocumentFieldsTypeResponse(str, Enum): @@ -1094,6 +1160,11 @@ class FieldCreateDocumentFieldsValueResponse2(BaseModel): value: str +class FieldCreateDocumentFieldsDirectionResponse(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldCreateDocumentFieldsFieldMetaTypeCheckbox label: NotRequired[str] @@ -1103,6 +1174,7 @@ class FieldCreateDocumentFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): values: NotRequired[List[FieldCreateDocumentFieldsValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateDocumentFieldsDirectionResponse] class FieldCreateDocumentFieldsFieldMetaCheckboxResponse(BaseModel): @@ -1126,6 +1198,10 @@ class FieldCreateDocumentFieldsFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateDocumentFieldsDirectionResponse] = ( + FieldCreateDocumentFieldsDirectionResponse.VERTICAL + ) + class FieldCreateDocumentFieldsFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1184,10 +1260,10 @@ class FieldCreateDocumentFieldsFieldMetaNumberResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldCreateDocumentFieldsTextAlignResponse6] @@ -1203,13 +1279,19 @@ class FieldCreateDocumentFieldsFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -1218,6 +1300,47 @@ class FieldCreateDocumentFieldsFieldMetaNumberResponse(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldCreateDocumentFieldsFieldMetaTypeText(str, Enum): TEXT = "text" @@ -1431,8 +1554,8 @@ class FieldCreateDocumentFieldsFieldMetaInitialsResponse(BaseModel): FieldCreateDocumentFieldsFieldMetaEmailResponseTypedDict, FieldCreateDocumentFieldsFieldMetaDateResponseTypedDict, FieldCreateDocumentFieldsFieldMetaDropdownResponseTypedDict, - FieldCreateDocumentFieldsFieldMetaCheckboxResponseTypedDict, FieldCreateDocumentFieldsFieldMetaTextResponseTypedDict, + FieldCreateDocumentFieldsFieldMetaCheckboxResponseTypedDict, FieldCreateDocumentFieldsFieldMetaNumberResponseTypedDict, ], ) @@ -1447,19 +1570,19 @@ class FieldCreateDocumentFieldsFieldMetaInitialsResponse(BaseModel): FieldCreateDocumentFieldsFieldMetaEmailResponse, FieldCreateDocumentFieldsFieldMetaDateResponse, FieldCreateDocumentFieldsFieldMetaDropdownResponse, - FieldCreateDocumentFieldsFieldMetaCheckboxResponse, FieldCreateDocumentFieldsFieldMetaTextResponse, + FieldCreateDocumentFieldsFieldMetaCheckboxResponse, FieldCreateDocumentFieldsFieldMetaNumberResponse, ], ) class FieldCreateDocumentFieldsFieldResponseTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: FieldCreateDocumentFieldsTypeResponse id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -1470,19 +1593,21 @@ class FieldCreateDocumentFieldsFieldResponseTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class FieldCreateDocumentFieldsFieldResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: FieldCreateDocumentFieldsTypeResponse id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -1505,10 +1630,25 @@ class FieldCreateDocumentFieldsFieldResponse(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/field_createtemplatefieldop.py b/src/documenso_sdk/models/field_createtemplatefieldop.py index af6dd14..aef9925 100644 --- a/src/documenso_sdk/models/field_createtemplatefieldop.py +++ b/src/documenso_sdk/models/field_createtemplatefieldop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -119,6 +126,11 @@ class FieldCreateTemplateFieldValueCheckbox(BaseModel): value: str +class FieldCreateTemplateFieldDirectionRequest(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeCheckboxRequest2 label: NotRequired[str] @@ -128,6 +140,7 @@ class FieldCreateTemplateFieldFieldMetaCheckboxRequestTypedDict(TypedDict): values: NotRequired[List[FieldCreateTemplateFieldValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateTemplateFieldDirectionRequest] class FieldCreateTemplateFieldFieldMetaCheckboxRequest(BaseModel): @@ -151,6 +164,10 @@ class FieldCreateTemplateFieldFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateTemplateFieldDirectionRequest] = ( + FieldCreateTemplateFieldDirectionRequest.VERTICAL + ) + class FieldCreateTemplateFieldFieldCheckboxTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeCheckboxRequest1 @@ -305,10 +322,10 @@ class FieldCreateTemplateFieldFieldMetaNumberRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldCreateTemplateFieldTextAlignNumber] @@ -324,13 +341,19 @@ class FieldCreateTemplateFieldFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -339,6 +362,47 @@ class FieldCreateTemplateFieldFieldMetaNumberRequest(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldCreateTemplateFieldFieldNumberTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeNumberRequest1 @@ -974,10 +1038,11 @@ class FieldCreateTemplateFieldInternalServerErrorData(BaseModel): issues: Optional[List[FieldCreateTemplateFieldInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldCreateTemplateFieldInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldCreateTemplateFieldInternalServerErrorData + data: FieldCreateTemplateFieldInternalServerErrorData = field(hash=False) def __init__( self, @@ -988,7 +1053,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldCreateTemplateFieldBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1072,11 @@ class FieldCreateTemplateFieldBadRequestErrorData(BaseModel): issues: Optional[List[FieldCreateTemplateFieldBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldCreateTemplateFieldBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldCreateTemplateFieldBadRequestErrorData + data: FieldCreateTemplateFieldBadRequestErrorData = field(hash=False) def __init__( self, @@ -1021,7 +1087,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldCreateTemplateFieldTypeResponse(str, Enum): @@ -1094,6 +1160,11 @@ class FieldCreateTemplateFieldValueResponse2(BaseModel): value: str +class FieldCreateTemplateFieldDirectionResponse(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldCreateTemplateFieldFieldMetaTypeCheckbox label: NotRequired[str] @@ -1103,6 +1174,7 @@ class FieldCreateTemplateFieldFieldMetaCheckboxResponseTypedDict(TypedDict): values: NotRequired[List[FieldCreateTemplateFieldValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateTemplateFieldDirectionResponse] class FieldCreateTemplateFieldFieldMetaCheckboxResponse(BaseModel): @@ -1126,6 +1198,10 @@ class FieldCreateTemplateFieldFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateTemplateFieldDirectionResponse] = ( + FieldCreateTemplateFieldDirectionResponse.VERTICAL + ) + class FieldCreateTemplateFieldFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1184,10 +1260,10 @@ class FieldCreateTemplateFieldFieldMetaNumberResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldCreateTemplateFieldTextAlignResponse6] @@ -1203,13 +1279,19 @@ class FieldCreateTemplateFieldFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -1218,6 +1300,47 @@ class FieldCreateTemplateFieldFieldMetaNumberResponse(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldCreateTemplateFieldFieldMetaTypeText(str, Enum): TEXT = "text" @@ -1431,8 +1554,8 @@ class FieldCreateTemplateFieldFieldMetaInitialsResponse(BaseModel): FieldCreateTemplateFieldFieldMetaEmailResponseTypedDict, FieldCreateTemplateFieldFieldMetaDateResponseTypedDict, FieldCreateTemplateFieldFieldMetaDropdownResponseTypedDict, - FieldCreateTemplateFieldFieldMetaCheckboxResponseTypedDict, FieldCreateTemplateFieldFieldMetaTextResponseTypedDict, + FieldCreateTemplateFieldFieldMetaCheckboxResponseTypedDict, FieldCreateTemplateFieldFieldMetaNumberResponseTypedDict, ], ) @@ -1447,8 +1570,8 @@ class FieldCreateTemplateFieldFieldMetaInitialsResponse(BaseModel): FieldCreateTemplateFieldFieldMetaEmailResponse, FieldCreateTemplateFieldFieldMetaDateResponse, FieldCreateTemplateFieldFieldMetaDropdownResponse, - FieldCreateTemplateFieldFieldMetaCheckboxResponse, FieldCreateTemplateFieldFieldMetaTextResponse, + FieldCreateTemplateFieldFieldMetaCheckboxResponse, FieldCreateTemplateFieldFieldMetaNumberResponse, ], ) @@ -1457,11 +1580,11 @@ class FieldCreateTemplateFieldFieldMetaInitialsResponse(BaseModel): class FieldCreateTemplateFieldResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str + envelope_item_id: str type: FieldCreateTemplateFieldTypeResponse id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -1472,21 +1595,23 @@ class FieldCreateTemplateFieldResponseTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class FieldCreateTemplateFieldResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: FieldCreateTemplateFieldTypeResponse id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -1509,10 +1634,25 @@ class FieldCreateTemplateFieldResponse(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/field_createtemplatefieldsop.py b/src/documenso_sdk/models/field_createtemplatefieldsop.py index 51dc9ab..98837f8 100644 --- a/src/documenso_sdk/models/field_createtemplatefieldsop.py +++ b/src/documenso_sdk/models/field_createtemplatefieldsop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -119,6 +126,11 @@ class FieldCreateTemplateFieldsValueCheckbox(BaseModel): value: str +class FieldCreateTemplateFieldsDirectionRequest(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeCheckboxRequest2 label: NotRequired[str] @@ -128,6 +140,7 @@ class FieldCreateTemplateFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): values: NotRequired[List[FieldCreateTemplateFieldsValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateTemplateFieldsDirectionRequest] class FieldCreateTemplateFieldsFieldMetaCheckboxRequest(BaseModel): @@ -151,6 +164,10 @@ class FieldCreateTemplateFieldsFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateTemplateFieldsDirectionRequest] = ( + FieldCreateTemplateFieldsDirectionRequest.VERTICAL + ) + class FieldCreateTemplateFieldsFieldCheckboxTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeCheckboxRequest1 @@ -305,10 +322,10 @@ class FieldCreateTemplateFieldsFieldMetaNumberRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldCreateTemplateFieldsTextAlignNumber] @@ -324,13 +341,19 @@ class FieldCreateTemplateFieldsFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -339,6 +362,47 @@ class FieldCreateTemplateFieldsFieldMetaNumberRequest(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldCreateTemplateFieldsFieldNumberTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeNumberRequest1 @@ -974,10 +1038,11 @@ class FieldCreateTemplateFieldsInternalServerErrorData(BaseModel): issues: Optional[List[FieldCreateTemplateFieldsInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldCreateTemplateFieldsInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldCreateTemplateFieldsInternalServerErrorData + data: FieldCreateTemplateFieldsInternalServerErrorData = field(hash=False) def __init__( self, @@ -988,7 +1053,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldCreateTemplateFieldsBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1072,11 @@ class FieldCreateTemplateFieldsBadRequestErrorData(BaseModel): issues: Optional[List[FieldCreateTemplateFieldsBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldCreateTemplateFieldsBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldCreateTemplateFieldsBadRequestErrorData + data: FieldCreateTemplateFieldsBadRequestErrorData = field(hash=False) def __init__( self, @@ -1021,7 +1087,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldCreateTemplateFieldsTypeResponse(str, Enum): @@ -1094,6 +1160,11 @@ class FieldCreateTemplateFieldsValueResponse2(BaseModel): value: str +class FieldCreateTemplateFieldsDirectionResponse(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldCreateTemplateFieldsFieldMetaTypeCheckbox label: NotRequired[str] @@ -1103,6 +1174,7 @@ class FieldCreateTemplateFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): values: NotRequired[List[FieldCreateTemplateFieldsValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateTemplateFieldsDirectionResponse] class FieldCreateTemplateFieldsFieldMetaCheckboxResponse(BaseModel): @@ -1126,6 +1198,10 @@ class FieldCreateTemplateFieldsFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateTemplateFieldsDirectionResponse] = ( + FieldCreateTemplateFieldsDirectionResponse.VERTICAL + ) + class FieldCreateTemplateFieldsFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1184,10 +1260,10 @@ class FieldCreateTemplateFieldsFieldMetaNumberResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldCreateTemplateFieldsTextAlignResponse6] @@ -1203,13 +1279,19 @@ class FieldCreateTemplateFieldsFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -1218,6 +1300,47 @@ class FieldCreateTemplateFieldsFieldMetaNumberResponse(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldCreateTemplateFieldsFieldMetaTypeText(str, Enum): TEXT = "text" @@ -1431,8 +1554,8 @@ class FieldCreateTemplateFieldsFieldMetaInitialsResponse(BaseModel): FieldCreateTemplateFieldsFieldMetaEmailResponseTypedDict, FieldCreateTemplateFieldsFieldMetaDateResponseTypedDict, FieldCreateTemplateFieldsFieldMetaDropdownResponseTypedDict, - FieldCreateTemplateFieldsFieldMetaCheckboxResponseTypedDict, FieldCreateTemplateFieldsFieldMetaTextResponseTypedDict, + FieldCreateTemplateFieldsFieldMetaCheckboxResponseTypedDict, FieldCreateTemplateFieldsFieldMetaNumberResponseTypedDict, ], ) @@ -1447,19 +1570,19 @@ class FieldCreateTemplateFieldsFieldMetaInitialsResponse(BaseModel): FieldCreateTemplateFieldsFieldMetaEmailResponse, FieldCreateTemplateFieldsFieldMetaDateResponse, FieldCreateTemplateFieldsFieldMetaDropdownResponse, - FieldCreateTemplateFieldsFieldMetaCheckboxResponse, FieldCreateTemplateFieldsFieldMetaTextResponse, + FieldCreateTemplateFieldsFieldMetaCheckboxResponse, FieldCreateTemplateFieldsFieldMetaNumberResponse, ], ) class FieldCreateTemplateFieldsFieldResponseTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: FieldCreateTemplateFieldsTypeResponse id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -1470,19 +1593,21 @@ class FieldCreateTemplateFieldsFieldResponseTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class FieldCreateTemplateFieldsFieldResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: FieldCreateTemplateFieldsTypeResponse id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -1505,10 +1630,25 @@ class FieldCreateTemplateFieldsFieldResponse(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/field_deletedocumentfieldop.py b/src/documenso_sdk/models/field_deletedocumentfieldop.py index 2c89d9c..31ef168 100644 --- a/src/documenso_sdk/models/field_deletedocumentfieldop.py +++ b/src/documenso_sdk/models/field_deletedocumentfieldop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -33,10 +34,11 @@ class FieldDeleteDocumentFieldInternalServerErrorData(BaseModel): issues: Optional[List[FieldDeleteDocumentFieldInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldDeleteDocumentFieldInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldDeleteDocumentFieldInternalServerErrorData + data: FieldDeleteDocumentFieldInternalServerErrorData = field(hash=False) def __init__( self, @@ -47,7 +49,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldDeleteDocumentFieldBadRequestIssueTypedDict(TypedDict): @@ -66,10 +68,11 @@ class FieldDeleteDocumentFieldBadRequestErrorData(BaseModel): issues: Optional[List[FieldDeleteDocumentFieldBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldDeleteDocumentFieldBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldDeleteDocumentFieldBadRequestErrorData + data: FieldDeleteDocumentFieldBadRequestErrorData = field(hash=False) def __init__( self, @@ -80,7 +83,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldDeleteDocumentFieldResponseTypedDict(TypedDict): diff --git a/src/documenso_sdk/models/field_deletetemplatefieldop.py b/src/documenso_sdk/models/field_deletetemplatefieldop.py index def04a0..a99eb5a 100644 --- a/src/documenso_sdk/models/field_deletetemplatefieldop.py +++ b/src/documenso_sdk/models/field_deletetemplatefieldop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -33,10 +34,11 @@ class FieldDeleteTemplateFieldInternalServerErrorData(BaseModel): issues: Optional[List[FieldDeleteTemplateFieldInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldDeleteTemplateFieldInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldDeleteTemplateFieldInternalServerErrorData + data: FieldDeleteTemplateFieldInternalServerErrorData = field(hash=False) def __init__( self, @@ -47,7 +49,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldDeleteTemplateFieldBadRequestIssueTypedDict(TypedDict): @@ -66,10 +68,11 @@ class FieldDeleteTemplateFieldBadRequestErrorData(BaseModel): issues: Optional[List[FieldDeleteTemplateFieldBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldDeleteTemplateFieldBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldDeleteTemplateFieldBadRequestErrorData + data: FieldDeleteTemplateFieldBadRequestErrorData = field(hash=False) def __init__( self, @@ -80,7 +83,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldDeleteTemplateFieldResponseTypedDict(TypedDict): diff --git a/src/documenso_sdk/models/field_getdocumentfieldop.py b/src/documenso_sdk/models/field_getdocumentfieldop.py index f754ba6..2cebe3b 100644 --- a/src/documenso_sdk/models/field_getdocumentfieldop.py +++ b/src/documenso_sdk/models/field_getdocumentfieldop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from documenso_sdk.utils import FieldMetadata, PathParamMetadata from enum import Enum import httpx @@ -40,10 +47,11 @@ class FieldGetDocumentFieldInternalServerErrorData(BaseModel): issues: Optional[List[FieldGetDocumentFieldInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldGetDocumentFieldInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldGetDocumentFieldInternalServerErrorData + data: FieldGetDocumentFieldInternalServerErrorData = field(hash=False) def __init__( self, @@ -54,7 +62,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldGetDocumentFieldNotFoundIssueTypedDict(TypedDict): @@ -73,10 +81,11 @@ class FieldGetDocumentFieldNotFoundErrorData(BaseModel): issues: Optional[List[FieldGetDocumentFieldNotFoundIssue]] = None +@dataclass(unsafe_hash=True) class FieldGetDocumentFieldNotFoundError(DocumensoError): r"""Not found""" - data: FieldGetDocumentFieldNotFoundErrorData + data: FieldGetDocumentFieldNotFoundErrorData = field(hash=False) def __init__( self, @@ -87,7 +96,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldGetDocumentFieldBadRequestIssueTypedDict(TypedDict): @@ -106,10 +115,11 @@ class FieldGetDocumentFieldBadRequestErrorData(BaseModel): issues: Optional[List[FieldGetDocumentFieldBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldGetDocumentFieldBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldGetDocumentFieldBadRequestErrorData + data: FieldGetDocumentFieldBadRequestErrorData = field(hash=False) def __init__( self, @@ -120,7 +130,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldGetDocumentFieldType(str, Enum): @@ -193,6 +203,11 @@ class FieldGetDocumentFieldValue2(BaseModel): value: str +class FieldGetDocumentFieldDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldGetDocumentFieldFieldMetaCheckboxTypedDict(TypedDict): type: FieldGetDocumentFieldTypeCheckbox label: NotRequired[str] @@ -202,6 +217,7 @@ class FieldGetDocumentFieldFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[FieldGetDocumentFieldValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldGetDocumentFieldDirection] class FieldGetDocumentFieldFieldMetaCheckbox(BaseModel): @@ -225,6 +241,10 @@ class FieldGetDocumentFieldFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldGetDocumentFieldDirection] = ( + FieldGetDocumentFieldDirection.VERTICAL + ) + class FieldGetDocumentFieldTypeRadio(str, Enum): RADIO = "radio" @@ -283,10 +303,10 @@ class FieldGetDocumentFieldFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldGetDocumentFieldTextAlign6] @@ -302,13 +322,19 @@ class FieldGetDocumentFieldFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -316,6 +342,47 @@ class FieldGetDocumentFieldFieldMetaNumber(BaseModel): Optional[FieldGetDocumentFieldTextAlign6], pydantic.Field(alias="textAlign") ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldGetDocumentFieldTypeText(str, Enum): TEXT = "text" @@ -524,8 +591,8 @@ class FieldGetDocumentFieldFieldMetaInitials(BaseModel): FieldGetDocumentFieldFieldMetaEmailTypedDict, FieldGetDocumentFieldFieldMetaDateTypedDict, FieldGetDocumentFieldFieldMetaDropdownTypedDict, - FieldGetDocumentFieldFieldMetaCheckboxTypedDict, FieldGetDocumentFieldFieldMetaTextTypedDict, + FieldGetDocumentFieldFieldMetaCheckboxTypedDict, FieldGetDocumentFieldFieldMetaNumberTypedDict, ], ) @@ -540,8 +607,8 @@ class FieldGetDocumentFieldFieldMetaInitials(BaseModel): FieldGetDocumentFieldFieldMetaEmail, FieldGetDocumentFieldFieldMetaDate, FieldGetDocumentFieldFieldMetaDropdown, - FieldGetDocumentFieldFieldMetaCheckbox, FieldGetDocumentFieldFieldMetaText, + FieldGetDocumentFieldFieldMetaCheckbox, FieldGetDocumentFieldFieldMetaNumber, ], ) @@ -550,11 +617,11 @@ class FieldGetDocumentFieldFieldMetaInitials(BaseModel): class FieldGetDocumentFieldResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str + envelope_item_id: str type: FieldGetDocumentFieldType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -565,21 +632,23 @@ class FieldGetDocumentFieldResponseTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class FieldGetDocumentFieldResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: FieldGetDocumentFieldType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -601,10 +670,25 @@ class FieldGetDocumentFieldResponse(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/field_gettemplatefieldop.py b/src/documenso_sdk/models/field_gettemplatefieldop.py index 8f7b680..0ed2627 100644 --- a/src/documenso_sdk/models/field_gettemplatefieldop.py +++ b/src/documenso_sdk/models/field_gettemplatefieldop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from documenso_sdk.utils import FieldMetadata, PathParamMetadata from enum import Enum import httpx @@ -40,10 +47,11 @@ class FieldGetTemplateFieldInternalServerErrorData(BaseModel): issues: Optional[List[FieldGetTemplateFieldInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldGetTemplateFieldInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldGetTemplateFieldInternalServerErrorData + data: FieldGetTemplateFieldInternalServerErrorData = field(hash=False) def __init__( self, @@ -54,7 +62,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldGetTemplateFieldNotFoundIssueTypedDict(TypedDict): @@ -73,10 +81,11 @@ class FieldGetTemplateFieldNotFoundErrorData(BaseModel): issues: Optional[List[FieldGetTemplateFieldNotFoundIssue]] = None +@dataclass(unsafe_hash=True) class FieldGetTemplateFieldNotFoundError(DocumensoError): r"""Not found""" - data: FieldGetTemplateFieldNotFoundErrorData + data: FieldGetTemplateFieldNotFoundErrorData = field(hash=False) def __init__( self, @@ -87,7 +96,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldGetTemplateFieldBadRequestIssueTypedDict(TypedDict): @@ -106,10 +115,11 @@ class FieldGetTemplateFieldBadRequestErrorData(BaseModel): issues: Optional[List[FieldGetTemplateFieldBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldGetTemplateFieldBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldGetTemplateFieldBadRequestErrorData + data: FieldGetTemplateFieldBadRequestErrorData = field(hash=False) def __init__( self, @@ -120,7 +130,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldGetTemplateFieldType(str, Enum): @@ -193,6 +203,11 @@ class FieldGetTemplateFieldValue2(BaseModel): value: str +class FieldGetTemplateFieldDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldGetTemplateFieldFieldMetaCheckboxTypedDict(TypedDict): type: FieldGetTemplateFieldTypeCheckbox label: NotRequired[str] @@ -202,6 +217,7 @@ class FieldGetTemplateFieldFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[FieldGetTemplateFieldValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldGetTemplateFieldDirection] class FieldGetTemplateFieldFieldMetaCheckbox(BaseModel): @@ -225,6 +241,10 @@ class FieldGetTemplateFieldFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldGetTemplateFieldDirection] = ( + FieldGetTemplateFieldDirection.VERTICAL + ) + class FieldGetTemplateFieldTypeRadio(str, Enum): RADIO = "radio" @@ -283,10 +303,10 @@ class FieldGetTemplateFieldFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldGetTemplateFieldTextAlign6] @@ -302,13 +322,19 @@ class FieldGetTemplateFieldFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -316,6 +342,47 @@ class FieldGetTemplateFieldFieldMetaNumber(BaseModel): Optional[FieldGetTemplateFieldTextAlign6], pydantic.Field(alias="textAlign") ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldGetTemplateFieldTypeText(str, Enum): TEXT = "text" @@ -524,8 +591,8 @@ class FieldGetTemplateFieldFieldMetaInitials(BaseModel): FieldGetTemplateFieldFieldMetaEmailTypedDict, FieldGetTemplateFieldFieldMetaDateTypedDict, FieldGetTemplateFieldFieldMetaDropdownTypedDict, - FieldGetTemplateFieldFieldMetaCheckboxTypedDict, FieldGetTemplateFieldFieldMetaTextTypedDict, + FieldGetTemplateFieldFieldMetaCheckboxTypedDict, FieldGetTemplateFieldFieldMetaNumberTypedDict, ], ) @@ -540,8 +607,8 @@ class FieldGetTemplateFieldFieldMetaInitials(BaseModel): FieldGetTemplateFieldFieldMetaEmail, FieldGetTemplateFieldFieldMetaDate, FieldGetTemplateFieldFieldMetaDropdown, - FieldGetTemplateFieldFieldMetaCheckbox, FieldGetTemplateFieldFieldMetaText, + FieldGetTemplateFieldFieldMetaCheckbox, FieldGetTemplateFieldFieldMetaNumber, ], ) @@ -550,11 +617,11 @@ class FieldGetTemplateFieldFieldMetaInitials(BaseModel): class FieldGetTemplateFieldResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str + envelope_item_id: str type: FieldGetTemplateFieldType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -565,21 +632,23 @@ class FieldGetTemplateFieldResponseTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class FieldGetTemplateFieldResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: FieldGetTemplateFieldType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -601,10 +670,25 @@ class FieldGetTemplateFieldResponse(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/field_updatedocumentfieldop.py b/src/documenso_sdk/models/field_updatedocumentfieldop.py index 1ad1fa9..c28ceb3 100644 --- a/src/documenso_sdk/models/field_updatedocumentfieldop.py +++ b/src/documenso_sdk/models/field_updatedocumentfieldop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -119,6 +126,11 @@ class FieldUpdateDocumentFieldValueCheckbox(BaseModel): value: str +class FieldUpdateDocumentFieldDirectionRequest(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeCheckboxRequest2 label: NotRequired[str] @@ -128,6 +140,7 @@ class FieldUpdateDocumentFieldFieldMetaCheckboxRequestTypedDict(TypedDict): values: NotRequired[List[FieldUpdateDocumentFieldValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateDocumentFieldDirectionRequest] class FieldUpdateDocumentFieldFieldMetaCheckboxRequest(BaseModel): @@ -151,6 +164,10 @@ class FieldUpdateDocumentFieldFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateDocumentFieldDirectionRequest] = ( + FieldUpdateDocumentFieldDirectionRequest.VERTICAL + ) + class FieldUpdateDocumentFieldFieldCheckboxTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeCheckboxRequest1 @@ -305,10 +322,10 @@ class FieldUpdateDocumentFieldFieldMetaNumberRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldUpdateDocumentFieldTextAlignNumber] @@ -324,13 +341,19 @@ class FieldUpdateDocumentFieldFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -339,6 +362,47 @@ class FieldUpdateDocumentFieldFieldMetaNumberRequest(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldUpdateDocumentFieldFieldNumberTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeNumberRequest1 @@ -974,10 +1038,11 @@ class FieldUpdateDocumentFieldInternalServerErrorData(BaseModel): issues: Optional[List[FieldUpdateDocumentFieldInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldUpdateDocumentFieldInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldUpdateDocumentFieldInternalServerErrorData + data: FieldUpdateDocumentFieldInternalServerErrorData = field(hash=False) def __init__( self, @@ -988,7 +1053,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldUpdateDocumentFieldBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1072,11 @@ class FieldUpdateDocumentFieldBadRequestErrorData(BaseModel): issues: Optional[List[FieldUpdateDocumentFieldBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldUpdateDocumentFieldBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldUpdateDocumentFieldBadRequestErrorData + data: FieldUpdateDocumentFieldBadRequestErrorData = field(hash=False) def __init__( self, @@ -1021,7 +1087,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldUpdateDocumentFieldTypeResponse(str, Enum): @@ -1094,6 +1160,11 @@ class FieldUpdateDocumentFieldValueResponse2(BaseModel): value: str +class FieldUpdateDocumentFieldDirectionResponse(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldUpdateDocumentFieldFieldMetaTypeCheckbox label: NotRequired[str] @@ -1103,6 +1174,7 @@ class FieldUpdateDocumentFieldFieldMetaCheckboxResponseTypedDict(TypedDict): values: NotRequired[List[FieldUpdateDocumentFieldValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateDocumentFieldDirectionResponse] class FieldUpdateDocumentFieldFieldMetaCheckboxResponse(BaseModel): @@ -1126,6 +1198,10 @@ class FieldUpdateDocumentFieldFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateDocumentFieldDirectionResponse] = ( + FieldUpdateDocumentFieldDirectionResponse.VERTICAL + ) + class FieldUpdateDocumentFieldFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1184,10 +1260,10 @@ class FieldUpdateDocumentFieldFieldMetaNumberResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldUpdateDocumentFieldTextAlignResponse6] @@ -1203,13 +1279,19 @@ class FieldUpdateDocumentFieldFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -1218,6 +1300,47 @@ class FieldUpdateDocumentFieldFieldMetaNumberResponse(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldUpdateDocumentFieldFieldMetaTypeText(str, Enum): TEXT = "text" @@ -1431,8 +1554,8 @@ class FieldUpdateDocumentFieldFieldMetaInitialsResponse(BaseModel): FieldUpdateDocumentFieldFieldMetaEmailResponseTypedDict, FieldUpdateDocumentFieldFieldMetaDateResponseTypedDict, FieldUpdateDocumentFieldFieldMetaDropdownResponseTypedDict, - FieldUpdateDocumentFieldFieldMetaCheckboxResponseTypedDict, FieldUpdateDocumentFieldFieldMetaTextResponseTypedDict, + FieldUpdateDocumentFieldFieldMetaCheckboxResponseTypedDict, FieldUpdateDocumentFieldFieldMetaNumberResponseTypedDict, ], ) @@ -1447,8 +1570,8 @@ class FieldUpdateDocumentFieldFieldMetaInitialsResponse(BaseModel): FieldUpdateDocumentFieldFieldMetaEmailResponse, FieldUpdateDocumentFieldFieldMetaDateResponse, FieldUpdateDocumentFieldFieldMetaDropdownResponse, - FieldUpdateDocumentFieldFieldMetaCheckboxResponse, FieldUpdateDocumentFieldFieldMetaTextResponse, + FieldUpdateDocumentFieldFieldMetaCheckboxResponse, FieldUpdateDocumentFieldFieldMetaNumberResponse, ], ) @@ -1457,11 +1580,11 @@ class FieldUpdateDocumentFieldFieldMetaInitialsResponse(BaseModel): class FieldUpdateDocumentFieldResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str + envelope_item_id: str type: FieldUpdateDocumentFieldTypeResponse id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -1472,21 +1595,23 @@ class FieldUpdateDocumentFieldResponseTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class FieldUpdateDocumentFieldResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: FieldUpdateDocumentFieldTypeResponse id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -1509,10 +1634,25 @@ class FieldUpdateDocumentFieldResponse(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/field_updatedocumentfieldsop.py b/src/documenso_sdk/models/field_updatedocumentfieldsop.py index 6556734..6f79070 100644 --- a/src/documenso_sdk/models/field_updatedocumentfieldsop.py +++ b/src/documenso_sdk/models/field_updatedocumentfieldsop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -119,6 +126,11 @@ class FieldUpdateDocumentFieldsValueCheckbox(BaseModel): value: str +class FieldUpdateDocumentFieldsDirectionRequest(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeCheckboxRequest2 label: NotRequired[str] @@ -128,6 +140,7 @@ class FieldUpdateDocumentFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): values: NotRequired[List[FieldUpdateDocumentFieldsValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateDocumentFieldsDirectionRequest] class FieldUpdateDocumentFieldsFieldMetaCheckboxRequest(BaseModel): @@ -151,6 +164,10 @@ class FieldUpdateDocumentFieldsFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateDocumentFieldsDirectionRequest] = ( + FieldUpdateDocumentFieldsDirectionRequest.VERTICAL + ) + class FieldUpdateDocumentFieldsFieldCheckboxTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeCheckboxRequest1 @@ -305,10 +322,10 @@ class FieldUpdateDocumentFieldsFieldMetaNumberRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldUpdateDocumentFieldsTextAlignNumber] @@ -324,13 +341,19 @@ class FieldUpdateDocumentFieldsFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -339,6 +362,47 @@ class FieldUpdateDocumentFieldsFieldMetaNumberRequest(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldUpdateDocumentFieldsFieldNumberTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeNumberRequest1 @@ -974,10 +1038,11 @@ class FieldUpdateDocumentFieldsInternalServerErrorData(BaseModel): issues: Optional[List[FieldUpdateDocumentFieldsInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldUpdateDocumentFieldsInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldUpdateDocumentFieldsInternalServerErrorData + data: FieldUpdateDocumentFieldsInternalServerErrorData = field(hash=False) def __init__( self, @@ -988,7 +1053,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldUpdateDocumentFieldsBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1072,11 @@ class FieldUpdateDocumentFieldsBadRequestErrorData(BaseModel): issues: Optional[List[FieldUpdateDocumentFieldsBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldUpdateDocumentFieldsBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldUpdateDocumentFieldsBadRequestErrorData + data: FieldUpdateDocumentFieldsBadRequestErrorData = field(hash=False) def __init__( self, @@ -1021,7 +1087,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldUpdateDocumentFieldsTypeResponse(str, Enum): @@ -1094,6 +1160,11 @@ class FieldUpdateDocumentFieldsValueResponse2(BaseModel): value: str +class FieldUpdateDocumentFieldsDirectionResponse(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldUpdateDocumentFieldsFieldMetaTypeCheckbox label: NotRequired[str] @@ -1103,6 +1174,7 @@ class FieldUpdateDocumentFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): values: NotRequired[List[FieldUpdateDocumentFieldsValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateDocumentFieldsDirectionResponse] class FieldUpdateDocumentFieldsFieldMetaCheckboxResponse(BaseModel): @@ -1126,6 +1198,10 @@ class FieldUpdateDocumentFieldsFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateDocumentFieldsDirectionResponse] = ( + FieldUpdateDocumentFieldsDirectionResponse.VERTICAL + ) + class FieldUpdateDocumentFieldsFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1184,10 +1260,10 @@ class FieldUpdateDocumentFieldsFieldMetaNumberResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldUpdateDocumentFieldsTextAlignResponse6] @@ -1203,13 +1279,19 @@ class FieldUpdateDocumentFieldsFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -1218,6 +1300,47 @@ class FieldUpdateDocumentFieldsFieldMetaNumberResponse(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldUpdateDocumentFieldsFieldMetaTypeText(str, Enum): TEXT = "text" @@ -1431,8 +1554,8 @@ class FieldUpdateDocumentFieldsFieldMetaInitialsResponse(BaseModel): FieldUpdateDocumentFieldsFieldMetaEmailResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaDateResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaDropdownResponseTypedDict, - FieldUpdateDocumentFieldsFieldMetaCheckboxResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaTextResponseTypedDict, + FieldUpdateDocumentFieldsFieldMetaCheckboxResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaNumberResponseTypedDict, ], ) @@ -1447,19 +1570,19 @@ class FieldUpdateDocumentFieldsFieldMetaInitialsResponse(BaseModel): FieldUpdateDocumentFieldsFieldMetaEmailResponse, FieldUpdateDocumentFieldsFieldMetaDateResponse, FieldUpdateDocumentFieldsFieldMetaDropdownResponse, - FieldUpdateDocumentFieldsFieldMetaCheckboxResponse, FieldUpdateDocumentFieldsFieldMetaTextResponse, + FieldUpdateDocumentFieldsFieldMetaCheckboxResponse, FieldUpdateDocumentFieldsFieldMetaNumberResponse, ], ) class FieldUpdateDocumentFieldsFieldResponseTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: FieldUpdateDocumentFieldsTypeResponse id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -1470,19 +1593,21 @@ class FieldUpdateDocumentFieldsFieldResponseTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class FieldUpdateDocumentFieldsFieldResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: FieldUpdateDocumentFieldsTypeResponse id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -1505,10 +1630,25 @@ class FieldUpdateDocumentFieldsFieldResponse(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/field_updatetemplatefieldop.py b/src/documenso_sdk/models/field_updatetemplatefieldop.py index 36d9cc8..53145ac 100644 --- a/src/documenso_sdk/models/field_updatetemplatefieldop.py +++ b/src/documenso_sdk/models/field_updatetemplatefieldop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -119,6 +126,11 @@ class FieldUpdateTemplateFieldValueCheckbox(BaseModel): value: str +class FieldUpdateTemplateFieldDirectionRequest(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeCheckboxRequest2 label: NotRequired[str] @@ -128,6 +140,7 @@ class FieldUpdateTemplateFieldFieldMetaCheckboxRequestTypedDict(TypedDict): values: NotRequired[List[FieldUpdateTemplateFieldValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateTemplateFieldDirectionRequest] class FieldUpdateTemplateFieldFieldMetaCheckboxRequest(BaseModel): @@ -151,6 +164,10 @@ class FieldUpdateTemplateFieldFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateTemplateFieldDirectionRequest] = ( + FieldUpdateTemplateFieldDirectionRequest.VERTICAL + ) + class FieldUpdateTemplateFieldFieldCheckboxTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeCheckboxRequest1 @@ -305,10 +322,10 @@ class FieldUpdateTemplateFieldFieldMetaNumberRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldUpdateTemplateFieldTextAlignNumber] @@ -324,13 +341,19 @@ class FieldUpdateTemplateFieldFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -339,6 +362,47 @@ class FieldUpdateTemplateFieldFieldMetaNumberRequest(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldUpdateTemplateFieldFieldNumberTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeNumberRequest1 @@ -974,10 +1038,11 @@ class FieldUpdateTemplateFieldInternalServerErrorData(BaseModel): issues: Optional[List[FieldUpdateTemplateFieldInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldUpdateTemplateFieldInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldUpdateTemplateFieldInternalServerErrorData + data: FieldUpdateTemplateFieldInternalServerErrorData = field(hash=False) def __init__( self, @@ -988,7 +1053,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldUpdateTemplateFieldBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1072,11 @@ class FieldUpdateTemplateFieldBadRequestErrorData(BaseModel): issues: Optional[List[FieldUpdateTemplateFieldBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldUpdateTemplateFieldBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldUpdateTemplateFieldBadRequestErrorData + data: FieldUpdateTemplateFieldBadRequestErrorData = field(hash=False) def __init__( self, @@ -1021,7 +1087,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldUpdateTemplateFieldTypeResponse(str, Enum): @@ -1094,6 +1160,11 @@ class FieldUpdateTemplateFieldValueResponse2(BaseModel): value: str +class FieldUpdateTemplateFieldDirectionResponse(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldUpdateTemplateFieldFieldMetaTypeCheckbox label: NotRequired[str] @@ -1103,6 +1174,7 @@ class FieldUpdateTemplateFieldFieldMetaCheckboxResponseTypedDict(TypedDict): values: NotRequired[List[FieldUpdateTemplateFieldValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateTemplateFieldDirectionResponse] class FieldUpdateTemplateFieldFieldMetaCheckboxResponse(BaseModel): @@ -1126,6 +1198,10 @@ class FieldUpdateTemplateFieldFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateTemplateFieldDirectionResponse] = ( + FieldUpdateTemplateFieldDirectionResponse.VERTICAL + ) + class FieldUpdateTemplateFieldFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1184,10 +1260,10 @@ class FieldUpdateTemplateFieldFieldMetaNumberResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldUpdateTemplateFieldTextAlignResponse6] @@ -1203,13 +1279,19 @@ class FieldUpdateTemplateFieldFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -1218,6 +1300,47 @@ class FieldUpdateTemplateFieldFieldMetaNumberResponse(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldUpdateTemplateFieldFieldMetaTypeText(str, Enum): TEXT = "text" @@ -1431,8 +1554,8 @@ class FieldUpdateTemplateFieldFieldMetaInitialsResponse(BaseModel): FieldUpdateTemplateFieldFieldMetaEmailResponseTypedDict, FieldUpdateTemplateFieldFieldMetaDateResponseTypedDict, FieldUpdateTemplateFieldFieldMetaDropdownResponseTypedDict, - FieldUpdateTemplateFieldFieldMetaCheckboxResponseTypedDict, FieldUpdateTemplateFieldFieldMetaTextResponseTypedDict, + FieldUpdateTemplateFieldFieldMetaCheckboxResponseTypedDict, FieldUpdateTemplateFieldFieldMetaNumberResponseTypedDict, ], ) @@ -1447,8 +1570,8 @@ class FieldUpdateTemplateFieldFieldMetaInitialsResponse(BaseModel): FieldUpdateTemplateFieldFieldMetaEmailResponse, FieldUpdateTemplateFieldFieldMetaDateResponse, FieldUpdateTemplateFieldFieldMetaDropdownResponse, - FieldUpdateTemplateFieldFieldMetaCheckboxResponse, FieldUpdateTemplateFieldFieldMetaTextResponse, + FieldUpdateTemplateFieldFieldMetaCheckboxResponse, FieldUpdateTemplateFieldFieldMetaNumberResponse, ], ) @@ -1457,11 +1580,11 @@ class FieldUpdateTemplateFieldFieldMetaInitialsResponse(BaseModel): class FieldUpdateTemplateFieldResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str + envelope_item_id: str type: FieldUpdateTemplateFieldTypeResponse id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -1472,21 +1595,23 @@ class FieldUpdateTemplateFieldResponseTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class FieldUpdateTemplateFieldResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: FieldUpdateTemplateFieldTypeResponse id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -1509,10 +1634,25 @@ class FieldUpdateTemplateFieldResponse(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/field_updatetemplatefieldsop.py b/src/documenso_sdk/models/field_updatetemplatefieldsop.py index a6581a8..d397232 100644 --- a/src/documenso_sdk/models/field_updatetemplatefieldsop.py +++ b/src/documenso_sdk/models/field_updatetemplatefieldsop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -119,6 +126,11 @@ class FieldUpdateTemplateFieldsValueCheckbox(BaseModel): value: str +class FieldUpdateTemplateFieldsDirectionRequest(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeCheckboxRequest2 label: NotRequired[str] @@ -128,6 +140,7 @@ class FieldUpdateTemplateFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): values: NotRequired[List[FieldUpdateTemplateFieldsValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateTemplateFieldsDirectionRequest] class FieldUpdateTemplateFieldsFieldMetaCheckboxRequest(BaseModel): @@ -151,6 +164,10 @@ class FieldUpdateTemplateFieldsFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateTemplateFieldsDirectionRequest] = ( + FieldUpdateTemplateFieldsDirectionRequest.VERTICAL + ) + class FieldUpdateTemplateFieldsFieldCheckboxTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeCheckboxRequest1 @@ -305,10 +322,10 @@ class FieldUpdateTemplateFieldsFieldMetaNumberRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldUpdateTemplateFieldsTextAlignNumber] @@ -324,13 +341,19 @@ class FieldUpdateTemplateFieldsFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -339,6 +362,47 @@ class FieldUpdateTemplateFieldsFieldMetaNumberRequest(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldUpdateTemplateFieldsFieldNumberTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeNumberRequest1 @@ -974,10 +1038,11 @@ class FieldUpdateTemplateFieldsInternalServerErrorData(BaseModel): issues: Optional[List[FieldUpdateTemplateFieldsInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class FieldUpdateTemplateFieldsInternalServerError(DocumensoError): r"""Internal server error""" - data: FieldUpdateTemplateFieldsInternalServerErrorData + data: FieldUpdateTemplateFieldsInternalServerErrorData = field(hash=False) def __init__( self, @@ -988,7 +1053,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldUpdateTemplateFieldsBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1072,11 @@ class FieldUpdateTemplateFieldsBadRequestErrorData(BaseModel): issues: Optional[List[FieldUpdateTemplateFieldsBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class FieldUpdateTemplateFieldsBadRequestError(DocumensoError): r"""Invalid input data""" - data: FieldUpdateTemplateFieldsBadRequestErrorData + data: FieldUpdateTemplateFieldsBadRequestErrorData = field(hash=False) def __init__( self, @@ -1021,7 +1087,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class FieldUpdateTemplateFieldsTypeResponse(str, Enum): @@ -1094,6 +1160,11 @@ class FieldUpdateTemplateFieldsValueResponse2(BaseModel): value: str +class FieldUpdateTemplateFieldsDirectionResponse(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldUpdateTemplateFieldsFieldMetaTypeCheckbox label: NotRequired[str] @@ -1103,6 +1174,7 @@ class FieldUpdateTemplateFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): values: NotRequired[List[FieldUpdateTemplateFieldsValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateTemplateFieldsDirectionResponse] class FieldUpdateTemplateFieldsFieldMetaCheckboxResponse(BaseModel): @@ -1126,6 +1198,10 @@ class FieldUpdateTemplateFieldsFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateTemplateFieldsDirectionResponse] = ( + FieldUpdateTemplateFieldsDirectionResponse.VERTICAL + ) + class FieldUpdateTemplateFieldsFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1184,10 +1260,10 @@ class FieldUpdateTemplateFieldsFieldMetaNumberResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[FieldUpdateTemplateFieldsTextAlignResponse6] @@ -1203,13 +1279,19 @@ class FieldUpdateTemplateFieldsFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -1218,6 +1300,47 @@ class FieldUpdateTemplateFieldsFieldMetaNumberResponse(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class FieldUpdateTemplateFieldsFieldMetaTypeText(str, Enum): TEXT = "text" @@ -1431,8 +1554,8 @@ class FieldUpdateTemplateFieldsFieldMetaInitialsResponse(BaseModel): FieldUpdateTemplateFieldsFieldMetaEmailResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaDateResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaDropdownResponseTypedDict, - FieldUpdateTemplateFieldsFieldMetaCheckboxResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaTextResponseTypedDict, + FieldUpdateTemplateFieldsFieldMetaCheckboxResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaNumberResponseTypedDict, ], ) @@ -1447,19 +1570,19 @@ class FieldUpdateTemplateFieldsFieldMetaInitialsResponse(BaseModel): FieldUpdateTemplateFieldsFieldMetaEmailResponse, FieldUpdateTemplateFieldsFieldMetaDateResponse, FieldUpdateTemplateFieldsFieldMetaDropdownResponse, - FieldUpdateTemplateFieldsFieldMetaCheckboxResponse, FieldUpdateTemplateFieldsFieldMetaTextResponse, + FieldUpdateTemplateFieldsFieldMetaCheckboxResponse, FieldUpdateTemplateFieldsFieldMetaNumberResponse, ], ) class FieldUpdateTemplateFieldsFieldResponseTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: FieldUpdateTemplateFieldsTypeResponse id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -1470,19 +1593,21 @@ class FieldUpdateTemplateFieldsFieldResponseTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class FieldUpdateTemplateFieldsFieldResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: FieldUpdateTemplateFieldsTypeResponse id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -1505,10 +1630,25 @@ class FieldUpdateTemplateFieldsFieldResponse(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/no_response_error.py b/src/documenso_sdk/models/no_response_error.py index f98beea..1deab64 100644 --- a/src/documenso_sdk/models/no_response_error.py +++ b/src/documenso_sdk/models/no_response_error.py @@ -1,12 +1,16 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" +from dataclasses import dataclass + + +@dataclass(unsafe_hash=True) class NoResponseError(Exception): """Error raised when no HTTP response is received from the server.""" message: str def __init__(self, message: str = "No response received"): - self.message = message + object.__setattr__(self, "message", message) super().__init__(message) def __str__(self): diff --git a/src/documenso_sdk/models/recipient_createdocumentrecipientop.py b/src/documenso_sdk/models/recipient_createdocumentrecipientop.py index d546702..88b75d5 100644 --- a/src/documenso_sdk/models/recipient_createdocumentrecipientop.py +++ b/src/documenso_sdk/models/recipient_createdocumentrecipientop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -23,6 +30,7 @@ class RecipientCreateDocumentRecipientAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientCreateDocumentRecipientActionAuthRequest(str, Enum): @@ -95,10 +103,11 @@ class RecipientCreateDocumentRecipientInternalServerErrorData(BaseModel): ) +@dataclass(unsafe_hash=True) class RecipientCreateDocumentRecipientInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientCreateDocumentRecipientInternalServerErrorData + data: RecipientCreateDocumentRecipientInternalServerErrorData = field(hash=False) def __init__( self, @@ -109,7 +118,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientCreateDocumentRecipientBadRequestIssueTypedDict(TypedDict): @@ -128,10 +137,11 @@ class RecipientCreateDocumentRecipientBadRequestErrorData(BaseModel): issues: Optional[List[RecipientCreateDocumentRecipientBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientCreateDocumentRecipientBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientCreateDocumentRecipientBadRequestErrorData + data: RecipientCreateDocumentRecipientBadRequestErrorData = field(hash=False) def __init__( self, @@ -142,7 +152,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientCreateDocumentRecipientRoleResponse(str, Enum): @@ -173,6 +183,7 @@ class RecipientCreateDocumentRecipientAccessAuthResponse(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientCreateDocumentRecipientActionAuthResponse(str, Enum): @@ -205,13 +216,12 @@ class RecipientCreateDocumentRecipientAuthOptions(BaseModel): class RecipientCreateDocumentRecipientResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str role: RecipientCreateDocumentRecipientRoleResponse read_status: RecipientCreateDocumentRecipientReadStatus signing_status: RecipientCreateDocumentRecipientSigningStatus send_status: RecipientCreateDocumentRecipientSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -222,11 +232,15 @@ class RecipientCreateDocumentRecipientResponseTypedDict(TypedDict): signing_order: Nullable[float] r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientCreateDocumentRecipientResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: RecipientCreateDocumentRecipientRoleResponse read_status: Annotated[ @@ -244,10 +258,6 @@ class RecipientCreateDocumentRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -272,18 +282,26 @@ class RecipientCreateDocumentRecipientResponse(BaseModel): rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/recipient_createdocumentrecipientsop.py b/src/documenso_sdk/models/recipient_createdocumentrecipientsop.py index 4b3793c..ae318e1 100644 --- a/src/documenso_sdk/models/recipient_createdocumentrecipientsop.py +++ b/src/documenso_sdk/models/recipient_createdocumentrecipientsop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -23,6 +30,7 @@ class RecipientCreateDocumentRecipientsAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientCreateDocumentRecipientsActionAuthRequest(str, Enum): @@ -95,10 +103,11 @@ class RecipientCreateDocumentRecipientsInternalServerErrorData(BaseModel): ] = None +@dataclass(unsafe_hash=True) class RecipientCreateDocumentRecipientsInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientCreateDocumentRecipientsInternalServerErrorData + data: RecipientCreateDocumentRecipientsInternalServerErrorData = field(hash=False) def __init__( self, @@ -109,7 +118,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientCreateDocumentRecipientsBadRequestIssueTypedDict(TypedDict): @@ -128,10 +137,11 @@ class RecipientCreateDocumentRecipientsBadRequestErrorData(BaseModel): issues: Optional[List[RecipientCreateDocumentRecipientsBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientCreateDocumentRecipientsBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientCreateDocumentRecipientsBadRequestErrorData + data: RecipientCreateDocumentRecipientsBadRequestErrorData = field(hash=False) def __init__( self, @@ -142,7 +152,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientCreateDocumentRecipientsRoleResponse(str, Enum): @@ -173,6 +183,7 @@ class RecipientCreateDocumentRecipientsAccessAuthResponse(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientCreateDocumentRecipientsActionAuthResponse(str, Enum): @@ -203,13 +214,12 @@ class RecipientCreateDocumentRecipientsAuthOptions(BaseModel): class RecipientCreateDocumentRecipientsRecipientResponseTypedDict(TypedDict): + envelope_id: str role: RecipientCreateDocumentRecipientsRoleResponse read_status: RecipientCreateDocumentRecipientsReadStatus signing_status: RecipientCreateDocumentRecipientsSigningStatus send_status: RecipientCreateDocumentRecipientsSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -220,9 +230,13 @@ class RecipientCreateDocumentRecipientsRecipientResponseTypedDict(TypedDict): signing_order: Nullable[float] r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientCreateDocumentRecipientsRecipientResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: RecipientCreateDocumentRecipientsRoleResponse read_status: Annotated[ @@ -240,10 +254,6 @@ class RecipientCreateDocumentRecipientsRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -268,18 +278,26 @@ class RecipientCreateDocumentRecipientsRecipientResponse(BaseModel): rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/recipient_createtemplaterecipientop.py b/src/documenso_sdk/models/recipient_createtemplaterecipientop.py index 12cba15..72cbeb6 100644 --- a/src/documenso_sdk/models/recipient_createtemplaterecipientop.py +++ b/src/documenso_sdk/models/recipient_createtemplaterecipientop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -23,6 +30,7 @@ class RecipientCreateTemplateRecipientAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientCreateTemplateRecipientActionAuthRequest(str, Enum): @@ -95,10 +103,11 @@ class RecipientCreateTemplateRecipientInternalServerErrorData(BaseModel): ) +@dataclass(unsafe_hash=True) class RecipientCreateTemplateRecipientInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientCreateTemplateRecipientInternalServerErrorData + data: RecipientCreateTemplateRecipientInternalServerErrorData = field(hash=False) def __init__( self, @@ -109,7 +118,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientCreateTemplateRecipientBadRequestIssueTypedDict(TypedDict): @@ -128,10 +137,11 @@ class RecipientCreateTemplateRecipientBadRequestErrorData(BaseModel): issues: Optional[List[RecipientCreateTemplateRecipientBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientCreateTemplateRecipientBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientCreateTemplateRecipientBadRequestErrorData + data: RecipientCreateTemplateRecipientBadRequestErrorData = field(hash=False) def __init__( self, @@ -142,7 +152,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientCreateTemplateRecipientRoleResponse(str, Enum): @@ -173,6 +183,7 @@ class RecipientCreateTemplateRecipientAccessAuthResponse(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientCreateTemplateRecipientActionAuthResponse(str, Enum): @@ -205,13 +216,12 @@ class RecipientCreateTemplateRecipientAuthOptions(BaseModel): class RecipientCreateTemplateRecipientResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str role: RecipientCreateTemplateRecipientRoleResponse read_status: RecipientCreateTemplateRecipientReadStatus signing_status: RecipientCreateTemplateRecipientSigningStatus send_status: RecipientCreateTemplateRecipientSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -222,11 +232,15 @@ class RecipientCreateTemplateRecipientResponseTypedDict(TypedDict): signing_order: Nullable[float] r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientCreateTemplateRecipientResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: RecipientCreateTemplateRecipientRoleResponse read_status: Annotated[ @@ -244,10 +258,6 @@ class RecipientCreateTemplateRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -272,18 +282,26 @@ class RecipientCreateTemplateRecipientResponse(BaseModel): rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/recipient_createtemplaterecipientsop.py b/src/documenso_sdk/models/recipient_createtemplaterecipientsop.py index 876927d..90fa77f 100644 --- a/src/documenso_sdk/models/recipient_createtemplaterecipientsop.py +++ b/src/documenso_sdk/models/recipient_createtemplaterecipientsop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -23,6 +30,7 @@ class RecipientCreateTemplateRecipientsAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientCreateTemplateRecipientsActionAuthRequest(str, Enum): @@ -95,10 +103,11 @@ class RecipientCreateTemplateRecipientsInternalServerErrorData(BaseModel): ] = None +@dataclass(unsafe_hash=True) class RecipientCreateTemplateRecipientsInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientCreateTemplateRecipientsInternalServerErrorData + data: RecipientCreateTemplateRecipientsInternalServerErrorData = field(hash=False) def __init__( self, @@ -109,7 +118,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientCreateTemplateRecipientsBadRequestIssueTypedDict(TypedDict): @@ -128,10 +137,11 @@ class RecipientCreateTemplateRecipientsBadRequestErrorData(BaseModel): issues: Optional[List[RecipientCreateTemplateRecipientsBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientCreateTemplateRecipientsBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientCreateTemplateRecipientsBadRequestErrorData + data: RecipientCreateTemplateRecipientsBadRequestErrorData = field(hash=False) def __init__( self, @@ -142,7 +152,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientCreateTemplateRecipientsRoleResponse(str, Enum): @@ -173,6 +183,7 @@ class RecipientCreateTemplateRecipientsAccessAuthResponse(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientCreateTemplateRecipientsActionAuthResponse(str, Enum): @@ -203,13 +214,12 @@ class RecipientCreateTemplateRecipientsAuthOptions(BaseModel): class RecipientCreateTemplateRecipientsRecipientResponseTypedDict(TypedDict): + envelope_id: str role: RecipientCreateTemplateRecipientsRoleResponse read_status: RecipientCreateTemplateRecipientsReadStatus signing_status: RecipientCreateTemplateRecipientsSigningStatus send_status: RecipientCreateTemplateRecipientsSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -220,9 +230,13 @@ class RecipientCreateTemplateRecipientsRecipientResponseTypedDict(TypedDict): signing_order: Nullable[float] r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientCreateTemplateRecipientsRecipientResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: RecipientCreateTemplateRecipientsRoleResponse read_status: Annotated[ @@ -240,10 +254,6 @@ class RecipientCreateTemplateRecipientsRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -268,18 +278,26 @@ class RecipientCreateTemplateRecipientsRecipientResponse(BaseModel): rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/recipient_deletedocumentrecipientop.py b/src/documenso_sdk/models/recipient_deletedocumentrecipientop.py index 0afc02e..3efd427 100644 --- a/src/documenso_sdk/models/recipient_deletedocumentrecipientop.py +++ b/src/documenso_sdk/models/recipient_deletedocumentrecipientop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -35,10 +36,11 @@ class RecipientDeleteDocumentRecipientInternalServerErrorData(BaseModel): ) +@dataclass(unsafe_hash=True) class RecipientDeleteDocumentRecipientInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientDeleteDocumentRecipientInternalServerErrorData + data: RecipientDeleteDocumentRecipientInternalServerErrorData = field(hash=False) def __init__( self, @@ -49,7 +51,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientDeleteDocumentRecipientBadRequestIssueTypedDict(TypedDict): @@ -68,10 +70,11 @@ class RecipientDeleteDocumentRecipientBadRequestErrorData(BaseModel): issues: Optional[List[RecipientDeleteDocumentRecipientBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientDeleteDocumentRecipientBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientDeleteDocumentRecipientBadRequestErrorData + data: RecipientDeleteDocumentRecipientBadRequestErrorData = field(hash=False) def __init__( self, @@ -82,7 +85,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientDeleteDocumentRecipientResponseTypedDict(TypedDict): diff --git a/src/documenso_sdk/models/recipient_deletetemplaterecipientop.py b/src/documenso_sdk/models/recipient_deletetemplaterecipientop.py index 4e4c4a8..17fa6b4 100644 --- a/src/documenso_sdk/models/recipient_deletetemplaterecipientop.py +++ b/src/documenso_sdk/models/recipient_deletetemplaterecipientop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -35,10 +36,11 @@ class RecipientDeleteTemplateRecipientInternalServerErrorData(BaseModel): ) +@dataclass(unsafe_hash=True) class RecipientDeleteTemplateRecipientInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientDeleteTemplateRecipientInternalServerErrorData + data: RecipientDeleteTemplateRecipientInternalServerErrorData = field(hash=False) def __init__( self, @@ -49,7 +51,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientDeleteTemplateRecipientBadRequestIssueTypedDict(TypedDict): @@ -68,10 +70,11 @@ class RecipientDeleteTemplateRecipientBadRequestErrorData(BaseModel): issues: Optional[List[RecipientDeleteTemplateRecipientBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientDeleteTemplateRecipientBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientDeleteTemplateRecipientBadRequestErrorData + data: RecipientDeleteTemplateRecipientBadRequestErrorData = field(hash=False) def __init__( self, @@ -82,7 +85,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientDeleteTemplateRecipientResponseTypedDict(TypedDict): diff --git a/src/documenso_sdk/models/recipient_getdocumentrecipientop.py b/src/documenso_sdk/models/recipient_getdocumentrecipientop.py index a857e7d..c9edef7 100644 --- a/src/documenso_sdk/models/recipient_getdocumentrecipientop.py +++ b/src/documenso_sdk/models/recipient_getdocumentrecipientop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from documenso_sdk.utils import FieldMetadata, PathParamMetadata from enum import Enum import httpx @@ -40,10 +47,11 @@ class RecipientGetDocumentRecipientInternalServerErrorData(BaseModel): issues: Optional[List[RecipientGetDocumentRecipientInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class RecipientGetDocumentRecipientInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientGetDocumentRecipientInternalServerErrorData + data: RecipientGetDocumentRecipientInternalServerErrorData = field(hash=False) def __init__( self, @@ -54,7 +62,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientGetDocumentRecipientNotFoundIssueTypedDict(TypedDict): @@ -73,10 +81,11 @@ class RecipientGetDocumentRecipientNotFoundErrorData(BaseModel): issues: Optional[List[RecipientGetDocumentRecipientNotFoundIssue]] = None +@dataclass(unsafe_hash=True) class RecipientGetDocumentRecipientNotFoundError(DocumensoError): r"""Not found""" - data: RecipientGetDocumentRecipientNotFoundErrorData + data: RecipientGetDocumentRecipientNotFoundErrorData = field(hash=False) def __init__( self, @@ -87,7 +96,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientGetDocumentRecipientBadRequestIssueTypedDict(TypedDict): @@ -106,10 +115,11 @@ class RecipientGetDocumentRecipientBadRequestErrorData(BaseModel): issues: Optional[List[RecipientGetDocumentRecipientBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientGetDocumentRecipientBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientGetDocumentRecipientBadRequestErrorData + data: RecipientGetDocumentRecipientBadRequestErrorData = field(hash=False) def __init__( self, @@ -120,7 +130,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientGetDocumentRecipientRole(str, Enum): @@ -151,6 +161,7 @@ class RecipientGetDocumentRecipientAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientGetDocumentRecipientActionAuth(str, Enum): @@ -250,6 +261,11 @@ class RecipientGetDocumentRecipientValue2(BaseModel): value: str +class RecipientGetDocumentRecipientDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict(TypedDict): type: RecipientGetDocumentRecipientTypeCheckbox label: NotRequired[str] @@ -259,6 +275,7 @@ class RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[RecipientGetDocumentRecipientValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientGetDocumentRecipientDirection] class RecipientGetDocumentRecipientFieldMetaCheckbox(BaseModel): @@ -282,6 +299,10 @@ class RecipientGetDocumentRecipientFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientGetDocumentRecipientDirection] = ( + RecipientGetDocumentRecipientDirection.VERTICAL + ) + class RecipientGetDocumentRecipientTypeRadio(str, Enum): RADIO = "radio" @@ -340,10 +361,10 @@ class RecipientGetDocumentRecipientFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[RecipientGetDocumentRecipientTextAlign6] @@ -359,13 +380,19 @@ class RecipientGetDocumentRecipientFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -374,6 +401,47 @@ class RecipientGetDocumentRecipientFieldMetaNumber(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class RecipientGetDocumentRecipientTypeText(str, Enum): TEXT = "text" @@ -587,8 +655,8 @@ class RecipientGetDocumentRecipientFieldMetaInitials(BaseModel): RecipientGetDocumentRecipientFieldMetaEmailTypedDict, RecipientGetDocumentRecipientFieldMetaDateTypedDict, RecipientGetDocumentRecipientFieldMetaDropdownTypedDict, - RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict, RecipientGetDocumentRecipientFieldMetaTextTypedDict, + RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict, RecipientGetDocumentRecipientFieldMetaNumberTypedDict, ], ) @@ -603,19 +671,19 @@ class RecipientGetDocumentRecipientFieldMetaInitials(BaseModel): RecipientGetDocumentRecipientFieldMetaEmail, RecipientGetDocumentRecipientFieldMetaDate, RecipientGetDocumentRecipientFieldMetaDropdown, - RecipientGetDocumentRecipientFieldMetaCheckbox, RecipientGetDocumentRecipientFieldMetaText, + RecipientGetDocumentRecipientFieldMetaCheckbox, RecipientGetDocumentRecipientFieldMetaNumber, ], ) class RecipientGetDocumentRecipientFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: RecipientGetDocumentRecipientType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -626,19 +694,21 @@ class RecipientGetDocumentRecipientFieldTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientGetDocumentRecipientField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: RecipientGetDocumentRecipientType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -661,10 +731,25 @@ class RecipientGetDocumentRecipientField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -695,13 +780,12 @@ def serialize_model(self, handler): class RecipientGetDocumentRecipientResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str role: RecipientGetDocumentRecipientRole read_status: RecipientGetDocumentRecipientReadStatus signing_status: RecipientGetDocumentRecipientSigningStatus send_status: RecipientGetDocumentRecipientSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -713,11 +797,15 @@ class RecipientGetDocumentRecipientResponseTypedDict(TypedDict): r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] fields: List[RecipientGetDocumentRecipientFieldTypedDict] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientGetDocumentRecipientResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: RecipientGetDocumentRecipientRole read_status: Annotated[ @@ -735,10 +823,6 @@ class RecipientGetDocumentRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -765,18 +849,26 @@ class RecipientGetDocumentRecipientResponse(BaseModel): fields: List[RecipientGetDocumentRecipientField] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/recipient_gettemplaterecipientop.py b/src/documenso_sdk/models/recipient_gettemplaterecipientop.py index 5b006ec..99a7ec5 100644 --- a/src/documenso_sdk/models/recipient_gettemplaterecipientop.py +++ b/src/documenso_sdk/models/recipient_gettemplaterecipientop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from documenso_sdk.utils import FieldMetadata, PathParamMetadata from enum import Enum import httpx @@ -40,10 +47,11 @@ class RecipientGetTemplateRecipientInternalServerErrorData(BaseModel): issues: Optional[List[RecipientGetTemplateRecipientInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class RecipientGetTemplateRecipientInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientGetTemplateRecipientInternalServerErrorData + data: RecipientGetTemplateRecipientInternalServerErrorData = field(hash=False) def __init__( self, @@ -54,7 +62,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientGetTemplateRecipientNotFoundIssueTypedDict(TypedDict): @@ -73,10 +81,11 @@ class RecipientGetTemplateRecipientNotFoundErrorData(BaseModel): issues: Optional[List[RecipientGetTemplateRecipientNotFoundIssue]] = None +@dataclass(unsafe_hash=True) class RecipientGetTemplateRecipientNotFoundError(DocumensoError): r"""Not found""" - data: RecipientGetTemplateRecipientNotFoundErrorData + data: RecipientGetTemplateRecipientNotFoundErrorData = field(hash=False) def __init__( self, @@ -87,7 +96,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientGetTemplateRecipientBadRequestIssueTypedDict(TypedDict): @@ -106,10 +115,11 @@ class RecipientGetTemplateRecipientBadRequestErrorData(BaseModel): issues: Optional[List[RecipientGetTemplateRecipientBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientGetTemplateRecipientBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientGetTemplateRecipientBadRequestErrorData + data: RecipientGetTemplateRecipientBadRequestErrorData = field(hash=False) def __init__( self, @@ -120,7 +130,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientGetTemplateRecipientRole(str, Enum): @@ -151,6 +161,7 @@ class RecipientGetTemplateRecipientAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientGetTemplateRecipientActionAuth(str, Enum): @@ -250,6 +261,11 @@ class RecipientGetTemplateRecipientValue2(BaseModel): value: str +class RecipientGetTemplateRecipientDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict(TypedDict): type: RecipientGetTemplateRecipientTypeCheckbox label: NotRequired[str] @@ -259,6 +275,7 @@ class RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[RecipientGetTemplateRecipientValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientGetTemplateRecipientDirection] class RecipientGetTemplateRecipientFieldMetaCheckbox(BaseModel): @@ -282,6 +299,10 @@ class RecipientGetTemplateRecipientFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientGetTemplateRecipientDirection] = ( + RecipientGetTemplateRecipientDirection.VERTICAL + ) + class RecipientGetTemplateRecipientTypeRadio(str, Enum): RADIO = "radio" @@ -340,10 +361,10 @@ class RecipientGetTemplateRecipientFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[RecipientGetTemplateRecipientTextAlign6] @@ -359,13 +380,19 @@ class RecipientGetTemplateRecipientFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -374,6 +401,47 @@ class RecipientGetTemplateRecipientFieldMetaNumber(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class RecipientGetTemplateRecipientTypeText(str, Enum): TEXT = "text" @@ -587,8 +655,8 @@ class RecipientGetTemplateRecipientFieldMetaInitials(BaseModel): RecipientGetTemplateRecipientFieldMetaEmailTypedDict, RecipientGetTemplateRecipientFieldMetaDateTypedDict, RecipientGetTemplateRecipientFieldMetaDropdownTypedDict, - RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict, RecipientGetTemplateRecipientFieldMetaTextTypedDict, + RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict, RecipientGetTemplateRecipientFieldMetaNumberTypedDict, ], ) @@ -603,19 +671,19 @@ class RecipientGetTemplateRecipientFieldMetaInitials(BaseModel): RecipientGetTemplateRecipientFieldMetaEmail, RecipientGetTemplateRecipientFieldMetaDate, RecipientGetTemplateRecipientFieldMetaDropdown, - RecipientGetTemplateRecipientFieldMetaCheckbox, RecipientGetTemplateRecipientFieldMetaText, + RecipientGetTemplateRecipientFieldMetaCheckbox, RecipientGetTemplateRecipientFieldMetaNumber, ], ) class RecipientGetTemplateRecipientFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: RecipientGetTemplateRecipientType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -626,19 +694,21 @@ class RecipientGetTemplateRecipientFieldTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientGetTemplateRecipientField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: RecipientGetTemplateRecipientType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -661,10 +731,25 @@ class RecipientGetTemplateRecipientField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -695,13 +780,12 @@ def serialize_model(self, handler): class RecipientGetTemplateRecipientResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str role: RecipientGetTemplateRecipientRole read_status: RecipientGetTemplateRecipientReadStatus signing_status: RecipientGetTemplateRecipientSigningStatus send_status: RecipientGetTemplateRecipientSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -713,11 +797,15 @@ class RecipientGetTemplateRecipientResponseTypedDict(TypedDict): r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] fields: List[RecipientGetTemplateRecipientFieldTypedDict] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientGetTemplateRecipientResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: RecipientGetTemplateRecipientRole read_status: Annotated[ @@ -735,10 +823,6 @@ class RecipientGetTemplateRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -765,18 +849,26 @@ class RecipientGetTemplateRecipientResponse(BaseModel): fields: List[RecipientGetTemplateRecipientField] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/recipient_updatedocumentrecipientop.py b/src/documenso_sdk/models/recipient_updatedocumentrecipientop.py index 5f60568..6f89a4e 100644 --- a/src/documenso_sdk/models/recipient_updatedocumentrecipientop.py +++ b/src/documenso_sdk/models/recipient_updatedocumentrecipientop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -23,6 +30,7 @@ class RecipientUpdateDocumentRecipientAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientUpdateDocumentRecipientActionAuthRequest(str, Enum): @@ -100,10 +108,11 @@ class RecipientUpdateDocumentRecipientInternalServerErrorData(BaseModel): ) +@dataclass(unsafe_hash=True) class RecipientUpdateDocumentRecipientInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientUpdateDocumentRecipientInternalServerErrorData + data: RecipientUpdateDocumentRecipientInternalServerErrorData = field(hash=False) def __init__( self, @@ -114,7 +123,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientUpdateDocumentRecipientBadRequestIssueTypedDict(TypedDict): @@ -133,10 +142,11 @@ class RecipientUpdateDocumentRecipientBadRequestErrorData(BaseModel): issues: Optional[List[RecipientUpdateDocumentRecipientBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientUpdateDocumentRecipientBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientUpdateDocumentRecipientBadRequestErrorData + data: RecipientUpdateDocumentRecipientBadRequestErrorData = field(hash=False) def __init__( self, @@ -147,7 +157,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientUpdateDocumentRecipientRoleResponse(str, Enum): @@ -178,6 +188,7 @@ class RecipientUpdateDocumentRecipientAccessAuthResponse(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientUpdateDocumentRecipientActionAuthResponse(str, Enum): @@ -277,6 +288,11 @@ class RecipientUpdateDocumentRecipientValue2(BaseModel): value: str +class RecipientUpdateDocumentRecipientDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict(TypedDict): type: RecipientUpdateDocumentRecipientTypeCheckbox label: NotRequired[str] @@ -286,6 +302,7 @@ class RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[RecipientUpdateDocumentRecipientValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientUpdateDocumentRecipientDirection] class RecipientUpdateDocumentRecipientFieldMetaCheckbox(BaseModel): @@ -309,6 +326,10 @@ class RecipientUpdateDocumentRecipientFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientUpdateDocumentRecipientDirection] = ( + RecipientUpdateDocumentRecipientDirection.VERTICAL + ) + class RecipientUpdateDocumentRecipientTypeRadio(str, Enum): RADIO = "radio" @@ -367,10 +388,10 @@ class RecipientUpdateDocumentRecipientFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[RecipientUpdateDocumentRecipientTextAlign6] @@ -386,13 +407,19 @@ class RecipientUpdateDocumentRecipientFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -401,6 +428,47 @@ class RecipientUpdateDocumentRecipientFieldMetaNumber(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class RecipientUpdateDocumentRecipientTypeText(str, Enum): TEXT = "text" @@ -614,8 +682,8 @@ class RecipientUpdateDocumentRecipientFieldMetaInitials(BaseModel): RecipientUpdateDocumentRecipientFieldMetaEmailTypedDict, RecipientUpdateDocumentRecipientFieldMetaDateTypedDict, RecipientUpdateDocumentRecipientFieldMetaDropdownTypedDict, - RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict, RecipientUpdateDocumentRecipientFieldMetaTextTypedDict, + RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict, RecipientUpdateDocumentRecipientFieldMetaNumberTypedDict, ], ) @@ -630,19 +698,19 @@ class RecipientUpdateDocumentRecipientFieldMetaInitials(BaseModel): RecipientUpdateDocumentRecipientFieldMetaEmail, RecipientUpdateDocumentRecipientFieldMetaDate, RecipientUpdateDocumentRecipientFieldMetaDropdown, - RecipientUpdateDocumentRecipientFieldMetaCheckbox, RecipientUpdateDocumentRecipientFieldMetaText, + RecipientUpdateDocumentRecipientFieldMetaCheckbox, RecipientUpdateDocumentRecipientFieldMetaNumber, ], ) class RecipientUpdateDocumentRecipientFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: RecipientUpdateDocumentRecipientType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -653,19 +721,21 @@ class RecipientUpdateDocumentRecipientFieldTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientUpdateDocumentRecipientField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: RecipientUpdateDocumentRecipientType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -688,10 +758,25 @@ class RecipientUpdateDocumentRecipientField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -722,13 +807,12 @@ def serialize_model(self, handler): class RecipientUpdateDocumentRecipientResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str role: RecipientUpdateDocumentRecipientRoleResponse read_status: RecipientUpdateDocumentRecipientReadStatus signing_status: RecipientUpdateDocumentRecipientSigningStatus send_status: RecipientUpdateDocumentRecipientSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -740,11 +824,15 @@ class RecipientUpdateDocumentRecipientResponseTypedDict(TypedDict): r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] fields: List[RecipientUpdateDocumentRecipientFieldTypedDict] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientUpdateDocumentRecipientResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: RecipientUpdateDocumentRecipientRoleResponse read_status: Annotated[ @@ -762,10 +850,6 @@ class RecipientUpdateDocumentRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -792,18 +876,26 @@ class RecipientUpdateDocumentRecipientResponse(BaseModel): fields: List[RecipientUpdateDocumentRecipientField] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/recipient_updatedocumentrecipientsop.py b/src/documenso_sdk/models/recipient_updatedocumentrecipientsop.py index 9edc6dc..655262e 100644 --- a/src/documenso_sdk/models/recipient_updatedocumentrecipientsop.py +++ b/src/documenso_sdk/models/recipient_updatedocumentrecipientsop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -23,6 +30,7 @@ class RecipientUpdateDocumentRecipientsAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientUpdateDocumentRecipientsActionAuthRequest(str, Enum): @@ -100,10 +108,11 @@ class RecipientUpdateDocumentRecipientsInternalServerErrorData(BaseModel): ] = None +@dataclass(unsafe_hash=True) class RecipientUpdateDocumentRecipientsInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientUpdateDocumentRecipientsInternalServerErrorData + data: RecipientUpdateDocumentRecipientsInternalServerErrorData = field(hash=False) def __init__( self, @@ -114,7 +123,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientUpdateDocumentRecipientsBadRequestIssueTypedDict(TypedDict): @@ -133,10 +142,11 @@ class RecipientUpdateDocumentRecipientsBadRequestErrorData(BaseModel): issues: Optional[List[RecipientUpdateDocumentRecipientsBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientUpdateDocumentRecipientsBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientUpdateDocumentRecipientsBadRequestErrorData + data: RecipientUpdateDocumentRecipientsBadRequestErrorData = field(hash=False) def __init__( self, @@ -147,7 +157,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientUpdateDocumentRecipientsRoleResponse(str, Enum): @@ -178,6 +188,7 @@ class RecipientUpdateDocumentRecipientsAccessAuthResponse(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientUpdateDocumentRecipientsActionAuthResponse(str, Enum): @@ -277,6 +288,11 @@ class RecipientUpdateDocumentRecipientsValue2(BaseModel): value: str +class RecipientUpdateDocumentRecipientsDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict(TypedDict): type: RecipientUpdateDocumentRecipientsTypeCheckbox label: NotRequired[str] @@ -286,6 +302,7 @@ class RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[RecipientUpdateDocumentRecipientsValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientUpdateDocumentRecipientsDirection] class RecipientUpdateDocumentRecipientsFieldMetaCheckbox(BaseModel): @@ -309,6 +326,10 @@ class RecipientUpdateDocumentRecipientsFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientUpdateDocumentRecipientsDirection] = ( + RecipientUpdateDocumentRecipientsDirection.VERTICAL + ) + class RecipientUpdateDocumentRecipientsTypeRadio(str, Enum): RADIO = "radio" @@ -367,10 +388,10 @@ class RecipientUpdateDocumentRecipientsFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[RecipientUpdateDocumentRecipientsTextAlign6] @@ -386,13 +407,19 @@ class RecipientUpdateDocumentRecipientsFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -401,6 +428,47 @@ class RecipientUpdateDocumentRecipientsFieldMetaNumber(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class RecipientUpdateDocumentRecipientsTypeText(str, Enum): TEXT = "text" @@ -614,8 +682,8 @@ class RecipientUpdateDocumentRecipientsFieldMetaInitials(BaseModel): RecipientUpdateDocumentRecipientsFieldMetaEmailTypedDict, RecipientUpdateDocumentRecipientsFieldMetaDateTypedDict, RecipientUpdateDocumentRecipientsFieldMetaDropdownTypedDict, - RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict, RecipientUpdateDocumentRecipientsFieldMetaTextTypedDict, + RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict, RecipientUpdateDocumentRecipientsFieldMetaNumberTypedDict, ], ) @@ -630,19 +698,19 @@ class RecipientUpdateDocumentRecipientsFieldMetaInitials(BaseModel): RecipientUpdateDocumentRecipientsFieldMetaEmail, RecipientUpdateDocumentRecipientsFieldMetaDate, RecipientUpdateDocumentRecipientsFieldMetaDropdown, - RecipientUpdateDocumentRecipientsFieldMetaCheckbox, RecipientUpdateDocumentRecipientsFieldMetaText, + RecipientUpdateDocumentRecipientsFieldMetaCheckbox, RecipientUpdateDocumentRecipientsFieldMetaNumber, ], ) class RecipientUpdateDocumentRecipientsFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: RecipientUpdateDocumentRecipientsType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -653,19 +721,21 @@ class RecipientUpdateDocumentRecipientsFieldTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientUpdateDocumentRecipientsField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: RecipientUpdateDocumentRecipientsType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -688,10 +758,25 @@ class RecipientUpdateDocumentRecipientsField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -720,13 +805,12 @@ def serialize_model(self, handler): class RecipientUpdateDocumentRecipientsRecipientResponseTypedDict(TypedDict): + envelope_id: str role: RecipientUpdateDocumentRecipientsRoleResponse read_status: RecipientUpdateDocumentRecipientsReadStatus signing_status: RecipientUpdateDocumentRecipientsSigningStatus send_status: RecipientUpdateDocumentRecipientsSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -738,9 +822,13 @@ class RecipientUpdateDocumentRecipientsRecipientResponseTypedDict(TypedDict): r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] fields: List[RecipientUpdateDocumentRecipientsFieldTypedDict] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientUpdateDocumentRecipientsRecipientResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: RecipientUpdateDocumentRecipientsRoleResponse read_status: Annotated[ @@ -758,10 +846,6 @@ class RecipientUpdateDocumentRecipientsRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -788,18 +872,26 @@ class RecipientUpdateDocumentRecipientsRecipientResponse(BaseModel): fields: List[RecipientUpdateDocumentRecipientsField] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/recipient_updatetemplaterecipientop.py b/src/documenso_sdk/models/recipient_updatetemplaterecipientop.py index d7c2b4c..a7d3a81 100644 --- a/src/documenso_sdk/models/recipient_updatetemplaterecipientop.py +++ b/src/documenso_sdk/models/recipient_updatetemplaterecipientop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -23,6 +30,7 @@ class RecipientUpdateTemplateRecipientAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientUpdateTemplateRecipientActionAuthRequest(str, Enum): @@ -100,10 +108,11 @@ class RecipientUpdateTemplateRecipientInternalServerErrorData(BaseModel): ) +@dataclass(unsafe_hash=True) class RecipientUpdateTemplateRecipientInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientUpdateTemplateRecipientInternalServerErrorData + data: RecipientUpdateTemplateRecipientInternalServerErrorData = field(hash=False) def __init__( self, @@ -114,7 +123,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientUpdateTemplateRecipientBadRequestIssueTypedDict(TypedDict): @@ -133,10 +142,11 @@ class RecipientUpdateTemplateRecipientBadRequestErrorData(BaseModel): issues: Optional[List[RecipientUpdateTemplateRecipientBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientUpdateTemplateRecipientBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientUpdateTemplateRecipientBadRequestErrorData + data: RecipientUpdateTemplateRecipientBadRequestErrorData = field(hash=False) def __init__( self, @@ -147,7 +157,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientUpdateTemplateRecipientRoleResponse(str, Enum): @@ -178,6 +188,7 @@ class RecipientUpdateTemplateRecipientAccessAuthResponse(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientUpdateTemplateRecipientActionAuthResponse(str, Enum): @@ -277,6 +288,11 @@ class RecipientUpdateTemplateRecipientValue2(BaseModel): value: str +class RecipientUpdateTemplateRecipientDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict(TypedDict): type: RecipientUpdateTemplateRecipientTypeCheckbox label: NotRequired[str] @@ -286,6 +302,7 @@ class RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[RecipientUpdateTemplateRecipientValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientUpdateTemplateRecipientDirection] class RecipientUpdateTemplateRecipientFieldMetaCheckbox(BaseModel): @@ -309,6 +326,10 @@ class RecipientUpdateTemplateRecipientFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientUpdateTemplateRecipientDirection] = ( + RecipientUpdateTemplateRecipientDirection.VERTICAL + ) + class RecipientUpdateTemplateRecipientTypeRadio(str, Enum): RADIO = "radio" @@ -367,10 +388,10 @@ class RecipientUpdateTemplateRecipientFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[RecipientUpdateTemplateRecipientTextAlign6] @@ -386,13 +407,19 @@ class RecipientUpdateTemplateRecipientFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -401,6 +428,47 @@ class RecipientUpdateTemplateRecipientFieldMetaNumber(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class RecipientUpdateTemplateRecipientTypeText(str, Enum): TEXT = "text" @@ -614,8 +682,8 @@ class RecipientUpdateTemplateRecipientFieldMetaInitials(BaseModel): RecipientUpdateTemplateRecipientFieldMetaEmailTypedDict, RecipientUpdateTemplateRecipientFieldMetaDateTypedDict, RecipientUpdateTemplateRecipientFieldMetaDropdownTypedDict, - RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict, RecipientUpdateTemplateRecipientFieldMetaTextTypedDict, + RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict, RecipientUpdateTemplateRecipientFieldMetaNumberTypedDict, ], ) @@ -630,19 +698,19 @@ class RecipientUpdateTemplateRecipientFieldMetaInitials(BaseModel): RecipientUpdateTemplateRecipientFieldMetaEmail, RecipientUpdateTemplateRecipientFieldMetaDate, RecipientUpdateTemplateRecipientFieldMetaDropdown, - RecipientUpdateTemplateRecipientFieldMetaCheckbox, RecipientUpdateTemplateRecipientFieldMetaText, + RecipientUpdateTemplateRecipientFieldMetaCheckbox, RecipientUpdateTemplateRecipientFieldMetaNumber, ], ) class RecipientUpdateTemplateRecipientFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: RecipientUpdateTemplateRecipientType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -653,19 +721,21 @@ class RecipientUpdateTemplateRecipientFieldTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientUpdateTemplateRecipientField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: RecipientUpdateTemplateRecipientType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -688,10 +758,25 @@ class RecipientUpdateTemplateRecipientField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -722,13 +807,12 @@ def serialize_model(self, handler): class RecipientUpdateTemplateRecipientResponseTypedDict(TypedDict): r"""Successful response""" + envelope_id: str role: RecipientUpdateTemplateRecipientRoleResponse read_status: RecipientUpdateTemplateRecipientReadStatus signing_status: RecipientUpdateTemplateRecipientSigningStatus send_status: RecipientUpdateTemplateRecipientSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -740,11 +824,15 @@ class RecipientUpdateTemplateRecipientResponseTypedDict(TypedDict): r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] fields: List[RecipientUpdateTemplateRecipientFieldTypedDict] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientUpdateTemplateRecipientResponse(BaseModel): r"""Successful response""" + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: RecipientUpdateTemplateRecipientRoleResponse read_status: Annotated[ @@ -762,10 +850,6 @@ class RecipientUpdateTemplateRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -792,18 +876,26 @@ class RecipientUpdateTemplateRecipientResponse(BaseModel): fields: List[RecipientUpdateTemplateRecipientField] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/recipient_updatetemplaterecipientsop.py b/src/documenso_sdk/models/recipient_updatetemplaterecipientsop.py index 2f24d5b..9f9ccb4 100644 --- a/src/documenso_sdk/models/recipient_updatetemplaterecipientsop.py +++ b/src/documenso_sdk/models/recipient_updatetemplaterecipientsop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -23,6 +30,7 @@ class RecipientUpdateTemplateRecipientsAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientUpdateTemplateRecipientsActionAuthRequest(str, Enum): @@ -100,10 +108,11 @@ class RecipientUpdateTemplateRecipientsInternalServerErrorData(BaseModel): ] = None +@dataclass(unsafe_hash=True) class RecipientUpdateTemplateRecipientsInternalServerError(DocumensoError): r"""Internal server error""" - data: RecipientUpdateTemplateRecipientsInternalServerErrorData + data: RecipientUpdateTemplateRecipientsInternalServerErrorData = field(hash=False) def __init__( self, @@ -114,7 +123,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientUpdateTemplateRecipientsBadRequestIssueTypedDict(TypedDict): @@ -133,10 +142,11 @@ class RecipientUpdateTemplateRecipientsBadRequestErrorData(BaseModel): issues: Optional[List[RecipientUpdateTemplateRecipientsBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class RecipientUpdateTemplateRecipientsBadRequestError(DocumensoError): r"""Invalid input data""" - data: RecipientUpdateTemplateRecipientsBadRequestErrorData + data: RecipientUpdateTemplateRecipientsBadRequestErrorData = field(hash=False) def __init__( self, @@ -147,7 +157,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class RecipientUpdateTemplateRecipientsRoleResponse(str, Enum): @@ -178,6 +188,7 @@ class RecipientUpdateTemplateRecipientsAccessAuthResponse(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class RecipientUpdateTemplateRecipientsActionAuthResponse(str, Enum): @@ -277,6 +288,11 @@ class RecipientUpdateTemplateRecipientsValue2(BaseModel): value: str +class RecipientUpdateTemplateRecipientsDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict(TypedDict): type: RecipientUpdateTemplateRecipientsTypeCheckbox label: NotRequired[str] @@ -286,6 +302,7 @@ class RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[RecipientUpdateTemplateRecipientsValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientUpdateTemplateRecipientsDirection] class RecipientUpdateTemplateRecipientsFieldMetaCheckbox(BaseModel): @@ -309,6 +326,10 @@ class RecipientUpdateTemplateRecipientsFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientUpdateTemplateRecipientsDirection] = ( + RecipientUpdateTemplateRecipientsDirection.VERTICAL + ) + class RecipientUpdateTemplateRecipientsTypeRadio(str, Enum): RADIO = "radio" @@ -367,10 +388,10 @@ class RecipientUpdateTemplateRecipientsFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[RecipientUpdateTemplateRecipientsTextAlign6] @@ -386,13 +407,19 @@ class RecipientUpdateTemplateRecipientsFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -401,6 +428,47 @@ class RecipientUpdateTemplateRecipientsFieldMetaNumber(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class RecipientUpdateTemplateRecipientsTypeText(str, Enum): TEXT = "text" @@ -614,8 +682,8 @@ class RecipientUpdateTemplateRecipientsFieldMetaInitials(BaseModel): RecipientUpdateTemplateRecipientsFieldMetaEmailTypedDict, RecipientUpdateTemplateRecipientsFieldMetaDateTypedDict, RecipientUpdateTemplateRecipientsFieldMetaDropdownTypedDict, - RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict, RecipientUpdateTemplateRecipientsFieldMetaTextTypedDict, + RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict, RecipientUpdateTemplateRecipientsFieldMetaNumberTypedDict, ], ) @@ -630,19 +698,19 @@ class RecipientUpdateTemplateRecipientsFieldMetaInitials(BaseModel): RecipientUpdateTemplateRecipientsFieldMetaEmail, RecipientUpdateTemplateRecipientsFieldMetaDate, RecipientUpdateTemplateRecipientsFieldMetaDropdown, - RecipientUpdateTemplateRecipientsFieldMetaCheckbox, RecipientUpdateTemplateRecipientsFieldMetaText, + RecipientUpdateTemplateRecipientsFieldMetaCheckbox, RecipientUpdateTemplateRecipientsFieldMetaNumber, ], ) class RecipientUpdateTemplateRecipientsFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: RecipientUpdateTemplateRecipientsType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -653,19 +721,21 @@ class RecipientUpdateTemplateRecipientsFieldTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientUpdateTemplateRecipientsField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: RecipientUpdateTemplateRecipientsType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -688,10 +758,25 @@ class RecipientUpdateTemplateRecipientsField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -720,13 +805,12 @@ def serialize_model(self, handler): class RecipientUpdateTemplateRecipientsRecipientResponseTypedDict(TypedDict): + envelope_id: str role: RecipientUpdateTemplateRecipientsRoleResponse read_status: RecipientUpdateTemplateRecipientsReadStatus signing_status: RecipientUpdateTemplateRecipientsSigningStatus send_status: RecipientUpdateTemplateRecipientsSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -738,9 +822,13 @@ class RecipientUpdateTemplateRecipientsRecipientResponseTypedDict(TypedDict): r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] fields: List[RecipientUpdateTemplateRecipientsFieldTypedDict] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class RecipientUpdateTemplateRecipientsRecipientResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: RecipientUpdateTemplateRecipientsRoleResponse read_status: Annotated[ @@ -758,10 +846,6 @@ class RecipientUpdateTemplateRecipientsRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -788,18 +872,26 @@ class RecipientUpdateTemplateRecipientsRecipientResponse(BaseModel): fields: List[RecipientUpdateTemplateRecipientsField] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/responsevalidationerror.py b/src/documenso_sdk/models/responsevalidationerror.py index f01c72e..8b0c708 100644 --- a/src/documenso_sdk/models/responsevalidationerror.py +++ b/src/documenso_sdk/models/responsevalidationerror.py @@ -2,10 +2,12 @@ import httpx from typing import Optional +from dataclasses import dataclass from documenso_sdk.models import DocumensoError +@dataclass(unsafe_hash=True) class ResponseValidationError(DocumensoError): """Error raised when there is a type mismatch between the response data and the expected Pydantic model.""" diff --git a/src/documenso_sdk/models/template_createdocumentfromtemplateop.py b/src/documenso_sdk/models/template_createdocumentfromtemplateop.py index 6700ca2..5ddc74d 100644 --- a/src/documenso_sdk/models/template_createdocumentfromtemplateop.py +++ b/src/documenso_sdk/models/template_createdocumentfromtemplateop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from enum import Enum import httpx import pydantic @@ -27,6 +34,17 @@ class TemplateCreateDocumentFromTemplateRecipientRequest(BaseModel): name: Optional[str] = None +class CustomDocumentDatumTypedDict(TypedDict): + document_data_id: str + envelope_item_id: str + + +class CustomDocumentDatum(BaseModel): + document_data_id: Annotated[str, pydantic.Field(alias="documentDataId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + class PrefillFieldTypeDate(str, Enum): DATE = "date" @@ -189,7 +207,11 @@ class TemplateCreateDocumentFromTemplateRequestTypedDict(TypedDict): distribute_document: NotRequired[bool] r"""Whether to create the document as pending and distribute it to recipients.""" custom_document_data_id: NotRequired[str] - r"""The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used.""" + r"""[DEPRECATED] - Use customDocumentData instead. The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used.""" + custom_document_data: NotRequired[List[CustomDocumentDatumTypedDict]] + r"""The data IDs of alternative PDFs to use when creating the document. If not provided, the PDF attached to the template will be used.""" + folder_id: NotRequired[str] + r"""The ID of the folder to create the document in. If not provided, the document will be created in the root folder.""" prefill_fields: NotRequired[List[PrefillFieldTypedDict]] r"""The fields to prefill on the document before sending it out. Useful when you want to create a document from an existing template and pre-fill the fields with specific values.""" @@ -208,7 +230,15 @@ class TemplateCreateDocumentFromTemplateRequest(BaseModel): custom_document_data_id: Annotated[ Optional[str], pydantic.Field(alias="customDocumentDataId") ] = None - r"""The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used.""" + r"""[DEPRECATED] - Use customDocumentData instead. The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used.""" + + custom_document_data: Annotated[ + Optional[List[CustomDocumentDatum]], pydantic.Field(alias="customDocumentData") + ] = None + r"""The data IDs of alternative PDFs to use when creating the document. If not provided, the PDF attached to the template will be used.""" + + folder_id: Annotated[Optional[str], pydantic.Field(alias="folderId")] = None + r"""The ID of the folder to create the document in. If not provided, the document will be created in the root folder.""" prefill_fields: Annotated[ Optional[List[PrefillField]], pydantic.Field(alias="prefillFields") @@ -234,10 +264,11 @@ class TemplateCreateDocumentFromTemplateInternalServerErrorData(BaseModel): ] = None +@dataclass(unsafe_hash=True) class TemplateCreateDocumentFromTemplateInternalServerError(DocumensoError): r"""Internal server error""" - data: TemplateCreateDocumentFromTemplateInternalServerErrorData + data: TemplateCreateDocumentFromTemplateInternalServerErrorData = field(hash=False) def __init__( self, @@ -248,7 +279,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateCreateDocumentFromTemplateBadRequestIssueTypedDict(TypedDict): @@ -267,10 +298,11 @@ class TemplateCreateDocumentFromTemplateBadRequestErrorData(BaseModel): issues: Optional[List[TemplateCreateDocumentFromTemplateBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class TemplateCreateDocumentFromTemplateBadRequestError(DocumensoError): r"""Invalid input data""" - data: TemplateCreateDocumentFromTemplateBadRequestErrorData + data: TemplateCreateDocumentFromTemplateBadRequestErrorData = field(hash=False) def __init__( self, @@ -281,7 +313,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateCreateDocumentFromTemplateVisibility(str, Enum): @@ -307,6 +339,7 @@ class TemplateCreateDocumentFromTemplateGlobalAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class TemplateCreateDocumentFromTemplateGlobalActionAuth(str, Enum): @@ -356,6 +389,7 @@ class TemplateCreateDocumentFromTemplateDocumentDataTypedDict(TypedDict): id: str data: str initial_data: str + envelope_item_id: str class TemplateCreateDocumentFromTemplateDocumentData(BaseModel): @@ -367,6 +401,8 @@ class TemplateCreateDocumentFromTemplateDocumentData(BaseModel): initial_data: Annotated[str, pydantic.Field(alias="initialData")] + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + class TemplateCreateDocumentFromTemplateSigningOrder(str, Enum): PARALLEL = "PARALLEL" @@ -439,9 +475,7 @@ class TemplateCreateDocumentFromTemplateDocumentMetaTypedDict(TypedDict): subject: Nullable[str] message: Nullable[str] timezone: Nullable[str] - password: Nullable[str] date_format: Nullable[str] - document_id: float redirect_url: Nullable[str] typed_signature_enabled: bool upload_signature_enabled: bool @@ -449,6 +483,10 @@ class TemplateCreateDocumentFromTemplateDocumentMetaTypedDict(TypedDict): allow_dictate_next_signer: bool language: str email_settings: Nullable[TemplateCreateDocumentFromTemplateEmailSettingsTypedDict] + email_id: Nullable[str] + email_reply_to: Nullable[str] + password: NotRequired[Nullable[str]] + document_id: NotRequired[float] class TemplateCreateDocumentFromTemplateDocumentMeta(BaseModel): @@ -470,12 +508,8 @@ class TemplateCreateDocumentFromTemplateDocumentMeta(BaseModel): timezone: Nullable[str] - password: Nullable[str] - date_format: Annotated[Nullable[str], pydantic.Field(alias="dateFormat")] - document_id: Annotated[float, pydantic.Field(alias="documentId")] - redirect_url: Annotated[Nullable[str], pydantic.Field(alias="redirectUrl")] typed_signature_enabled: Annotated[ @@ -501,19 +535,29 @@ class TemplateCreateDocumentFromTemplateDocumentMeta(BaseModel): pydantic.Field(alias="emailSettings"), ] + email_id: Annotated[Nullable[str], pydantic.Field(alias="emailId")] + + email_reply_to: Annotated[Nullable[str], pydantic.Field(alias="emailReplyTo")] + + password: OptionalNullable[str] = None + + document_id: Annotated[Optional[float], pydantic.Field(alias="documentId")] = -1 + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["password", "documentId"] nullable_fields = [ "subject", "message", "timezone", - "password", "dateFormat", "redirectUrl", "emailSettings", + "emailId", + "emailReplyTo", + "password", ] - null_default_fields = [] + null_default_fields = ["password"] serialized = handler(self) @@ -644,6 +688,7 @@ class TemplateCreateDocumentFromTemplateAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class TemplateCreateDocumentFromTemplateActionAuth(str, Enum): @@ -674,13 +719,12 @@ class TemplateCreateDocumentFromTemplateRecipientAuthOptions(BaseModel): class TemplateCreateDocumentFromTemplateRecipientResponseTypedDict(TypedDict): + envelope_id: str role: TemplateCreateDocumentFromTemplateRole read_status: TemplateCreateDocumentFromTemplateReadStatus signing_status: TemplateCreateDocumentFromTemplateSigningStatus send_status: TemplateCreateDocumentFromTemplateSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -693,9 +737,13 @@ class TemplateCreateDocumentFromTemplateRecipientResponseTypedDict(TypedDict): signing_order: Nullable[float] r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class TemplateCreateDocumentFromTemplateRecipientResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: TemplateCreateDocumentFromTemplateRole read_status: Annotated[ @@ -713,10 +761,6 @@ class TemplateCreateDocumentFromTemplateRecipientResponse(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -741,18 +785,26 @@ class TemplateCreateDocumentFromTemplateRecipientResponse(BaseModel): rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -851,6 +903,11 @@ class TemplateCreateDocumentFromTemplateValue2(BaseModel): value: str +class TemplateCreateDocumentFromTemplateDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class TemplateCreateDocumentFromTemplateFieldMetaCheckboxTypedDict(TypedDict): type: TemplateCreateDocumentFromTemplateFieldMetaTypeCheckbox label: NotRequired[str] @@ -860,6 +917,7 @@ class TemplateCreateDocumentFromTemplateFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[TemplateCreateDocumentFromTemplateValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[TemplateCreateDocumentFromTemplateDirection] class TemplateCreateDocumentFromTemplateFieldMetaCheckbox(BaseModel): @@ -883,6 +941,10 @@ class TemplateCreateDocumentFromTemplateFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[TemplateCreateDocumentFromTemplateDirection] = ( + TemplateCreateDocumentFromTemplateDirection.VERTICAL + ) + class TemplateCreateDocumentFromTemplateFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -941,10 +1003,10 @@ class TemplateCreateDocumentFromTemplateFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[TemplateCreateDocumentFromTemplateTextAlign6] @@ -960,13 +1022,19 @@ class TemplateCreateDocumentFromTemplateFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -975,6 +1043,47 @@ class TemplateCreateDocumentFromTemplateFieldMetaNumber(BaseModel): pydantic.Field(alias="textAlign"), ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class TemplateCreateDocumentFromTemplateFieldMetaTypeText(str, Enum): TEXT = "text" @@ -1188,8 +1297,8 @@ class TemplateCreateDocumentFromTemplateFieldMetaInitials(BaseModel): TemplateCreateDocumentFromTemplateFieldMetaEmailTypedDict, TemplateCreateDocumentFromTemplateFieldMetaDateTypedDict, TemplateCreateDocumentFromTemplateFieldMetaDropdownTypedDict, - TemplateCreateDocumentFromTemplateFieldMetaCheckboxTypedDict, TemplateCreateDocumentFromTemplateFieldMetaTextTypedDict, + TemplateCreateDocumentFromTemplateFieldMetaCheckboxTypedDict, TemplateCreateDocumentFromTemplateFieldMetaNumberTypedDict, ], ) @@ -1204,19 +1313,19 @@ class TemplateCreateDocumentFromTemplateFieldMetaInitials(BaseModel): TemplateCreateDocumentFromTemplateFieldMetaEmail, TemplateCreateDocumentFromTemplateFieldMetaDate, TemplateCreateDocumentFromTemplateFieldMetaDropdown, - TemplateCreateDocumentFromTemplateFieldMetaCheckbox, TemplateCreateDocumentFromTemplateFieldMetaText, + TemplateCreateDocumentFromTemplateFieldMetaCheckbox, TemplateCreateDocumentFromTemplateFieldMetaNumber, ], ) class TemplateCreateDocumentFromTemplateFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: TemplateCreateDocumentFromTemplateFieldType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -1227,19 +1336,21 @@ class TemplateCreateDocumentFromTemplateFieldTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class TemplateCreateDocumentFromTemplateField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: TemplateCreateDocumentFromTemplateFieldType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -1262,10 +1373,25 @@ class TemplateCreateDocumentFromTemplateField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -1309,19 +1435,21 @@ class TemplateCreateDocumentFromTemplateResponseTypedDict(TypedDict): Dict[str, TemplateCreateDocumentFromTemplateFormValuesTypedDict] ] title: str - document_data_id: str created_at: str updated_at: str completed_at: Nullable[str] deleted_at: Nullable[str] team_id: float - template_id: Nullable[float] folder_id: Nullable[str] + envelope_id: str document_data: TemplateCreateDocumentFromTemplateDocumentDataTypedDict - document_meta: Nullable[TemplateCreateDocumentFromTemplateDocumentMetaTypedDict] + document_meta: TemplateCreateDocumentFromTemplateDocumentMetaTypedDict folder: Nullable[TemplateCreateDocumentFromTemplateFolderTypedDict] recipients: List[TemplateCreateDocumentFromTemplateRecipientResponseTypedDict] fields: List[TemplateCreateDocumentFromTemplateFieldTypedDict] + template_id: NotRequired[Nullable[float]] + r"""The ID of the template that the document was created from, if any.""" + document_data_id: NotRequired[str] class TemplateCreateDocumentFromTemplateResponse(BaseModel): @@ -1353,8 +1481,6 @@ class TemplateCreateDocumentFromTemplateResponse(BaseModel): title: str - document_data_id: Annotated[str, pydantic.Field(alias="documentDataId")] - created_at: Annotated[str, pydantic.Field(alias="createdAt")] updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] @@ -1365,17 +1491,17 @@ class TemplateCreateDocumentFromTemplateResponse(BaseModel): team_id: Annotated[float, pydantic.Field(alias="teamId")] - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + document_data: Annotated[ TemplateCreateDocumentFromTemplateDocumentData, pydantic.Field(alias="documentData"), ] document_meta: Annotated[ - Nullable[TemplateCreateDocumentFromTemplateDocumentMeta], + TemplateCreateDocumentFromTemplateDocumentMeta, pydantic.Field(alias="documentMeta"), ] @@ -1385,18 +1511,26 @@ class TemplateCreateDocumentFromTemplateResponse(BaseModel): fields: List[TemplateCreateDocumentFromTemplateField] + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + r"""The ID of the template that the document was created from, if any.""" + + document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="documentDataId") + ] = "" + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["templateId", "documentDataId"] nullable_fields = [ "externalId", "authOptions", "formValues", "completedAt", "deletedAt", - "templateId", "folderId", - "documentMeta", + "templateId", "folder", ] null_default_fields = [] diff --git a/src/documenso_sdk/models/template_createtemplatedirectlinkop.py b/src/documenso_sdk/models/template_createtemplatedirectlinkop.py index 5e67914..31dad0a 100644 --- a/src/documenso_sdk/models/template_createtemplatedirectlinkop.py +++ b/src/documenso_sdk/models/template_createtemplatedirectlinkop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -42,10 +43,11 @@ class TemplateCreateTemplateDirectLinkInternalServerErrorData(BaseModel): ) +@dataclass(unsafe_hash=True) class TemplateCreateTemplateDirectLinkInternalServerError(DocumensoError): r"""Internal server error""" - data: TemplateCreateTemplateDirectLinkInternalServerErrorData + data: TemplateCreateTemplateDirectLinkInternalServerErrorData = field(hash=False) def __init__( self, @@ -56,7 +58,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateCreateTemplateDirectLinkBadRequestIssueTypedDict(TypedDict): @@ -75,10 +77,11 @@ class TemplateCreateTemplateDirectLinkBadRequestErrorData(BaseModel): issues: Optional[List[TemplateCreateTemplateDirectLinkBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class TemplateCreateTemplateDirectLinkBadRequestError(DocumensoError): r"""Invalid input data""" - data: TemplateCreateTemplateDirectLinkBadRequestErrorData + data: TemplateCreateTemplateDirectLinkBadRequestErrorData = field(hash=False) def __init__( self, @@ -89,18 +92,19 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateCreateTemplateDirectLinkResponseTypedDict(TypedDict): r"""Successful response""" id: str - template_id: float token: str created_at: str enabled: bool direct_template_recipient_id: float + envelope_id: str + template_id: float class TemplateCreateTemplateDirectLinkResponse(BaseModel): @@ -108,8 +112,6 @@ class TemplateCreateTemplateDirectLinkResponse(BaseModel): id: str - template_id: Annotated[float, pydantic.Field(alias="templateId")] - token: str created_at: Annotated[str, pydantic.Field(alias="createdAt")] @@ -119,3 +121,7 @@ class TemplateCreateTemplateDirectLinkResponse(BaseModel): direct_template_recipient_id: Annotated[ float, pydantic.Field(alias="directTemplateRecipientId") ] + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + template_id: Annotated[float, pydantic.Field(alias="templateId")] diff --git a/src/documenso_sdk/models/template_createtemplatetemporaryop.py b/src/documenso_sdk/models/template_createtemplatetemporaryop.py new file mode 100644 index 0000000..a7402b0 --- /dev/null +++ b/src/documenso_sdk/models/template_createtemplatetemporaryop.py @@ -0,0 +1,1746 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from dataclasses import dataclass, field +from documenso_sdk.models import DocumensoError +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) +from enum import Enum +import httpx +import pydantic +from pydantic import model_serializer +from typing import Any, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict + + +class TemplateCreateTemplateTemporaryVisibilityRequest(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class TemplateCreateTemplateTemporaryGlobalAccessAuthRequest(str, Enum): + r"""The type of authentication required for the recipient to access the document.""" + + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class TemplateCreateTemplateTemporaryGlobalActionAuthRequest(str, Enum): + r"""The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only.""" + + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class TemplateCreateTemplateTemporaryTypeRequest(str, Enum): + PUBLIC = "PUBLIC" + PRIVATE = "PRIVATE" + + +class TemplateCreateTemplateTemporaryDateFormat(str, Enum): + r"""The date format to use for date fields and signing the document.""" + + YYYY_M_MDD_HH_MM_A = "yyyy-MM-dd hh:mm a" + YYYY_M_MDD = "yyyy-MM-dd" + DD_MM_SLASH_YYYY = "dd/MM/yyyy" + MM_DD_SLASH_YYYY = "MM/dd/yyyy" + YY_M_MDD = "yy-MM-dd" + MMMM_DD_COMMA_YYYY = "MMMM dd, yyyy" + EEEE_MMMM_DD_COMMA_YYYY = "EEEE, MMMM dd, yyyy" + DD_MM_SLASH_YYYY_HH_MM_A = "dd/MM/yyyy hh:mm a" + DD_MM_SLASH_YYYY_H_HMM = "dd/MM/yyyy HH:mm" + MM_DD_SLASH_YYYY_HH_MM_A = "MM/dd/yyyy hh:mm a" + MM_DD_SLASH_YYYY_H_HMM = "MM/dd/yyyy HH:mm" + DD_DOT_MM_DOT_YYYY = "dd.MM.yyyy" + DD_DOT_MM_DOT_YYYY_H_HMM = "dd.MM.yyyy HH:mm" + YYYY_M_MDD_H_HMM = "yyyy-MM-dd HH:mm" + YY_M_MDD_HH_MM_A = "yy-MM-dd hh:mm a" + YY_M_MDD_H_HMM = "yy-MM-dd HH:mm" + YYYY_M_MDD_H_HMMSS = "yyyy-MM-dd HH:mm:ss" + MMMM_DD_COMMA_YYYY_HH_MM_A = "MMMM dd, yyyy hh:mm a" + MMMM_DD_COMMA_YYYY_H_HMM = "MMMM dd, yyyy HH:mm" + EEEE_MMMM_DD_COMMA_YYYY_HH_MM_A = "EEEE, MMMM dd, yyyy hh:mm a" + EEEE_MMMM_DD_COMMA_YYYY_H_HMM = "EEEE, MMMM dd, yyyy HH:mm" + ISO8601_FULL = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" + + +class TemplateCreateTemplateTemporaryDistributionMethodRequest(str, Enum): + r"""The distribution method to use when sending the document to the recipients.""" + + EMAIL = "EMAIL" + NONE = "NONE" + + +class TemplateCreateTemplateTemporaryEmailSettingsRequestTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + r"""Whether to send an email to all recipients that the document is ready for them to sign.""" + recipient_removed: NotRequired[bool] + r"""Whether to send an email to the recipient who was removed from a pending document.""" + recipient_signed: NotRequired[bool] + r"""Whether to send an email to the document owner when a recipient has signed the document.""" + document_pending: NotRequired[bool] + r"""Whether to send an email to the recipient who has just signed the document indicating that there are still other recipients who need to sign the document. This will only be sent if the document is still pending after the recipient has signed.""" + document_completed: NotRequired[bool] + r"""Whether to send an email to all recipients when the document is complete.""" + document_deleted: NotRequired[bool] + r"""Whether to send an email to all recipients if a pending document has been deleted.""" + owner_document_completed: NotRequired[bool] + r"""Whether to send an email to the document owner when the document is complete.""" + + +class TemplateCreateTemplateTemporaryEmailSettingsRequest(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + r"""Whether to send an email to all recipients that the document is ready for them to sign.""" + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + r"""Whether to send an email to the recipient who was removed from a pending document.""" + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + r"""Whether to send an email to the document owner when a recipient has signed the document.""" + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + r"""Whether to send an email to the recipient who has just signed the document indicating that there are still other recipients who need to sign the document. This will only be sent if the document is still pending after the recipient has signed.""" + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + r"""Whether to send an email to all recipients when the document is complete.""" + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + r"""Whether to send an email to all recipients if a pending document has been deleted.""" + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + r"""Whether to send an email to the document owner when the document is complete.""" + + +class TemplateCreateTemplateTemporaryLanguage(str, Enum): + r"""The language to use for email communications with recipients.""" + + DE = "de" + EN = "en" + FR = "fr" + ES = "es" + IT = "it" + PL = "pl" + + +class TemplateCreateTemplateTemporarySigningOrderRequest(str, Enum): + PARALLEL = "PARALLEL" + SEQUENTIAL = "SEQUENTIAL" + + +class TemplateCreateTemplateTemporaryMetaTypedDict(TypedDict): + subject: NotRequired[str] + r"""The subject of the email that will be sent to the recipients.""" + message: NotRequired[str] + r"""The message of the email that will be sent to the recipients.""" + timezone: NotRequired[str] + r"""The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne""" + date_format: NotRequired[TemplateCreateTemplateTemporaryDateFormat] + r"""The date format to use for date fields and signing the document.""" + distribution_method: NotRequired[ + TemplateCreateTemplateTemporaryDistributionMethodRequest + ] + r"""The distribution method to use when sending the document to the recipients.""" + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[ + TemplateCreateTemplateTemporaryEmailSettingsRequestTypedDict + ] + redirect_url: NotRequired[str] + r"""The URL to which the recipient should be redirected after signing the document.""" + language: NotRequired[TemplateCreateTemplateTemporaryLanguage] + r"""The language to use for email communications with recipients.""" + typed_signature_enabled: NotRequired[bool] + r"""Whether to allow recipients to sign using a typed signature.""" + upload_signature_enabled: NotRequired[bool] + r"""Whether to allow recipients to sign using an uploaded signature.""" + draw_signature_enabled: NotRequired[bool] + r"""Whether to allow recipients to sign using a draw signature.""" + signing_order: NotRequired[TemplateCreateTemplateTemporarySigningOrderRequest] + allow_dictate_next_signer: NotRequired[bool] + + +class TemplateCreateTemplateTemporaryMeta(BaseModel): + subject: Optional[str] = None + r"""The subject of the email that will be sent to the recipients.""" + + message: Optional[str] = None + r"""The message of the email that will be sent to the recipients.""" + + timezone: Optional[str] = None + r"""The timezone to use for date fields and signing the document. Example Etc/UTC, Australia/Melbourne""" + + date_format: Annotated[ + Optional[TemplateCreateTemplateTemporaryDateFormat], + pydantic.Field(alias="dateFormat"), + ] = None + r"""The date format to use for date fields and signing the document.""" + + distribution_method: Annotated[ + Optional[TemplateCreateTemplateTemporaryDistributionMethodRequest], + pydantic.Field(alias="distributionMethod"), + ] = None + r"""The distribution method to use when sending the document to the recipients.""" + + email_id: Annotated[OptionalNullable[str], pydantic.Field(alias="emailId")] = UNSET + + email_reply_to: Annotated[ + OptionalNullable[str], pydantic.Field(alias="emailReplyTo") + ] = UNSET + + email_settings: Annotated[ + Optional[TemplateCreateTemplateTemporaryEmailSettingsRequest], + pydantic.Field(alias="emailSettings"), + ] = None + + redirect_url: Annotated[Optional[str], pydantic.Field(alias="redirectUrl")] = None + r"""The URL to which the recipient should be redirected after signing the document.""" + + language: Optional[TemplateCreateTemplateTemporaryLanguage] = None + r"""The language to use for email communications with recipients.""" + + typed_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="typedSignatureEnabled") + ] = None + r"""Whether to allow recipients to sign using a typed signature.""" + + upload_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="uploadSignatureEnabled") + ] = None + r"""Whether to allow recipients to sign using an uploaded signature.""" + + draw_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="drawSignatureEnabled") + ] = None + r"""Whether to allow recipients to sign using a draw signature.""" + + signing_order: Annotated[ + Optional[TemplateCreateTemplateTemporarySigningOrderRequest], + pydantic.Field(alias="signingOrder"), + ] = None + + allow_dictate_next_signer: Annotated[ + Optional[bool], pydantic.Field(alias="allowDictateNextSigner") + ] = None + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "subject", + "message", + "timezone", + "dateFormat", + "distributionMethod", + "emailId", + "emailReplyTo", + "emailSettings", + "redirectUrl", + "language", + "typedSignatureEnabled", + "uploadSignatureEnabled", + "drawSignatureEnabled", + "signingOrder", + "allowDictateNextSigner", + ] + nullable_fields = ["emailId", "emailReplyTo"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class TemplateCreateTemplateTemporaryRequestTypedDict(TypedDict): + title: str + r"""The title of the document.""" + folder_id: NotRequired[str] + external_id: NotRequired[Nullable[str]] + visibility: NotRequired[TemplateCreateTemplateTemporaryVisibilityRequest] + global_access_auth: NotRequired[ + List[TemplateCreateTemplateTemporaryGlobalAccessAuthRequest] + ] + global_action_auth: NotRequired[ + List[TemplateCreateTemplateTemporaryGlobalActionAuthRequest] + ] + public_title: NotRequired[str] + r"""The title of the template that will be displayed to the public. Only applicable for public templates.""" + public_description: NotRequired[str] + r"""The description of the template that will be displayed to the public. Only applicable for public templates.""" + type: NotRequired[TemplateCreateTemplateTemporaryTypeRequest] + meta: NotRequired[TemplateCreateTemplateTemporaryMetaTypedDict] + + +class TemplateCreateTemplateTemporaryRequest(BaseModel): + title: str + r"""The title of the document.""" + + folder_id: Annotated[Optional[str], pydantic.Field(alias="folderId")] = None + + external_id: Annotated[ + OptionalNullable[str], pydantic.Field(alias="externalId") + ] = UNSET + + visibility: Optional[TemplateCreateTemplateTemporaryVisibilityRequest] = None + + global_access_auth: Annotated[ + Optional[List[TemplateCreateTemplateTemporaryGlobalAccessAuthRequest]], + pydantic.Field(alias="globalAccessAuth"), + ] = None + + global_action_auth: Annotated[ + Optional[List[TemplateCreateTemplateTemporaryGlobalActionAuthRequest]], + pydantic.Field(alias="globalActionAuth"), + ] = None + + public_title: Annotated[Optional[str], pydantic.Field(alias="publicTitle")] = None + r"""The title of the template that will be displayed to the public. Only applicable for public templates.""" + + public_description: Annotated[ + Optional[str], pydantic.Field(alias="publicDescription") + ] = None + r"""The description of the template that will be displayed to the public. Only applicable for public templates.""" + + type: Optional[TemplateCreateTemplateTemporaryTypeRequest] = None + + meta: Optional[TemplateCreateTemplateTemporaryMeta] = None + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "folderId", + "externalId", + "visibility", + "globalAccessAuth", + "globalActionAuth", + "publicTitle", + "publicDescription", + "type", + "meta", + ] + nullable_fields = ["externalId"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class TemplateCreateTemplateTemporaryInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateTemplateTemporaryInternalServerErrorIssue(BaseModel): + message: str + + +class TemplateCreateTemplateTemporaryInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateTemplateTemporaryInternalServerErrorIssue]] = ( + None + ) + + +@dataclass(unsafe_hash=True) +class TemplateCreateTemplateTemporaryInternalServerError(DocumensoError): + r"""Internal server error""" + + data: TemplateCreateTemplateTemporaryInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateTemplateTemporaryInternalServerErrorData, + raw_response: httpx.Response, + body: Optional[str] = None, + ): + fallback = body or raw_response.text + message = str(data.message) or fallback + super().__init__(message, raw_response, body) + object.__setattr__(self, "data", data) + + +class TemplateCreateTemplateTemporaryBadRequestIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateTemplateTemporaryBadRequestIssue(BaseModel): + message: str + + +class TemplateCreateTemplateTemporaryBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateTemplateTemporaryBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateTemplateTemporaryBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: TemplateCreateTemplateTemporaryBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateTemplateTemporaryBadRequestErrorData, + raw_response: httpx.Response, + body: Optional[str] = None, + ): + fallback = body or raw_response.text + message = str(data.message) or fallback + super().__init__(message, raw_response, body) + object.__setattr__(self, "data", data) + + +class TemplateCreateTemplateTemporaryTypeResponse(str, Enum): + PUBLIC = "PUBLIC" + PRIVATE = "PRIVATE" + + +class TemplateCreateTemplateTemporaryVisibilityResponse(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class TemplateCreateTemplateTemporaryGlobalAccessAuthResponse(str, Enum): + r"""The type of authentication required for the recipient to access the document.""" + + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class TemplateCreateTemplateTemporaryGlobalActionAuthResponse(str, Enum): + r"""The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only.""" + + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class TemplateCreateTemplateTemporaryAuthOptionsTypedDict(TypedDict): + global_access_auth: List[TemplateCreateTemplateTemporaryGlobalAccessAuthResponse] + global_action_auth: List[TemplateCreateTemplateTemporaryGlobalActionAuthResponse] + + +class TemplateCreateTemplateTemporaryAuthOptions(BaseModel): + global_access_auth: Annotated[ + List[TemplateCreateTemplateTemporaryGlobalAccessAuthResponse], + pydantic.Field(alias="globalAccessAuth"), + ] + + global_action_auth: Annotated[ + List[TemplateCreateTemplateTemporaryGlobalActionAuthResponse], + pydantic.Field(alias="globalActionAuth"), + ] + + +class TemplateCreateTemplateTemporaryTemplateDocumentDataType(str, Enum): + S3_PATH = "S3_PATH" + BYTES = "BYTES" + BYTES_64 = "BYTES_64" + + +class TemplateCreateTemplateTemporaryTemplateDocumentDataTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTemplateDocumentDataType + id: str + data: str + initial_data: str + envelope_item_id: str + + +class TemplateCreateTemplateTemporaryTemplateDocumentData(BaseModel): + type: TemplateCreateTemplateTemporaryTemplateDocumentDataType + + id: str + + data: str + + initial_data: Annotated[str, pydantic.Field(alias="initialData")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + +class TemplateCreateTemplateTemporaryTemplateMetaSigningOrder(str, Enum): + PARALLEL = "PARALLEL" + SEQUENTIAL = "SEQUENTIAL" + + +class TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod(str, Enum): + EMAIL = "EMAIL" + NONE = "NONE" + + +class TemplateCreateTemplateTemporaryTemplateMetaEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + r"""Whether to send an email to all recipients that the document is ready for them to sign.""" + recipient_removed: NotRequired[bool] + r"""Whether to send an email to the recipient who was removed from a pending document.""" + recipient_signed: NotRequired[bool] + r"""Whether to send an email to the document owner when a recipient has signed the document.""" + document_pending: NotRequired[bool] + r"""Whether to send an email to the recipient who has just signed the document indicating that there are still other recipients who need to sign the document. This will only be sent if the document is still pending after the recipient has signed.""" + document_completed: NotRequired[bool] + r"""Whether to send an email to all recipients when the document is complete.""" + document_deleted: NotRequired[bool] + r"""Whether to send an email to all recipients if a pending document has been deleted.""" + owner_document_completed: NotRequired[bool] + r"""Whether to send an email to the document owner when the document is complete.""" + + +class TemplateCreateTemplateTemporaryTemplateMetaEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + r"""Whether to send an email to all recipients that the document is ready for them to sign.""" + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + r"""Whether to send an email to the recipient who was removed from a pending document.""" + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + r"""Whether to send an email to the document owner when a recipient has signed the document.""" + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + r"""Whether to send an email to the recipient who has just signed the document indicating that there are still other recipients who need to sign the document. This will only be sent if the document is still pending after the recipient has signed.""" + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + r"""Whether to send an email to all recipients when the document is complete.""" + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + r"""Whether to send an email to all recipients if a pending document has been deleted.""" + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + r"""Whether to send an email to the document owner when the document is complete.""" + + +class TemplateCreateTemplateTemporaryTemplateMetaTypedDict(TypedDict): + id: str + subject: Nullable[str] + message: Nullable[str] + timezone: Nullable[str] + date_format: Nullable[str] + signing_order: TemplateCreateTemplateTemporaryTemplateMetaSigningOrder + typed_signature_enabled: bool + upload_signature_enabled: bool + draw_signature_enabled: bool + allow_dictate_next_signer: bool + distribution_method: TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod + redirect_url: Nullable[str] + language: str + email_settings: Nullable[ + TemplateCreateTemplateTemporaryTemplateMetaEmailSettingsTypedDict + ] + email_id: Nullable[str] + email_reply_to: Nullable[str] + template_id: Nullable[float] + + +class TemplateCreateTemplateTemporaryTemplateMeta(BaseModel): + id: str + + subject: Nullable[str] + + message: Nullable[str] + + timezone: Nullable[str] + + date_format: Annotated[Nullable[str], pydantic.Field(alias="dateFormat")] + + signing_order: Annotated[ + TemplateCreateTemplateTemporaryTemplateMetaSigningOrder, + pydantic.Field(alias="signingOrder"), + ] + + typed_signature_enabled: Annotated[ + bool, pydantic.Field(alias="typedSignatureEnabled") + ] + + upload_signature_enabled: Annotated[ + bool, pydantic.Field(alias="uploadSignatureEnabled") + ] + + draw_signature_enabled: Annotated[ + bool, pydantic.Field(alias="drawSignatureEnabled") + ] + + allow_dictate_next_signer: Annotated[ + bool, pydantic.Field(alias="allowDictateNextSigner") + ] + + distribution_method: Annotated[ + TemplateCreateTemplateTemporaryTemplateMetaDistributionMethod, + pydantic.Field(alias="distributionMethod"), + ] + + redirect_url: Annotated[Nullable[str], pydantic.Field(alias="redirectUrl")] + + language: str + + email_settings: Annotated[ + Nullable[TemplateCreateTemplateTemporaryTemplateMetaEmailSettings], + pydantic.Field(alias="emailSettings"), + ] + + email_id: Annotated[Nullable[str], pydantic.Field(alias="emailId")] + + email_reply_to: Annotated[Nullable[str], pydantic.Field(alias="emailReplyTo")] + + template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = [ + "subject", + "message", + "timezone", + "dateFormat", + "redirectUrl", + "emailSettings", + "emailId", + "emailReplyTo", + "templateId", + ] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class TemplateCreateTemplateTemporaryDirectLinkTypedDict(TypedDict): + id: str + envelope_id: str + token: str + created_at: str + enabled: bool + direct_template_recipient_id: float + template_id: float + + +class TemplateCreateTemplateTemporaryDirectLink(BaseModel): + id: str + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + token: str + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + enabled: bool + + direct_template_recipient_id: Annotated[ + float, pydantic.Field(alias="directTemplateRecipientId") + ] + + template_id: Annotated[float, pydantic.Field(alias="templateId")] + + +class TemplateCreateTemplateTemporaryUserTypedDict(TypedDict): + id: float + name: Nullable[str] + email: str + + +class TemplateCreateTemplateTemporaryUser(BaseModel): + id: float + + name: Nullable[str] + + email: str + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = ["name"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class TemplateCreateTemplateTemporaryRole(str, Enum): + CC = "CC" + SIGNER = "SIGNER" + VIEWER = "VIEWER" + APPROVER = "APPROVER" + ASSISTANT = "ASSISTANT" + + +class TemplateCreateTemplateTemporaryReadStatus(str, Enum): + NOT_OPENED = "NOT_OPENED" + OPENED = "OPENED" + + +class TemplateCreateTemplateTemporarySigningStatus(str, Enum): + NOT_SIGNED = "NOT_SIGNED" + SIGNED = "SIGNED" + REJECTED = "REJECTED" + + +class TemplateCreateTemplateTemporarySendStatus(str, Enum): + NOT_SENT = "NOT_SENT" + SENT = "SENT" + + +class TemplateCreateTemplateTemporaryAccessAuth(str, Enum): + r"""The type of authentication required for the recipient to access the document.""" + + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class TemplateCreateTemplateTemporaryActionAuth(str, Enum): + r"""The type of authentication required for the recipient to sign the document.""" + + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + EXPLICIT_NONE = "EXPLICIT_NONE" + + +class TemplateCreateTemplateTemporaryRecipientAuthOptionsTypedDict(TypedDict): + access_auth: List[TemplateCreateTemplateTemporaryAccessAuth] + action_auth: List[TemplateCreateTemplateTemporaryActionAuth] + + +class TemplateCreateTemplateTemporaryRecipientAuthOptions(BaseModel): + access_auth: Annotated[ + List[TemplateCreateTemplateTemporaryAccessAuth], + pydantic.Field(alias="accessAuth"), + ] + + action_auth: Annotated[ + List[TemplateCreateTemplateTemporaryActionAuth], + pydantic.Field(alias="actionAuth"), + ] + + +class TemplateCreateTemplateTemporaryRecipientTypedDict(TypedDict): + envelope_id: str + role: TemplateCreateTemplateTemporaryRole + read_status: TemplateCreateTemplateTemporaryReadStatus + signing_status: TemplateCreateTemplateTemporarySigningStatus + send_status: TemplateCreateTemplateTemporarySendStatus + id: float + email: str + name: str + token: str + document_deleted_at: Nullable[str] + expired: Nullable[str] + signed_at: Nullable[str] + auth_options: Nullable[TemplateCreateTemplateTemporaryRecipientAuthOptionsTypedDict] + signing_order: Nullable[float] + r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" + rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] + + +class TemplateCreateTemplateTemporaryRecipient(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + role: TemplateCreateTemplateTemporaryRole + + read_status: Annotated[ + TemplateCreateTemplateTemporaryReadStatus, pydantic.Field(alias="readStatus") + ] + + signing_status: Annotated[ + TemplateCreateTemplateTemporarySigningStatus, + pydantic.Field(alias="signingStatus"), + ] + + send_status: Annotated[ + TemplateCreateTemplateTemporarySendStatus, pydantic.Field(alias="sendStatus") + ] + + id: float + + email: str + + name: str + + token: str + + document_deleted_at: Annotated[ + Nullable[str], pydantic.Field(alias="documentDeletedAt") + ] + + expired: Nullable[str] + + signed_at: Annotated[Nullable[str], pydantic.Field(alias="signedAt")] + + auth_options: Annotated[ + Nullable[TemplateCreateTemplateTemporaryRecipientAuthOptions], + pydantic.Field(alias="authOptions"), + ] + + signing_order: Annotated[Nullable[float], pydantic.Field(alias="signingOrder")] + r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" + + rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["documentId", "templateId"] + nullable_fields = [ + "documentDeletedAt", + "expired", + "signedAt", + "authOptions", + "signingOrder", + "rejectionReason", + "documentId", + "templateId", + ] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class TemplateCreateTemplateTemporaryFieldType(str, Enum): + SIGNATURE = "SIGNATURE" + FREE_SIGNATURE = "FREE_SIGNATURE" + INITIALS = "INITIALS" + NAME = "NAME" + EMAIL = "EMAIL" + DATE = "DATE" + TEXT = "TEXT" + NUMBER = "NUMBER" + RADIO = "RADIO" + CHECKBOX = "CHECKBOX" + DROPDOWN = "DROPDOWN" + + +class TemplateCreateTemplateTemporaryTypeDropdown(str, Enum): + DROPDOWN = "dropdown" + + +class TemplateCreateTemplateTemporaryValue3TypedDict(TypedDict): + value: str + + +class TemplateCreateTemplateTemporaryValue3(BaseModel): + value: str + + +class TemplateCreateTemplateTemporaryFieldMetaDropdownTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeDropdown + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + values: NotRequired[List[TemplateCreateTemplateTemporaryValue3TypedDict]] + default_value: NotRequired[str] + + +class TemplateCreateTemplateTemporaryFieldMetaDropdown(BaseModel): + type: TemplateCreateTemplateTemporaryTypeDropdown + + label: Optional[str] = None + + placeholder: Optional[str] = None + + required: Optional[bool] = None + + read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + + values: Optional[List[TemplateCreateTemplateTemporaryValue3]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +class TemplateCreateTemplateTemporaryTypeCheckbox(str, Enum): + CHECKBOX = "checkbox" + + +class TemplateCreateTemplateTemporaryValue2TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class TemplateCreateTemplateTemporaryValue2(BaseModel): + id: float + + checked: bool + + value: str + + +class TemplateCreateTemplateTemporaryDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class TemplateCreateTemplateTemporaryFieldMetaCheckboxTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeCheckbox + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + values: NotRequired[List[TemplateCreateTemplateTemporaryValue2TypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[TemplateCreateTemplateTemporaryDirection] + + +class TemplateCreateTemplateTemporaryFieldMetaCheckbox(BaseModel): + type: TemplateCreateTemplateTemporaryTypeCheckbox + + label: Optional[str] = None + + placeholder: Optional[str] = None + + required: Optional[bool] = None + + read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + + values: Optional[List[TemplateCreateTemplateTemporaryValue2]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[TemplateCreateTemplateTemporaryDirection] = ( + TemplateCreateTemplateTemporaryDirection.VERTICAL + ) + + +class TemplateCreateTemplateTemporaryTypeRadio(str, Enum): + RADIO = "radio" + + +class TemplateCreateTemplateTemporaryValue1TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class TemplateCreateTemplateTemporaryValue1(BaseModel): + id: float + + checked: bool + + value: str + + +class TemplateCreateTemplateTemporaryFieldMetaRadioTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeRadio + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + values: NotRequired[List[TemplateCreateTemplateTemporaryValue1TypedDict]] + + +class TemplateCreateTemplateTemporaryFieldMetaRadio(BaseModel): + type: TemplateCreateTemplateTemporaryTypeRadio + + label: Optional[str] = None + + placeholder: Optional[str] = None + + required: Optional[bool] = None + + read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + + values: Optional[List[TemplateCreateTemplateTemporaryValue1]] = None + + +class TemplateCreateTemplateTemporaryTypeNumber(str, Enum): + NUMBER = "number" + + +class TemplateCreateTemplateTemporaryTextAlign6(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class TemplateCreateTemplateTemporaryFieldMetaNumberTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeNumber + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + font_size: NotRequired[float] + text_align: NotRequired[TemplateCreateTemplateTemporaryTextAlign6] + + +class TemplateCreateTemplateTemporaryFieldMetaNumber(BaseModel): + type: TemplateCreateTemplateTemporaryTypeNumber + + label: Optional[str] = None + + placeholder: Optional[str] = None + + required: Optional[bool] = None + + read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET + + value: Optional[str] = None + + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) + + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + + text_align: Annotated[ + Optional[TemplateCreateTemplateTemporaryTextAlign6], + pydantic.Field(alias="textAlign"), + ] = None + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class TemplateCreateTemplateTemporaryTypeText(str, Enum): + TEXT = "text" + + +class TemplateCreateTemplateTemporaryTextAlign5(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class TemplateCreateTemplateTemporaryFieldMetaTextTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeText + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + text: NotRequired[str] + character_limit: NotRequired[float] + font_size: NotRequired[float] + text_align: NotRequired[TemplateCreateTemplateTemporaryTextAlign5] + + +class TemplateCreateTemplateTemporaryFieldMetaText(BaseModel): + type: TemplateCreateTemplateTemporaryTypeText + + label: Optional[str] = None + + placeholder: Optional[str] = None + + required: Optional[bool] = None + + read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + + text_align: Annotated[ + Optional[TemplateCreateTemplateTemporaryTextAlign5], + pydantic.Field(alias="textAlign"), + ] = None + + +class TemplateCreateTemplateTemporaryTypeDate(str, Enum): + DATE = "date" + + +class TemplateCreateTemplateTemporaryTextAlign4(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class TemplateCreateTemplateTemporaryFieldMetaDateTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeDate + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[TemplateCreateTemplateTemporaryTextAlign4] + + +class TemplateCreateTemplateTemporaryFieldMetaDate(BaseModel): + type: TemplateCreateTemplateTemporaryTypeDate + + label: Optional[str] = None + + placeholder: Optional[str] = None + + required: Optional[bool] = None + + read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + + text_align: Annotated[ + Optional[TemplateCreateTemplateTemporaryTextAlign4], + pydantic.Field(alias="textAlign"), + ] = None + + +class TemplateCreateTemplateTemporaryTypeEmail(str, Enum): + EMAIL = "email" + + +class TemplateCreateTemplateTemporaryTextAlign3(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class TemplateCreateTemplateTemporaryFieldMetaEmailTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeEmail + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[TemplateCreateTemplateTemporaryTextAlign3] + + +class TemplateCreateTemplateTemporaryFieldMetaEmail(BaseModel): + type: TemplateCreateTemplateTemporaryTypeEmail + + label: Optional[str] = None + + placeholder: Optional[str] = None + + required: Optional[bool] = None + + read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + + text_align: Annotated[ + Optional[TemplateCreateTemplateTemporaryTextAlign3], + pydantic.Field(alias="textAlign"), + ] = None + + +class TemplateCreateTemplateTemporaryTypeName(str, Enum): + NAME = "name" + + +class TemplateCreateTemplateTemporaryTextAlign2(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class TemplateCreateTemplateTemporaryFieldMetaNameTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeName + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[TemplateCreateTemplateTemporaryTextAlign2] + + +class TemplateCreateTemplateTemporaryFieldMetaName(BaseModel): + type: TemplateCreateTemplateTemporaryTypeName + + label: Optional[str] = None + + placeholder: Optional[str] = None + + required: Optional[bool] = None + + read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + + text_align: Annotated[ + Optional[TemplateCreateTemplateTemporaryTextAlign2], + pydantic.Field(alias="textAlign"), + ] = None + + +class TemplateCreateTemplateTemporaryTypeInitials(str, Enum): + INITIALS = "initials" + + +class TemplateCreateTemplateTemporaryTextAlign1(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class TemplateCreateTemplateTemporaryFieldMetaInitialsTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeInitials + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[TemplateCreateTemplateTemporaryTextAlign1] + + +class TemplateCreateTemplateTemporaryFieldMetaInitials(BaseModel): + type: TemplateCreateTemplateTemporaryTypeInitials + + label: Optional[str] = None + + placeholder: Optional[str] = None + + required: Optional[bool] = None + + read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + + text_align: Annotated[ + Optional[TemplateCreateTemplateTemporaryTextAlign1], + pydantic.Field(alias="textAlign"), + ] = None + + +TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict = TypeAliasType( + "TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict", + Union[ + TemplateCreateTemplateTemporaryFieldMetaRadioTypedDict, + TemplateCreateTemplateTemporaryFieldMetaInitialsTypedDict, + TemplateCreateTemplateTemporaryFieldMetaNameTypedDict, + TemplateCreateTemplateTemporaryFieldMetaEmailTypedDict, + TemplateCreateTemplateTemporaryFieldMetaDateTypedDict, + TemplateCreateTemplateTemporaryFieldMetaDropdownTypedDict, + TemplateCreateTemplateTemporaryFieldMetaTextTypedDict, + TemplateCreateTemplateTemporaryFieldMetaCheckboxTypedDict, + TemplateCreateTemplateTemporaryFieldMetaNumberTypedDict, + ], +) + + +TemplateCreateTemplateTemporaryFieldMetaUnion = TypeAliasType( + "TemplateCreateTemplateTemporaryFieldMetaUnion", + Union[ + TemplateCreateTemplateTemporaryFieldMetaRadio, + TemplateCreateTemplateTemporaryFieldMetaInitials, + TemplateCreateTemplateTemporaryFieldMetaName, + TemplateCreateTemplateTemporaryFieldMetaEmail, + TemplateCreateTemplateTemporaryFieldMetaDate, + TemplateCreateTemplateTemporaryFieldMetaDropdown, + TemplateCreateTemplateTemporaryFieldMetaText, + TemplateCreateTemplateTemporaryFieldMetaCheckbox, + TemplateCreateTemplateTemporaryFieldMetaNumber, + ], +) + + +class TemplateCreateTemplateTemporaryFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str + type: TemplateCreateTemplateTemporaryFieldType + id: float + secondary_id: str + recipient_id: float + page: float + r"""The page number of the field on the document. Starts from 1.""" + custom_text: str + inserted: bool + field_meta: Nullable[TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict] + position_x: NotRequired[Any] + position_y: NotRequired[Any] + width: NotRequired[Any] + height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] + + +class TemplateCreateTemplateTemporaryField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + type: TemplateCreateTemplateTemporaryFieldType + + id: float + + secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + r"""The page number of the field on the document. Starts from 1.""" + + custom_text: Annotated[str, pydantic.Field(alias="customText")] + + inserted: bool + + field_meta: Annotated[ + Nullable[TemplateCreateTemplateTemporaryFieldMetaUnion], + pydantic.Field(alias="fieldMeta"), + ] + + position_x: Annotated[Optional[Any], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[Any], pydantic.Field(alias="positionY")] = None + + width: Optional[Any] = None + + height: Optional[Any] = None + + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class TemplateCreateTemplateTemporaryFolderType(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + + +class TemplateCreateTemplateTemporaryFolderVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class TemplateCreateTemplateTemporaryFolderTypedDict(TypedDict): + id: str + name: str + type: TemplateCreateTemplateTemporaryFolderType + visibility: TemplateCreateTemplateTemporaryFolderVisibility + user_id: float + team_id: float + pinned: bool + parent_id: Nullable[str] + created_at: str + updated_at: str + + +class TemplateCreateTemplateTemporaryFolder(BaseModel): + id: str + + name: str + + type: TemplateCreateTemplateTemporaryFolderType + + visibility: TemplateCreateTemplateTemporaryFolderVisibility + + user_id: Annotated[float, pydantic.Field(alias="userId")] + + team_id: Annotated[float, pydantic.Field(alias="teamId")] + + pinned: bool + + parent_id: Annotated[Nullable[str], pydantic.Field(alias="parentId")] + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = ["parentId"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class TemplateCreateTemplateTemporaryTemplateTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeResponse + visibility: TemplateCreateTemplateTemporaryVisibilityResponse + id: float + external_id: Nullable[str] + title: str + user_id: float + team_id: float + auth_options: Nullable[TemplateCreateTemplateTemporaryAuthOptionsTypedDict] + created_at: str + updated_at: str + public_title: str + public_description: str + folder_id: Nullable[str] + envelope_id: str + template_document_data: TemplateCreateTemplateTemporaryTemplateDocumentDataTypedDict + template_meta: TemplateCreateTemplateTemporaryTemplateMetaTypedDict + direct_link: Nullable[TemplateCreateTemplateTemporaryDirectLinkTypedDict] + user: TemplateCreateTemplateTemporaryUserTypedDict + recipients: List[TemplateCreateTemplateTemporaryRecipientTypedDict] + fields: List[TemplateCreateTemplateTemporaryFieldTypedDict] + folder: Nullable[TemplateCreateTemplateTemporaryFolderTypedDict] + template_document_data_id: NotRequired[str] + + +class TemplateCreateTemplateTemporaryTemplate(BaseModel): + type: TemplateCreateTemplateTemporaryTypeResponse + + visibility: TemplateCreateTemplateTemporaryVisibilityResponse + + id: float + + external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] + + title: str + + user_id: Annotated[float, pydantic.Field(alias="userId")] + + team_id: Annotated[float, pydantic.Field(alias="teamId")] + + auth_options: Annotated[ + Nullable[TemplateCreateTemplateTemporaryAuthOptions], + pydantic.Field(alias="authOptions"), + ] + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] + + public_title: Annotated[str, pydantic.Field(alias="publicTitle")] + + public_description: Annotated[str, pydantic.Field(alias="publicDescription")] + + folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + template_document_data: Annotated[ + TemplateCreateTemplateTemporaryTemplateDocumentData, + pydantic.Field(alias="templateDocumentData"), + ] + + template_meta: Annotated[ + TemplateCreateTemplateTemporaryTemplateMeta, + pydantic.Field(alias="templateMeta"), + ] + + direct_link: Annotated[ + Nullable[TemplateCreateTemplateTemporaryDirectLink], + pydantic.Field(alias="directLink"), + ] + + user: TemplateCreateTemplateTemporaryUser + + recipients: List[TemplateCreateTemplateTemporaryRecipient] + + fields: List[TemplateCreateTemplateTemporaryField] + + folder: Nullable[TemplateCreateTemplateTemporaryFolder] + + template_document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="templateDocumentDataId") + ] = "" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["templateDocumentDataId"] + nullable_fields = [ + "externalId", + "authOptions", + "folderId", + "directLink", + "folder", + ] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + + +class TemplateCreateTemplateTemporaryResponseTypedDict(TypedDict): + r"""Successful response""" + + template: TemplateCreateTemplateTemporaryTemplateTypedDict + upload_url: str + + +class TemplateCreateTemplateTemporaryResponse(BaseModel): + r"""Successful response""" + + template: TemplateCreateTemplateTemporaryTemplate + + upload_url: Annotated[str, pydantic.Field(alias="uploadUrl")] diff --git a/src/documenso_sdk/models/template_deletetemplatedirectlinkop.py b/src/documenso_sdk/models/template_deletetemplatedirectlinkop.py index 35f38a4..d878d94 100644 --- a/src/documenso_sdk/models/template_deletetemplatedirectlinkop.py +++ b/src/documenso_sdk/models/template_deletetemplatedirectlinkop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -35,10 +36,11 @@ class TemplateDeleteTemplateDirectLinkInternalServerErrorData(BaseModel): ) +@dataclass(unsafe_hash=True) class TemplateDeleteTemplateDirectLinkInternalServerError(DocumensoError): r"""Internal server error""" - data: TemplateDeleteTemplateDirectLinkInternalServerErrorData + data: TemplateDeleteTemplateDirectLinkInternalServerErrorData = field(hash=False) def __init__( self, @@ -49,7 +51,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateDeleteTemplateDirectLinkBadRequestIssueTypedDict(TypedDict): @@ -68,10 +70,11 @@ class TemplateDeleteTemplateDirectLinkBadRequestErrorData(BaseModel): issues: Optional[List[TemplateDeleteTemplateDirectLinkBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class TemplateDeleteTemplateDirectLinkBadRequestError(DocumensoError): r"""Invalid input data""" - data: TemplateDeleteTemplateDirectLinkBadRequestErrorData + data: TemplateDeleteTemplateDirectLinkBadRequestErrorData = field(hash=False) def __init__( self, @@ -82,7 +85,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateDeleteTemplateDirectLinkResponseTypedDict(TypedDict): diff --git a/src/documenso_sdk/models/template_deletetemplateop.py b/src/documenso_sdk/models/template_deletetemplateop.py index d8777e1..54d0692 100644 --- a/src/documenso_sdk/models/template_deletetemplateop.py +++ b/src/documenso_sdk/models/template_deletetemplateop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -33,10 +34,11 @@ class TemplateDeleteTemplateInternalServerErrorData(BaseModel): issues: Optional[List[TemplateDeleteTemplateInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class TemplateDeleteTemplateInternalServerError(DocumensoError): r"""Internal server error""" - data: TemplateDeleteTemplateInternalServerErrorData + data: TemplateDeleteTemplateInternalServerErrorData = field(hash=False) def __init__( self, @@ -47,7 +49,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateDeleteTemplateBadRequestIssueTypedDict(TypedDict): @@ -66,10 +68,11 @@ class TemplateDeleteTemplateBadRequestErrorData(BaseModel): issues: Optional[List[TemplateDeleteTemplateBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class TemplateDeleteTemplateBadRequestError(DocumensoError): r"""Invalid input data""" - data: TemplateDeleteTemplateBadRequestErrorData + data: TemplateDeleteTemplateBadRequestErrorData = field(hash=False) def __init__( self, @@ -80,7 +83,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateDeleteTemplateResponseTypedDict(TypedDict): diff --git a/src/documenso_sdk/models/template_duplicatetemplateop.py b/src/documenso_sdk/models/template_duplicatetemplateop.py index 395c528..e0836e7 100644 --- a/src/documenso_sdk/models/template_duplicatetemplateop.py +++ b/src/documenso_sdk/models/template_duplicatetemplateop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL from enum import Enum @@ -8,7 +9,7 @@ import pydantic from pydantic import model_serializer from typing import List, Optional -from typing_extensions import Annotated, TypedDict +from typing_extensions import Annotated, NotRequired, TypedDict class TemplateDuplicateTemplateRequestTypedDict(TypedDict): @@ -35,10 +36,11 @@ class TemplateDuplicateTemplateInternalServerErrorData(BaseModel): issues: Optional[List[TemplateDuplicateTemplateInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class TemplateDuplicateTemplateInternalServerError(DocumensoError): r"""Internal server error""" - data: TemplateDuplicateTemplateInternalServerErrorData + data: TemplateDuplicateTemplateInternalServerErrorData = field(hash=False) def __init__( self, @@ -49,7 +51,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateDuplicateTemplateBadRequestIssueTypedDict(TypedDict): @@ -68,10 +70,11 @@ class TemplateDuplicateTemplateBadRequestErrorData(BaseModel): issues: Optional[List[TemplateDuplicateTemplateBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class TemplateDuplicateTemplateBadRequestError(DocumensoError): r"""Invalid input data""" - data: TemplateDuplicateTemplateBadRequestErrorData + data: TemplateDuplicateTemplateBadRequestErrorData = field(hash=False) def __init__( self, @@ -82,7 +85,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateDuplicateTemplateType(str, Enum): @@ -100,6 +103,7 @@ class TemplateDuplicateTemplateGlobalAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class TemplateDuplicateTemplateGlobalActionAuth(str, Enum): @@ -139,13 +143,14 @@ class TemplateDuplicateTemplateResponseTypedDict(TypedDict): user_id: float team_id: float auth_options: Nullable[TemplateDuplicateTemplateAuthOptionsTypedDict] - template_document_data_id: str created_at: str updated_at: str public_title: str public_description: str folder_id: Nullable[str] use_legacy_field_insertion: bool + envelope_id: str + template_document_data_id: NotRequired[str] class TemplateDuplicateTemplateResponse(BaseModel): @@ -170,10 +175,6 @@ class TemplateDuplicateTemplateResponse(BaseModel): pydantic.Field(alias="authOptions"), ] - template_document_data_id: Annotated[ - str, pydantic.Field(alias="templateDocumentDataId") - ] - created_at: Annotated[str, pydantic.Field(alias="createdAt")] updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] @@ -188,9 +189,15 @@ class TemplateDuplicateTemplateResponse(BaseModel): bool, pydantic.Field(alias="useLegacyFieldInsertion") ] + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + template_document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="templateDocumentDataId") + ] = "" + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["templateDocumentDataId"] nullable_fields = ["externalId", "authOptions", "folderId"] null_default_fields = [] diff --git a/src/documenso_sdk/models/template_findtemplatesop.py b/src/documenso_sdk/models/template_findtemplatesop.py index b964a20..ca5c9b1 100644 --- a/src/documenso_sdk/models/template_findtemplatesop.py +++ b/src/documenso_sdk/models/template_findtemplatesop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from documenso_sdk.utils import FieldMetadata, QueryParamMetadata from enum import Enum import httpx @@ -82,10 +89,11 @@ class TemplateFindTemplatesInternalServerErrorData(BaseModel): issues: Optional[List[TemplateFindTemplatesInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class TemplateFindTemplatesInternalServerError(DocumensoError): r"""Internal server error""" - data: TemplateFindTemplatesInternalServerErrorData + data: TemplateFindTemplatesInternalServerErrorData = field(hash=False) def __init__( self, @@ -96,7 +104,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateFindTemplatesNotFoundIssueTypedDict(TypedDict): @@ -115,10 +123,11 @@ class TemplateFindTemplatesNotFoundErrorData(BaseModel): issues: Optional[List[TemplateFindTemplatesNotFoundIssue]] = None +@dataclass(unsafe_hash=True) class TemplateFindTemplatesNotFoundError(DocumensoError): r"""Not found""" - data: TemplateFindTemplatesNotFoundErrorData + data: TemplateFindTemplatesNotFoundErrorData = field(hash=False) def __init__( self, @@ -129,7 +138,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateFindTemplatesBadRequestIssueTypedDict(TypedDict): @@ -148,10 +157,11 @@ class TemplateFindTemplatesBadRequestErrorData(BaseModel): issues: Optional[List[TemplateFindTemplatesBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class TemplateFindTemplatesBadRequestError(DocumensoError): r"""Invalid input data""" - data: TemplateFindTemplatesBadRequestErrorData + data: TemplateFindTemplatesBadRequestErrorData = field(hash=False) def __init__( self, @@ -162,7 +172,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateFindTemplatesDataType(str, Enum): @@ -180,6 +190,7 @@ class TemplateFindTemplatesGlobalAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class TemplateFindTemplatesGlobalActionAuth(str, Enum): @@ -289,6 +300,11 @@ class TemplateFindTemplatesValue2(BaseModel): value: str +class TemplateFindTemplatesDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class TemplateFindTemplatesFieldMetaCheckboxTypedDict(TypedDict): type: TemplateFindTemplatesTypeCheckbox label: NotRequired[str] @@ -298,6 +314,7 @@ class TemplateFindTemplatesFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[TemplateFindTemplatesValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[TemplateFindTemplatesDirection] class TemplateFindTemplatesFieldMetaCheckbox(BaseModel): @@ -321,6 +338,10 @@ class TemplateFindTemplatesFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[TemplateFindTemplatesDirection] = ( + TemplateFindTemplatesDirection.VERTICAL + ) + class TemplateFindTemplatesTypeRadio(str, Enum): RADIO = "radio" @@ -379,10 +400,10 @@ class TemplateFindTemplatesFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[TemplateFindTemplatesTextAlign6] @@ -398,13 +419,19 @@ class TemplateFindTemplatesFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -412,6 +439,47 @@ class TemplateFindTemplatesFieldMetaNumber(BaseModel): Optional[TemplateFindTemplatesTextAlign6], pydantic.Field(alias="textAlign") ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class TemplateFindTemplatesTypeText(str, Enum): TEXT = "text" @@ -620,8 +688,8 @@ class TemplateFindTemplatesFieldMetaInitials(BaseModel): TemplateFindTemplatesFieldMetaEmailTypedDict, TemplateFindTemplatesFieldMetaDateTypedDict, TemplateFindTemplatesFieldMetaDropdownTypedDict, - TemplateFindTemplatesFieldMetaCheckboxTypedDict, TemplateFindTemplatesFieldMetaTextTypedDict, + TemplateFindTemplatesFieldMetaCheckboxTypedDict, TemplateFindTemplatesFieldMetaNumberTypedDict, ], ) @@ -636,19 +704,19 @@ class TemplateFindTemplatesFieldMetaInitials(BaseModel): TemplateFindTemplatesFieldMetaEmail, TemplateFindTemplatesFieldMetaDate, TemplateFindTemplatesFieldMetaDropdown, - TemplateFindTemplatesFieldMetaCheckbox, TemplateFindTemplatesFieldMetaText, + TemplateFindTemplatesFieldMetaCheckbox, TemplateFindTemplatesFieldMetaNumber, ], ) class TemplateFindTemplatesFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: TemplateFindTemplatesFieldType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -659,19 +727,21 @@ class TemplateFindTemplatesFieldTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class TemplateFindTemplatesField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: TemplateFindTemplatesFieldType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -693,10 +763,25 @@ class TemplateFindTemplatesField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -752,6 +837,7 @@ class TemplateFindTemplatesAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class TemplateFindTemplatesActionAuth(str, Enum): @@ -780,13 +866,12 @@ class TemplateFindTemplatesRecipientAuthOptions(BaseModel): class TemplateFindTemplatesRecipientTypedDict(TypedDict): + envelope_id: str role: TemplateFindTemplatesRole read_status: TemplateFindTemplatesReadStatus signing_status: TemplateFindTemplatesSigningStatus send_status: TemplateFindTemplatesSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -797,9 +882,13 @@ class TemplateFindTemplatesRecipientTypedDict(TypedDict): signing_order: Nullable[float] r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class TemplateFindTemplatesRecipient(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: TemplateFindTemplatesRole read_status: Annotated[ @@ -816,10 +905,6 @@ class TemplateFindTemplatesRecipient(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -844,18 +929,26 @@ class TemplateFindTemplatesRecipient(BaseModel): rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -895,14 +988,13 @@ class TemplateFindTemplatesDistributionMethod(str, Enum): class TemplateFindTemplatesTemplateMetaTypedDict(TypedDict): - signing_order: Nullable[TemplateFindTemplatesSigningOrder] + signing_order: TemplateFindTemplatesSigningOrder distribution_method: TemplateFindTemplatesDistributionMethod class TemplateFindTemplatesTemplateMeta(BaseModel): signing_order: Annotated[ - Nullable[TemplateFindTemplatesSigningOrder], - pydantic.Field(alias="signingOrder"), + TemplateFindTemplatesSigningOrder, pydantic.Field(alias="signingOrder") ] distribution_method: Annotated[ @@ -910,36 +1002,6 @@ class TemplateFindTemplatesTemplateMeta(BaseModel): pydantic.Field(alias="distributionMethod"), ] - @model_serializer(mode="wrap") - def serialize_model(self, handler): - optional_fields = [] - nullable_fields = ["signingOrder"] - null_default_fields = [] - - serialized = handler(self) - - m = {} - - for n, f in type(self).model_fields.items(): - k = f.alias or n - val = serialized.get(k) - serialized.pop(k, None) - - optional_nullable = k in optional_fields and k in nullable_fields - is_set = ( - self.__pydantic_fields_set__.intersection({n}) - or k in null_default_fields - ) # pylint: disable=no-member - - if val is not None and val != UNSET_SENTINEL: - m[k] = val - elif val != UNSET_SENTINEL and ( - not k in optional_fields or (optional_nullable and is_set) - ): - m[k] = val - - return m - class TemplateFindTemplatesDirectLinkTypedDict(TypedDict): token: str @@ -961,18 +1023,19 @@ class TemplateFindTemplatesDataTypedDict(TypedDict): user_id: float team_id: float auth_options: Nullable[TemplateFindTemplatesAuthOptionsTypedDict] - template_document_data_id: str created_at: str updated_at: str public_title: str public_description: str folder_id: Nullable[str] use_legacy_field_insertion: bool + envelope_id: str team: Nullable[TemplateFindTemplatesTeamTypedDict] fields: List[TemplateFindTemplatesFieldTypedDict] recipients: List[TemplateFindTemplatesRecipientTypedDict] template_meta: Nullable[TemplateFindTemplatesTemplateMetaTypedDict] direct_link: Nullable[TemplateFindTemplatesDirectLinkTypedDict] + template_document_data_id: NotRequired[str] class TemplateFindTemplatesData(BaseModel): @@ -994,10 +1057,6 @@ class TemplateFindTemplatesData(BaseModel): Nullable[TemplateFindTemplatesAuthOptions], pydantic.Field(alias="authOptions") ] - template_document_data_id: Annotated[ - str, pydantic.Field(alias="templateDocumentDataId") - ] - created_at: Annotated[str, pydantic.Field(alias="createdAt")] updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] @@ -1012,6 +1071,8 @@ class TemplateFindTemplatesData(BaseModel): bool, pydantic.Field(alias="useLegacyFieldInsertion") ] + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + team: Nullable[TemplateFindTemplatesTeam] fields: List[TemplateFindTemplatesField] @@ -1027,9 +1088,13 @@ class TemplateFindTemplatesData(BaseModel): Nullable[TemplateFindTemplatesDirectLink], pydantic.Field(alias="directLink") ] + template_document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="templateDocumentDataId") + ] = "" + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["templateDocumentDataId"] nullable_fields = [ "externalId", "authOptions", diff --git a/src/documenso_sdk/models/template_gettemplatebyidop.py b/src/documenso_sdk/models/template_gettemplatebyidop.py index 329fe18..f5ca208 100644 --- a/src/documenso_sdk/models/template_gettemplatebyidop.py +++ b/src/documenso_sdk/models/template_gettemplatebyidop.py @@ -1,8 +1,15 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError -from documenso_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from documenso_sdk.types import ( + BaseModel, + Nullable, + OptionalNullable, + UNSET, + UNSET_SENTINEL, +) from documenso_sdk.utils import FieldMetadata, PathParamMetadata from enum import Enum import httpx @@ -40,10 +47,11 @@ class TemplateGetTemplateByIDInternalServerErrorData(BaseModel): issues: Optional[List[TemplateGetTemplateByIDInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class TemplateGetTemplateByIDInternalServerError(DocumensoError): r"""Internal server error""" - data: TemplateGetTemplateByIDInternalServerErrorData + data: TemplateGetTemplateByIDInternalServerErrorData = field(hash=False) def __init__( self, @@ -54,7 +62,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateGetTemplateByIDNotFoundIssueTypedDict(TypedDict): @@ -73,10 +81,11 @@ class TemplateGetTemplateByIDNotFoundErrorData(BaseModel): issues: Optional[List[TemplateGetTemplateByIDNotFoundIssue]] = None +@dataclass(unsafe_hash=True) class TemplateGetTemplateByIDNotFoundError(DocumensoError): r"""Not found""" - data: TemplateGetTemplateByIDNotFoundErrorData + data: TemplateGetTemplateByIDNotFoundErrorData = field(hash=False) def __init__( self, @@ -87,7 +96,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateGetTemplateByIDBadRequestIssueTypedDict(TypedDict): @@ -106,10 +115,11 @@ class TemplateGetTemplateByIDBadRequestErrorData(BaseModel): issues: Optional[List[TemplateGetTemplateByIDBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class TemplateGetTemplateByIDBadRequestError(DocumensoError): r"""Invalid input data""" - data: TemplateGetTemplateByIDBadRequestErrorData + data: TemplateGetTemplateByIDBadRequestErrorData = field(hash=False) def __init__( self, @@ -120,7 +130,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateGetTemplateByIDType(str, Enum): @@ -138,6 +148,7 @@ class TemplateGetTemplateByIDGlobalAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class TemplateGetTemplateByIDGlobalActionAuth(str, Enum): @@ -166,21 +177,22 @@ class TemplateGetTemplateByIDAuthOptions(BaseModel): ] -class TemplateDocumentDataType(str, Enum): +class TemplateGetTemplateByIDTemplateDocumentDataType(str, Enum): S3_PATH = "S3_PATH" BYTES = "BYTES" BYTES_64 = "BYTES_64" -class TemplateDocumentDataTypedDict(TypedDict): - type: TemplateDocumentDataType +class TemplateGetTemplateByIDTemplateDocumentDataTypedDict(TypedDict): + type: TemplateGetTemplateByIDTemplateDocumentDataType id: str data: str initial_data: str + envelope_item_id: str -class TemplateDocumentData(BaseModel): - type: TemplateDocumentDataType +class TemplateGetTemplateByIDTemplateDocumentData(BaseModel): + type: TemplateGetTemplateByIDTemplateDocumentDataType id: str @@ -188,6 +200,8 @@ class TemplateDocumentData(BaseModel): initial_data: Annotated[str, pydantic.Field(alias="initialData")] + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + class TemplateGetTemplateByIDSigningOrder(str, Enum): PARALLEL = "PARALLEL" @@ -259,16 +273,18 @@ class TemplateGetTemplateByIDTemplateMetaTypedDict(TypedDict): message: Nullable[str] timezone: Nullable[str] date_format: Nullable[str] - signing_order: Nullable[TemplateGetTemplateByIDSigningOrder] + signing_order: TemplateGetTemplateByIDSigningOrder typed_signature_enabled: bool upload_signature_enabled: bool draw_signature_enabled: bool allow_dictate_next_signer: bool distribution_method: TemplateGetTemplateByIDDistributionMethod - template_id: float redirect_url: Nullable[str] language: str email_settings: Nullable[TemplateGetTemplateByIDEmailSettingsTypedDict] + email_id: Nullable[str] + email_reply_to: Nullable[str] + template_id: Nullable[float] class TemplateGetTemplateByIDTemplateMeta(BaseModel): @@ -283,8 +299,7 @@ class TemplateGetTemplateByIDTemplateMeta(BaseModel): date_format: Annotated[Nullable[str], pydantic.Field(alias="dateFormat")] signing_order: Annotated[ - Nullable[TemplateGetTemplateByIDSigningOrder], - pydantic.Field(alias="signingOrder"), + TemplateGetTemplateByIDSigningOrder, pydantic.Field(alias="signingOrder") ] typed_signature_enabled: Annotated[ @@ -308,8 +323,6 @@ class TemplateGetTemplateByIDTemplateMeta(BaseModel): pydantic.Field(alias="distributionMethod"), ] - template_id: Annotated[float, pydantic.Field(alias="templateId")] - redirect_url: Annotated[Nullable[str], pydantic.Field(alias="redirectUrl")] language: str @@ -319,6 +332,12 @@ class TemplateGetTemplateByIDTemplateMeta(BaseModel): pydantic.Field(alias="emailSettings"), ] + email_id: Annotated[Nullable[str], pydantic.Field(alias="emailId")] + + email_reply_to: Annotated[Nullable[str], pydantic.Field(alias="emailReplyTo")] + + template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [] @@ -327,9 +346,11 @@ def serialize_model(self, handler): "message", "timezone", "dateFormat", - "signingOrder", "redirectUrl", "emailSettings", + "emailId", + "emailReplyTo", + "templateId", ] null_default_fields = [] @@ -360,17 +381,18 @@ def serialize_model(self, handler): class TemplateGetTemplateByIDDirectLinkTypedDict(TypedDict): id: str - template_id: float + envelope_id: str token: str created_at: str enabled: bool direct_template_recipient_id: float + template_id: float class TemplateGetTemplateByIDDirectLink(BaseModel): id: str - template_id: Annotated[float, pydantic.Field(alias="templateId")] + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] token: str @@ -382,6 +404,8 @@ class TemplateGetTemplateByIDDirectLink(BaseModel): float, pydantic.Field(alias="directTemplateRecipientId") ] + template_id: Annotated[float, pydantic.Field(alias="templateId")] + class TemplateGetTemplateByIDUserTypedDict(TypedDict): id: float @@ -455,6 +479,7 @@ class TemplateGetTemplateByIDAccessAuth(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class TemplateGetTemplateByIDActionAuth(str, Enum): @@ -483,13 +508,12 @@ class TemplateGetTemplateByIDRecipientAuthOptions(BaseModel): class TemplateGetTemplateByIDRecipientTypedDict(TypedDict): + envelope_id: str role: TemplateGetTemplateByIDRole read_status: TemplateGetTemplateByIDReadStatus signing_status: TemplateGetTemplateByIDSigningStatus send_status: TemplateGetTemplateByIDSendStatus id: float - document_id: Nullable[float] - template_id: Nullable[float] email: str name: str token: str @@ -500,9 +524,13 @@ class TemplateGetTemplateByIDRecipientTypedDict(TypedDict): signing_order: Nullable[float] r"""The order in which the recipient should sign the document. Only works if the document is set to sequential signing.""" rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class TemplateGetTemplateByIDRecipient(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + role: TemplateGetTemplateByIDRole read_status: Annotated[ @@ -519,10 +547,6 @@ class TemplateGetTemplateByIDRecipient(BaseModel): id: float - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - email: str name: str @@ -547,18 +571,26 @@ class TemplateGetTemplateByIDRecipient(BaseModel): rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -657,6 +689,11 @@ class TemplateGetTemplateByIDValue2(BaseModel): value: str +class TemplateGetTemplateByIDDirection(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class TemplateGetTemplateByIDFieldMetaCheckboxTypedDict(TypedDict): type: TemplateGetTemplateByIDTypeCheckbox label: NotRequired[str] @@ -666,6 +703,7 @@ class TemplateGetTemplateByIDFieldMetaCheckboxTypedDict(TypedDict): values: NotRequired[List[TemplateGetTemplateByIDValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[TemplateGetTemplateByIDDirection] class TemplateGetTemplateByIDFieldMetaCheckbox(BaseModel): @@ -689,6 +727,10 @@ class TemplateGetTemplateByIDFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[TemplateGetTemplateByIDDirection] = ( + TemplateGetTemplateByIDDirection.VERTICAL + ) + class TemplateGetTemplateByIDTypeRadio(str, Enum): RADIO = "radio" @@ -747,10 +789,10 @@ class TemplateGetTemplateByIDFieldMetaNumberTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] + number_format: NotRequired[Nullable[str]] value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] font_size: NotRequired[float] text_align: NotRequired[TemplateGetTemplateByIDTextAlign6] @@ -766,13 +808,19 @@ class TemplateGetTemplateByIDFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET value: Optional[str] = None - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None @@ -780,6 +828,47 @@ class TemplateGetTemplateByIDFieldMetaNumber(BaseModel): Optional[TemplateGetTemplateByIDTextAlign6], pydantic.Field(alias="textAlign") ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "numberFormat", + "value", + "minValue", + "maxValue", + "fontSize", + "textAlign", + ] + nullable_fields = ["numberFormat", "minValue", "maxValue"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class TemplateGetTemplateByIDTypeText(str, Enum): TEXT = "text" @@ -988,8 +1077,8 @@ class TemplateGetTemplateByIDFieldMetaInitials(BaseModel): TemplateGetTemplateByIDFieldMetaEmailTypedDict, TemplateGetTemplateByIDFieldMetaDateTypedDict, TemplateGetTemplateByIDFieldMetaDropdownTypedDict, - TemplateGetTemplateByIDFieldMetaCheckboxTypedDict, TemplateGetTemplateByIDFieldMetaTextTypedDict, + TemplateGetTemplateByIDFieldMetaCheckboxTypedDict, TemplateGetTemplateByIDFieldMetaNumberTypedDict, ], ) @@ -1004,19 +1093,19 @@ class TemplateGetTemplateByIDFieldMetaInitials(BaseModel): TemplateGetTemplateByIDFieldMetaEmail, TemplateGetTemplateByIDFieldMetaDate, TemplateGetTemplateByIDFieldMetaDropdown, - TemplateGetTemplateByIDFieldMetaCheckbox, TemplateGetTemplateByIDFieldMetaText, + TemplateGetTemplateByIDFieldMetaCheckbox, TemplateGetTemplateByIDFieldMetaNumber, ], ) class TemplateGetTemplateByIDFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str type: TemplateGetTemplateByIDFieldType id: float secondary_id: str - document_id: Nullable[float] - template_id: Nullable[float] recipient_id: float page: float r"""The page number of the field on the document. Starts from 1.""" @@ -1027,19 +1116,21 @@ class TemplateGetTemplateByIDFieldTypedDict(TypedDict): position_y: NotRequired[Any] width: NotRequired[Any] height: NotRequired[Any] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] class TemplateGetTemplateByIDField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + type: TemplateGetTemplateByIDFieldType id: float secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] - document_id: Annotated[Nullable[float], pydantic.Field(alias="documentId")] - - template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] - recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] page: float @@ -1062,10 +1153,25 @@ class TemplateGetTemplateByIDField(BaseModel): height: Optional[Any] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] + optional_fields = [ + "positionX", + "positionY", + "width", + "height", + "documentId", + "templateId", + ] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -1180,19 +1286,20 @@ class TemplateGetTemplateByIDResponseTypedDict(TypedDict): user_id: float team_id: float auth_options: Nullable[TemplateGetTemplateByIDAuthOptionsTypedDict] - template_document_data_id: str created_at: str updated_at: str public_title: str public_description: str folder_id: Nullable[str] - template_document_data: TemplateDocumentDataTypedDict - template_meta: Nullable[TemplateGetTemplateByIDTemplateMetaTypedDict] + envelope_id: str + template_document_data: TemplateGetTemplateByIDTemplateDocumentDataTypedDict + template_meta: TemplateGetTemplateByIDTemplateMetaTypedDict direct_link: Nullable[TemplateGetTemplateByIDDirectLinkTypedDict] user: TemplateGetTemplateByIDUserTypedDict recipients: List[TemplateGetTemplateByIDRecipientTypedDict] fields: List[TemplateGetTemplateByIDFieldTypedDict] folder: Nullable[TemplateGetTemplateByIDFolderTypedDict] + template_document_data_id: NotRequired[str] class TemplateGetTemplateByIDResponse(BaseModel): @@ -1217,10 +1324,6 @@ class TemplateGetTemplateByIDResponse(BaseModel): pydantic.Field(alias="authOptions"), ] - template_document_data_id: Annotated[ - str, pydantic.Field(alias="templateDocumentDataId") - ] - created_at: Annotated[str, pydantic.Field(alias="createdAt")] updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] @@ -1231,13 +1334,15 @@ class TemplateGetTemplateByIDResponse(BaseModel): folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + template_document_data: Annotated[ - TemplateDocumentData, pydantic.Field(alias="templateDocumentData") + TemplateGetTemplateByIDTemplateDocumentData, + pydantic.Field(alias="templateDocumentData"), ] template_meta: Annotated[ - Nullable[TemplateGetTemplateByIDTemplateMeta], - pydantic.Field(alias="templateMeta"), + TemplateGetTemplateByIDTemplateMeta, pydantic.Field(alias="templateMeta") ] direct_link: Annotated[ @@ -1252,14 +1357,17 @@ class TemplateGetTemplateByIDResponse(BaseModel): folder: Nullable[TemplateGetTemplateByIDFolder] + template_document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="templateDocumentDataId") + ] = "" + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["templateDocumentDataId"] nullable_fields = [ "externalId", "authOptions", "folderId", - "templateMeta", "directLink", "folder", ] diff --git a/src/documenso_sdk/models/template_toggletemplatedirectlinkop.py b/src/documenso_sdk/models/template_toggletemplatedirectlinkop.py index b5d8f11..bb19384 100644 --- a/src/documenso_sdk/models/template_toggletemplatedirectlinkop.py +++ b/src/documenso_sdk/models/template_toggletemplatedirectlinkop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import BaseModel import httpx @@ -38,10 +39,11 @@ class TemplateToggleTemplateDirectLinkInternalServerErrorData(BaseModel): ) +@dataclass(unsafe_hash=True) class TemplateToggleTemplateDirectLinkInternalServerError(DocumensoError): r"""Internal server error""" - data: TemplateToggleTemplateDirectLinkInternalServerErrorData + data: TemplateToggleTemplateDirectLinkInternalServerErrorData = field(hash=False) def __init__( self, @@ -52,7 +54,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateToggleTemplateDirectLinkBadRequestIssueTypedDict(TypedDict): @@ -71,10 +73,11 @@ class TemplateToggleTemplateDirectLinkBadRequestErrorData(BaseModel): issues: Optional[List[TemplateToggleTemplateDirectLinkBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class TemplateToggleTemplateDirectLinkBadRequestError(DocumensoError): r"""Invalid input data""" - data: TemplateToggleTemplateDirectLinkBadRequestErrorData + data: TemplateToggleTemplateDirectLinkBadRequestErrorData = field(hash=False) def __init__( self, @@ -85,18 +88,19 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateToggleTemplateDirectLinkResponseTypedDict(TypedDict): r"""Successful response""" id: str - template_id: float token: str created_at: str enabled: bool direct_template_recipient_id: float + envelope_id: str + template_id: float class TemplateToggleTemplateDirectLinkResponse(BaseModel): @@ -104,8 +108,6 @@ class TemplateToggleTemplateDirectLinkResponse(BaseModel): id: str - template_id: Annotated[float, pydantic.Field(alias="templateId")] - token: str created_at: Annotated[str, pydantic.Field(alias="createdAt")] @@ -115,3 +117,7 @@ class TemplateToggleTemplateDirectLinkResponse(BaseModel): direct_template_recipient_id: Annotated[ float, pydantic.Field(alias="directTemplateRecipientId") ] + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + template_id: Annotated[float, pydantic.Field(alias="templateId")] diff --git a/src/documenso_sdk/models/template_updatetemplateop.py b/src/documenso_sdk/models/template_updatetemplateop.py index 4a2c4c7..c5920bb 100644 --- a/src/documenso_sdk/models/template_updatetemplateop.py +++ b/src/documenso_sdk/models/template_updatetemplateop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from dataclasses import dataclass, field from documenso_sdk.models import DocumensoError from documenso_sdk.types import ( BaseModel, @@ -27,6 +28,7 @@ class TemplateUpdateTemplateGlobalAccessAuthRequest(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class TemplateUpdateTemplateGlobalActionAuthRequest(str, Enum): @@ -45,6 +47,7 @@ class TemplateUpdateTemplateDataType(str, Enum): class TemplateUpdateTemplateDataTypedDict(TypedDict): title: NotRequired[str] + r"""The title of the document.""" external_id: NotRequired[Nullable[str]] visibility: NotRequired[TemplateUpdateTemplateVisibilityRequest] global_access_auth: NotRequired[List[TemplateUpdateTemplateGlobalAccessAuthRequest]] @@ -55,10 +58,12 @@ class TemplateUpdateTemplateDataTypedDict(TypedDict): r"""The description of the template that will be displayed to the public. Only applicable for public templates.""" type: NotRequired[TemplateUpdateTemplateDataType] use_legacy_field_insertion: NotRequired[bool] + folder_id: NotRequired[Nullable[str]] class TemplateUpdateTemplateData(BaseModel): title: Optional[str] = None + r"""The title of the document.""" external_id: Annotated[ OptionalNullable[str], pydantic.Field(alias="externalId") @@ -90,6 +95,10 @@ class TemplateUpdateTemplateData(BaseModel): Optional[bool], pydantic.Field(alias="useLegacyFieldInsertion") ] = None + folder_id: Annotated[OptionalNullable[str], pydantic.Field(alias="folderId")] = ( + UNSET + ) + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ @@ -102,8 +111,9 @@ def serialize_model(self, handler): "publicDescription", "type", "useLegacyFieldInsertion", + "folderId", ] - nullable_fields = ["externalId"] + nullable_fields = ["externalId", "folderId"] null_default_fields = [] serialized = handler(self) @@ -134,16 +144,28 @@ def serialize_model(self, handler): class TemplateUpdateTemplateDateFormat(str, Enum): r"""The date format to use for date fields and signing the document.""" - YYYY_MM_DD_HH_MM_A = "yyyy-MM-dd hh:mm a" - YYYY_MM_DD = "yyyy-MM-dd" - DD_MM_YYYY_HH_MM_A = "dd/MM/yyyy hh:mm a" - MM_DD_YYYY_HH_MM_A = "MM/dd/yyyy hh:mm a" - YYYY_MM_DD_HH_MM = "yyyy-MM-dd HH:mm" - YY_MM_DD_HH_MM_A = "yy-MM-dd hh:mm a" - YYYY_MM_DD_HH_MM_SS = "yyyy-MM-dd HH:mm:ss" - MMMM_DD_YYYY_HH_MM_A = "MMMM dd, yyyy hh:mm a" - EEEE_MMMM_DD_YYYY_HH_MM_A = "EEEE, MMMM dd, yyyy hh:mm a" - YYYY_MM_DD_T_HH_MM_SS_SSSXXX = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" + YYYY_M_MDD_HH_MM_A = "yyyy-MM-dd hh:mm a" + YYYY_M_MDD = "yyyy-MM-dd" + DD_MM_SLASH_YYYY = "dd/MM/yyyy" + MM_DD_SLASH_YYYY = "MM/dd/yyyy" + YY_M_MDD = "yy-MM-dd" + MMMM_DD_COMMA_YYYY = "MMMM dd, yyyy" + EEEE_MMMM_DD_COMMA_YYYY = "EEEE, MMMM dd, yyyy" + DD_MM_SLASH_YYYY_HH_MM_A = "dd/MM/yyyy hh:mm a" + DD_MM_SLASH_YYYY_H_HMM = "dd/MM/yyyy HH:mm" + MM_DD_SLASH_YYYY_HH_MM_A = "MM/dd/yyyy hh:mm a" + MM_DD_SLASH_YYYY_H_HMM = "MM/dd/yyyy HH:mm" + DD_DOT_MM_DOT_YYYY = "dd.MM.yyyy" + DD_DOT_MM_DOT_YYYY_H_HMM = "dd.MM.yyyy HH:mm" + YYYY_M_MDD_H_HMM = "yyyy-MM-dd HH:mm" + YY_M_MDD_HH_MM_A = "yy-MM-dd hh:mm a" + YY_M_MDD_H_HMM = "yy-MM-dd HH:mm" + YYYY_M_MDD_H_HMMSS = "yyyy-MM-dd HH:mm:ss" + MMMM_DD_COMMA_YYYY_HH_MM_A = "MMMM dd, yyyy hh:mm a" + MMMM_DD_COMMA_YYYY_H_HMM = "MMMM dd, yyyy HH:mm" + EEEE_MMMM_DD_COMMA_YYYY_HH_MM_A = "EEEE, MMMM dd, yyyy hh:mm a" + EEEE_MMMM_DD_COMMA_YYYY_H_HMM = "EEEE, MMMM dd, yyyy HH:mm" + ISO8601_FULL = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" class TemplateUpdateTemplateDistributionMethod(str, Enum): @@ -234,6 +256,8 @@ class TemplateUpdateTemplateMetaTypedDict(TypedDict): r"""The date format to use for date fields and signing the document.""" distribution_method: NotRequired[TemplateUpdateTemplateDistributionMethod] r"""The distribution method to use when sending the document to the recipients.""" + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] email_settings: NotRequired[TemplateUpdateTemplateEmailSettingsTypedDict] redirect_url: NotRequired[str] r"""The URL to which the recipient should be redirected after signing the document.""" @@ -270,6 +294,12 @@ class TemplateUpdateTemplateMeta(BaseModel): ] = None r"""The distribution method to use when sending the document to the recipients.""" + email_id: Annotated[OptionalNullable[str], pydantic.Field(alias="emailId")] = UNSET + + email_reply_to: Annotated[ + OptionalNullable[str], pydantic.Field(alias="emailReplyTo") + ] = UNSET + email_settings: Annotated[ Optional[TemplateUpdateTemplateEmailSettings], pydantic.Field(alias="emailSettings"), @@ -305,6 +335,52 @@ class TemplateUpdateTemplateMeta(BaseModel): Optional[bool], pydantic.Field(alias="allowDictateNextSigner") ] = None + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "subject", + "message", + "timezone", + "dateFormat", + "distributionMethod", + "emailId", + "emailReplyTo", + "emailSettings", + "redirectUrl", + "language", + "typedSignatureEnabled", + "uploadSignatureEnabled", + "drawSignatureEnabled", + "signingOrder", + "allowDictateNextSigner", + ] + nullable_fields = ["emailId", "emailReplyTo"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m + class TemplateUpdateTemplateRequestTypedDict(TypedDict): template_id: float @@ -336,10 +412,11 @@ class TemplateUpdateTemplateInternalServerErrorData(BaseModel): issues: Optional[List[TemplateUpdateTemplateInternalServerErrorIssue]] = None +@dataclass(unsafe_hash=True) class TemplateUpdateTemplateInternalServerError(DocumensoError): r"""Internal server error""" - data: TemplateUpdateTemplateInternalServerErrorData + data: TemplateUpdateTemplateInternalServerErrorData = field(hash=False) def __init__( self, @@ -350,7 +427,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateUpdateTemplateBadRequestIssueTypedDict(TypedDict): @@ -369,10 +446,11 @@ class TemplateUpdateTemplateBadRequestErrorData(BaseModel): issues: Optional[List[TemplateUpdateTemplateBadRequestIssue]] = None +@dataclass(unsafe_hash=True) class TemplateUpdateTemplateBadRequestError(DocumensoError): r"""Invalid input data""" - data: TemplateUpdateTemplateBadRequestErrorData + data: TemplateUpdateTemplateBadRequestErrorData = field(hash=False) def __init__( self, @@ -383,7 +461,7 @@ def __init__( fallback = body or raw_response.text message = str(data.message) or fallback super().__init__(message, raw_response, body) - self.data = data + object.__setattr__(self, "data", data) class TemplateUpdateTemplateTypeResponse(str, Enum): @@ -401,6 +479,7 @@ class TemplateUpdateTemplateGlobalAccessAuthResponse(str, Enum): r"""The type of authentication required for the recipient to access the document.""" ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" class TemplateUpdateTemplateGlobalActionAuthResponse(str, Enum): @@ -440,13 +519,14 @@ class TemplateUpdateTemplateResponseTypedDict(TypedDict): user_id: float team_id: float auth_options: Nullable[TemplateUpdateTemplateAuthOptionsTypedDict] - template_document_data_id: str created_at: str updated_at: str public_title: str public_description: str folder_id: Nullable[str] use_legacy_field_insertion: bool + envelope_id: str + template_document_data_id: NotRequired[str] class TemplateUpdateTemplateResponse(BaseModel): @@ -470,10 +550,6 @@ class TemplateUpdateTemplateResponse(BaseModel): Nullable[TemplateUpdateTemplateAuthOptions], pydantic.Field(alias="authOptions") ] - template_document_data_id: Annotated[ - str, pydantic.Field(alias="templateDocumentDataId") - ] - created_at: Annotated[str, pydantic.Field(alias="createdAt")] updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] @@ -488,9 +564,15 @@ class TemplateUpdateTemplateResponse(BaseModel): bool, pydantic.Field(alias="useLegacyFieldInsertion") ] + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + template_document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="templateDocumentDataId") + ] = "" + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["templateDocumentDataId"] nullable_fields = ["externalId", "authOptions", "folderId"] null_default_fields = [] diff --git a/src/documenso_sdk/sdk.py b/src/documenso_sdk/sdk.py index c192fdf..96e9bdd 100644 --- a/src/documenso_sdk/sdk.py +++ b/src/documenso_sdk/sdk.py @@ -15,8 +15,10 @@ import weakref if TYPE_CHECKING: + from documenso_sdk.document_sdk import DocumentSDK from documenso_sdk.documents import Documents from documenso_sdk.embedding import Embedding + from documenso_sdk.template_sdk import TemplateSDK from documenso_sdk.templates import Templates @@ -24,11 +26,15 @@ class Documenso(BaseSDK): r"""Documenso v2 beta API: Subject to breaking changes until v2 is fully released.""" documents: "Documents" + document: "DocumentSDK" templates: "Templates" + template: "TemplateSDK" embedding: "Embedding" _sub_sdk_map = { "documents": ("documenso_sdk.documents", "Documents"), + "document": ("documenso_sdk.document_sdk", "DocumentSDK"), "templates": ("documenso_sdk.templates", "Templates"), + "template": ("documenso_sdk.template_sdk", "TemplateSDK"), "embedding": ("documenso_sdk.embedding", "Embedding"), } @@ -57,7 +63,7 @@ def __init__( """ client_supplied = True if client is None: - client = httpx.Client() + client = httpx.Client(follow_redirects=True) client_supplied = False assert issubclass( @@ -66,7 +72,7 @@ def __init__( async_client_supplied = True if async_client is None: - async_client = httpx.AsyncClient() + async_client = httpx.AsyncClient(follow_redirects=True) async_client_supplied = False if debug_logger is None: diff --git a/src/documenso_sdk/template_sdk.py b/src/documenso_sdk/template_sdk.py new file mode 100644 index 0000000..1a484d0 --- /dev/null +++ b/src/documenso_sdk/template_sdk.py @@ -0,0 +1,305 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from .basesdk import BaseSDK +from documenso_sdk import models, utils +from documenso_sdk._hooks import HookContext +from documenso_sdk.types import OptionalNullable, UNSET +from documenso_sdk.utils import get_security_from_env +from documenso_sdk.utils.unmarshal_json_response import unmarshal_json_response +from typing import Any, List, Mapping, Optional, Union + + +class TemplateSDK(BaseSDK): + def template_create_template_temporary( + self, + *, + title: str, + folder_id: Optional[str] = None, + external_id: OptionalNullable[str] = UNSET, + visibility: Optional[ + models.TemplateCreateTemplateTemporaryVisibilityRequest + ] = None, + global_access_auth: Optional[ + List[models.TemplateCreateTemplateTemporaryGlobalAccessAuthRequest] + ] = None, + global_action_auth: Optional[ + List[models.TemplateCreateTemplateTemporaryGlobalActionAuthRequest] + ] = None, + public_title: Optional[str] = None, + public_description: Optional[str] = None, + type_: Optional[models.TemplateCreateTemplateTemporaryTypeRequest] = None, + meta: Optional[ + Union[ + models.TemplateCreateTemplateTemporaryMeta, + models.TemplateCreateTemplateTemporaryMetaTypedDict, + ] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.TemplateCreateTemplateTemporaryResponse: + r"""Create template + + 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. + + :param title: The title of the document. + :param folder_id: + :param external_id: + :param visibility: + :param global_access_auth: + :param global_action_auth: + :param public_title: The title of the template that will be displayed to the public. Only applicable for public templates. + :param public_description: The description of the template that will be displayed to the public. Only applicable for public templates. + :param type: + :param meta: + :param retries: Override the default retry configuration for this method + :param server_url: Override the default server URL for this method + :param timeout_ms: Override the default request timeout configuration for this method in milliseconds + :param http_headers: Additional headers to set or replace on requests. + """ + base_url = None + url_variables = None + if timeout_ms is None: + timeout_ms = self.sdk_configuration.timeout_ms + + if server_url is not None: + base_url = server_url + else: + base_url = self._get_url(base_url, url_variables) + + request = models.TemplateCreateTemplateTemporaryRequest( + title=title, + folder_id=folder_id, + external_id=external_id, + visibility=visibility, + global_access_auth=global_access_auth, + global_action_auth=global_action_auth, + public_title=public_title, + public_description=public_description, + type=type_, + meta=utils.get_pydantic_model( + meta, Optional[models.TemplateCreateTemplateTemporaryMeta] + ), + ) + + req = self._build_request( + method="POST", + path="/template/create/beta", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=True, + request_has_path_params=False, + request_has_query_params=True, + user_agent_header="user-agent", + accept_header_value="application/json", + http_headers=http_headers, + security=self.sdk_configuration.security, + get_serialized_body=lambda: utils.serialize_request_body( + request, + False, + False, + "json", + models.TemplateCreateTemplateTemporaryRequest, + ), + timeout_ms=timeout_ms, + ) + + if retries == UNSET: + if self.sdk_configuration.retry_config is not UNSET: + retries = self.sdk_configuration.retry_config + + retry_config = None + if isinstance(retries, utils.RetryConfig): + retry_config = (retries, ["429", "500", "502", "503", "504"]) + + http_res = self.do_request( + hook_ctx=HookContext( + config=self.sdk_configuration, + base_url=base_url or "", + operation_id="template-createTemplateTemporary", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "4XX", "500", "5XX"], + retry_config=retry_config, + ) + + response_data: Any = None + if utils.match_response(http_res, "200", "application/json"): + return unmarshal_json_response( + models.TemplateCreateTemplateTemporaryResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateTemporaryBadRequestErrorData, http_res + ) + raise models.TemplateCreateTemplateTemporaryBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateTemporaryInternalServerErrorData, http_res + ) + raise models.TemplateCreateTemplateTemporaryInternalServerError( + response_data, http_res + ) + if utils.match_response(http_res, "4XX", "*"): + http_res_text = utils.stream_to_text(http_res) + raise models.APIError("API error occurred", http_res, http_res_text) + if utils.match_response(http_res, "5XX", "*"): + http_res_text = utils.stream_to_text(http_res) + raise models.APIError("API error occurred", http_res, http_res_text) + + raise models.APIError("Unexpected response received", http_res) + + async def template_create_template_temporary_async( + self, + *, + title: str, + folder_id: Optional[str] = None, + external_id: OptionalNullable[str] = UNSET, + visibility: Optional[ + models.TemplateCreateTemplateTemporaryVisibilityRequest + ] = None, + global_access_auth: Optional[ + List[models.TemplateCreateTemplateTemporaryGlobalAccessAuthRequest] + ] = None, + global_action_auth: Optional[ + List[models.TemplateCreateTemplateTemporaryGlobalActionAuthRequest] + ] = None, + public_title: Optional[str] = None, + public_description: Optional[str] = None, + type_: Optional[models.TemplateCreateTemplateTemporaryTypeRequest] = None, + meta: Optional[ + Union[ + models.TemplateCreateTemplateTemporaryMeta, + models.TemplateCreateTemplateTemporaryMetaTypedDict, + ] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.TemplateCreateTemplateTemporaryResponse: + r"""Create template + + 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. + + :param title: The title of the document. + :param folder_id: + :param external_id: + :param visibility: + :param global_access_auth: + :param global_action_auth: + :param public_title: The title of the template that will be displayed to the public. Only applicable for public templates. + :param public_description: The description of the template that will be displayed to the public. Only applicable for public templates. + :param type: + :param meta: + :param retries: Override the default retry configuration for this method + :param server_url: Override the default server URL for this method + :param timeout_ms: Override the default request timeout configuration for this method in milliseconds + :param http_headers: Additional headers to set or replace on requests. + """ + base_url = None + url_variables = None + if timeout_ms is None: + timeout_ms = self.sdk_configuration.timeout_ms + + if server_url is not None: + base_url = server_url + else: + base_url = self._get_url(base_url, url_variables) + + request = models.TemplateCreateTemplateTemporaryRequest( + title=title, + folder_id=folder_id, + external_id=external_id, + visibility=visibility, + global_access_auth=global_access_auth, + global_action_auth=global_action_auth, + public_title=public_title, + public_description=public_description, + type=type_, + meta=utils.get_pydantic_model( + meta, Optional[models.TemplateCreateTemplateTemporaryMeta] + ), + ) + + req = self._build_request_async( + method="POST", + path="/template/create/beta", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=True, + request_has_path_params=False, + request_has_query_params=True, + user_agent_header="user-agent", + accept_header_value="application/json", + http_headers=http_headers, + security=self.sdk_configuration.security, + get_serialized_body=lambda: utils.serialize_request_body( + request, + False, + False, + "json", + models.TemplateCreateTemplateTemporaryRequest, + ), + timeout_ms=timeout_ms, + ) + + if retries == UNSET: + if self.sdk_configuration.retry_config is not UNSET: + retries = self.sdk_configuration.retry_config + + retry_config = None + if isinstance(retries, utils.RetryConfig): + retry_config = (retries, ["429", "500", "502", "503", "504"]) + + http_res = await self.do_request_async( + hook_ctx=HookContext( + config=self.sdk_configuration, + base_url=base_url or "", + operation_id="template-createTemplateTemporary", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "4XX", "500", "5XX"], + retry_config=retry_config, + ) + + response_data: Any = None + if utils.match_response(http_res, "200", "application/json"): + return unmarshal_json_response( + models.TemplateCreateTemplateTemporaryResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateTemporaryBadRequestErrorData, http_res + ) + raise models.TemplateCreateTemplateTemporaryBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateTemporaryInternalServerErrorData, http_res + ) + raise models.TemplateCreateTemplateTemporaryInternalServerError( + response_data, http_res + ) + if utils.match_response(http_res, "4XX", "*"): + http_res_text = await utils.stream_to_text_async(http_res) + raise models.APIError("API error occurred", http_res, http_res_text) + if utils.match_response(http_res, "5XX", "*"): + http_res_text = await utils.stream_to_text_async(http_res) + raise models.APIError("API error occurred", http_res, http_res_text) + + raise models.APIError("Unexpected response received", http_res) diff --git a/src/documenso_sdk/templates.py b/src/documenso_sdk/templates.py index 00173c9..9db8091 100644 --- a/src/documenso_sdk/templates.py +++ b/src/documenso_sdk/templates.py @@ -110,7 +110,7 @@ def find( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-findTemplates", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -225,7 +225,7 @@ async def find_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-findTemplates", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -326,7 +326,7 @@ def get( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-getTemplateById", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -427,7 +427,7 @@ async def get_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-getTemplateById", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -551,7 +551,7 @@ def update( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-updateTemplate", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -670,7 +670,7 @@ async def update_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-updateTemplate", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -769,7 +769,7 @@ def duplicate( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-duplicateTemplate", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -870,7 +870,7 @@ async def duplicate_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-duplicateTemplate", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -971,7 +971,7 @@ def delete( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-deleteTemplate", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1070,7 +1070,7 @@ async def delete_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-deleteTemplate", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1116,6 +1116,13 @@ def use( ], distribute_document: Optional[bool] = None, custom_document_data_id: Optional[str] = None, + custom_document_data: Optional[ + Union[ + List[models.CustomDocumentDatum], + List[models.CustomDocumentDatumTypedDict], + ] + ] = None, + folder_id: Optional[str] = None, prefill_fields: Optional[ Union[List[models.PrefillField], List[models.PrefillFieldTypedDict]] ] = None, @@ -1131,7 +1138,9 @@ def use( :param template_id: :param recipients: The information of the recipients to create the document with. :param distribute_document: Whether to create the document as pending and distribute it to recipients. - :param custom_document_data_id: The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. + :param custom_document_data_id: [DEPRECATED] - Use customDocumentData instead. The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. + :param custom_document_data: The data IDs of alternative PDFs to use when creating the document. If not provided, the PDF attached to the template will be used. + :param folder_id: The ID of the folder to create the document in. If not provided, the document will be created in the root folder. :param prefill_fields: The fields to prefill on the document before sending it out. Useful when you want to create a document from an existing template and pre-fill the fields with specific values. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -1156,6 +1165,10 @@ def use( ), distribute_document=distribute_document, custom_document_data_id=custom_document_data_id, + custom_document_data=utils.get_pydantic_model( + custom_document_data, Optional[List[models.CustomDocumentDatum]] + ), + folder_id=folder_id, prefill_fields=utils.get_pydantic_model( prefill_fields, Optional[List[models.PrefillField]] ), @@ -1197,7 +1210,7 @@ def use( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-createDocumentFromTemplate", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1246,6 +1259,13 @@ async def use_async( ], distribute_document: Optional[bool] = None, custom_document_data_id: Optional[str] = None, + custom_document_data: Optional[ + Union[ + List[models.CustomDocumentDatum], + List[models.CustomDocumentDatumTypedDict], + ] + ] = None, + folder_id: Optional[str] = None, prefill_fields: Optional[ Union[List[models.PrefillField], List[models.PrefillFieldTypedDict]] ] = None, @@ -1261,7 +1281,9 @@ async def use_async( :param template_id: :param recipients: The information of the recipients to create the document with. :param distribute_document: Whether to create the document as pending and distribute it to recipients. - :param custom_document_data_id: The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. + :param custom_document_data_id: [DEPRECATED] - Use customDocumentData instead. The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used. + :param custom_document_data: The data IDs of alternative PDFs to use when creating the document. If not provided, the PDF attached to the template will be used. + :param folder_id: The ID of the folder to create the document in. If not provided, the document will be created in the root folder. :param prefill_fields: The fields to prefill on the document before sending it out. Useful when you want to create a document from an existing template and pre-fill the fields with specific values. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -1286,6 +1308,10 @@ async def use_async( ), distribute_document=distribute_document, custom_document_data_id=custom_document_data_id, + custom_document_data=utils.get_pydantic_model( + custom_document_data, Optional[List[models.CustomDocumentDatum]] + ), + folder_id=folder_id, prefill_fields=utils.get_pydantic_model( prefill_fields, Optional[List[models.PrefillField]] ), @@ -1327,7 +1353,7 @@ async def use_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="template-createDocumentFromTemplate", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), diff --git a/src/documenso_sdk/templates_fields.py b/src/documenso_sdk/templates_fields.py index bd3d37e..0803456 100644 --- a/src/documenso_sdk/templates_fields.py +++ b/src/documenso_sdk/templates_fields.py @@ -83,7 +83,7 @@ def create( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-createTemplateField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -194,7 +194,7 @@ async def create_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-createTemplateField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -294,7 +294,7 @@ def get( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-getTemplateField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -397,7 +397,7 @@ async def get_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-getTemplateField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -511,7 +511,7 @@ def create_many( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-createTemplateFields", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -622,7 +622,7 @@ async def create_many_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-createTemplateFields", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -733,7 +733,7 @@ def update( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-updateTemplateField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -844,7 +844,7 @@ async def update_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-updateTemplateField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -955,7 +955,7 @@ def update_many( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-updateTemplateFields", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1066,7 +1066,7 @@ async def update_many_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-updateTemplateFields", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1167,7 +1167,7 @@ def delete( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-deleteTemplateField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1268,7 +1268,7 @@ async def delete_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="field-deleteTemplateField", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), diff --git a/src/documenso_sdk/templates_recipients.py b/src/documenso_sdk/templates_recipients.py index 6cd9631..b0254ca 100644 --- a/src/documenso_sdk/templates_recipients.py +++ b/src/documenso_sdk/templates_recipients.py @@ -72,7 +72,7 @@ def get( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-getTemplateRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -179,7 +179,7 @@ async def get_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-getTemplateRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -301,7 +301,7 @@ def create( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-createTemplateRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -416,7 +416,7 @@ async def create_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-createTemplateRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -532,7 +532,7 @@ def create_many( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-createTemplateRecipients", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -649,7 +649,7 @@ async def create_many_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-createTemplateRecipients", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -765,7 +765,7 @@ def update( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-updateTemplateRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -880,7 +880,7 @@ async def update_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-updateTemplateRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -996,7 +996,7 @@ def update_many( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-updateTemplateRecipients", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1113,7 +1113,7 @@ async def update_many_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-updateTemplateRecipients", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1219,7 +1219,7 @@ def delete( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-deleteTemplateRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), @@ -1324,7 +1324,7 @@ async def delete_async( config=self.sdk_configuration, base_url=base_url or "", operation_id="recipient-deleteTemplateRecipient", - oauth2_scopes=[], + oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), diff --git a/src/documenso_sdk/utils/annotations.py b/src/documenso_sdk/utils/annotations.py index 387874e..12e0aa4 100644 --- a/src/documenso_sdk/utils/annotations.py +++ b/src/documenso_sdk/utils/annotations.py @@ -3,6 +3,7 @@ from enum import Enum from typing import Any, Optional + def get_discriminator(model: Any, fieldname: str, key: str) -> str: """ Recursively search for the discriminator attribute in a model. @@ -25,31 +26,54 @@ def get_field_discriminator(field: Any) -> Optional[str]: if isinstance(field, dict): if key in field: - return f'{field[key]}' + return f"{field[key]}" if hasattr(field, fieldname): attr = getattr(field, fieldname) if isinstance(attr, Enum): - return f'{attr.value}' - return f'{attr}' + return f"{attr.value}" + return f"{attr}" if hasattr(field, upper_fieldname): attr = getattr(field, upper_fieldname) if isinstance(attr, Enum): - return f'{attr.value}' - return f'{attr}' + return f"{attr.value}" + return f"{attr}" return None + def search_nested_discriminator(obj: Any) -> Optional[str]: + """Recursively search for discriminator in nested structures.""" + # First try direct field lookup + discriminator = get_field_discriminator(obj) + if discriminator is not None: + return discriminator + + # If it's a dict, search in nested values + if isinstance(obj, dict): + for value in obj.values(): + if isinstance(value, list): + # Search in list items + for item in value: + nested_discriminator = search_nested_discriminator(item) + if nested_discriminator is not None: + return nested_discriminator + elif isinstance(value, dict): + # Search in nested dict + nested_discriminator = search_nested_discriminator(value) + if nested_discriminator is not None: + return nested_discriminator + + return None if isinstance(model, list): for field in model: - discriminator = get_field_discriminator(field) + discriminator = search_nested_discriminator(field) if discriminator is not None: return discriminator - discriminator = get_field_discriminator(model) + discriminator = search_nested_discriminator(model) if discriminator is not None: return discriminator - raise ValueError(f'Could not find discriminator field {fieldname} in {model}') + raise ValueError(f"Could not find discriminator field {fieldname} in {model}")