From 3c4ea91a475a735564750768230d5f3b1717bd83 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 12 Nov 2025 08:56:42 +0000 Subject: [PATCH 1/2] ## Python SDK Changes Detected: * `documenso.documents.get()`: * `request.folder_id` **Removed** **Breaking** :warning: * `response` **Changed** **Breaking** :warning: * `error` **Changed** * `documenso.templates.use()`: * `request` **Changed** * `response` **Changed** **Breaking** :warning: * `error` **Changed** * `documenso.templates.get()`: * `response` **Changed** **Breaking** :warning: * `error` **Changed** * `documenso.templates.find()`: * `response.data.[]` **Changed** **Breaking** :warning: * `error` **Changed** * `documenso.documents.create_v0()`: * `request` **Changed** * `response.document` **Changed** **Breaking** :warning: * `error` **Changed** * `documenso.envelopes.fields.get()`: **Added** * `documenso.documents.redistribute()`: `error` **Changed** * `documenso.envelopes.redistribute()`: **Added** * `documenso.envelopes.attachments.find()`: **Added** * `documenso.envelopes.attachments.create()`: **Added** * `documenso.envelopes.attachments.update()`: **Added** * `documenso.envelopes.attachments.delete()`: **Added** * `documenso.envelopes.items.create_many()`: **Added** * `documenso.envelopes.items.update_many()`: **Added** * `documenso.envelopes.items.delete()`: **Added** * `documenso.envelopes.items.download()`: **Added** * `documenso.envelopes.recipients.get()`: **Added** * `documenso.envelopes.recipients.create_many()`: **Added** * `documenso.envelopes.recipients.update_many()`: **Added** * `documenso.envelopes.recipients.delete()`: **Added** * `documenso.envelopes.get()`: **Added** * `documenso.envelopes.fields.create_many()`: **Added** * `documenso.envelopes.fields.update_many()`: **Added** * `documenso.envelopes.fields.delete()`: **Added** * `documenso.documents.create()`: **Added** * `documenso.documents.download()`: **Added** * `documenso.documents.attachments.create()`: **Added** * `documenso.documents.attachments.update()`: **Added** * `documenso.documents.attachments.delete()`: **Added** * `documenso.documents.attachments.find()`: **Added** * `documenso.document.document_download()`: **Added** * `documenso.templates.create()`: **Added** * `documenso.documents.distribute()`: * `request.meta` **Changed** * `response` **Changed** * `error` **Changed** * `documenso.folders.create()`: **Added** * `documenso.folders.update()`: **Added** * `documenso.folders.delete()`: **Added** * `documenso.template.template-create_template_temporary()`: **Added** * `documenso.documents.update()`: * `request` **Changed** * `response` **Changed** * `error` **Changed** * `documenso.documents.find()`: * `response.data.[]` **Changed** * `error` **Changed** * `documenso.envelopes.duplicate()`: **Added** * `documenso.envelopes.delete()`: **Added** * `documenso.envelopes.distribute()`: **Added** * `documenso.documents.delete()`: `error` **Changed** * `documenso.folders.find()`: **Added** * `documenso.documents.duplicate()`: * `response.id` **Added** * `error` **Changed** * `documenso.documents.fields.get()`: * `response` **Changed** * `error` **Changed** * `documenso.documents.fields.create()`: * `request.field.[class].field_meta` **Changed** * `response` **Changed** * `error` **Changed** * `documenso.documents.fields.create_many()`: * `request.fields.[].[class].field_meta` **Changed** * `response.fields.[]` **Changed** * `error` **Changed** * `documenso.documents.fields.update()`: * `request.field.[class].field_meta` **Changed** * `response` **Changed** * `error` **Changed** * `documenso.documents.fields.update_many()`: * `request.fields.[].[class].field_meta` **Changed** * `response.fields.[]` **Changed** * `error` **Changed** * `documenso.documents.fields.delete()`: `error` **Changed** * `documenso.documents.recipients.get()`: * `response` **Changed** * `error` **Changed** * `documenso.documents.recipients.create()`: * `response` **Changed** * `error` **Changed** * `documenso.documents.recipients.create_many()`: * `response.recipients.[]` **Changed** * `error` **Changed** * `documenso.documents.recipients.update()`: * `response` **Changed** * `error` **Changed** * `documenso.documents.recipients.update_many()`: * `response.recipients.[]` **Changed** * `error` **Changed** * `documenso.documents.recipients.delete()`: `error` **Changed** * `documenso.envelopes.update()`: **Added** * `documenso.envelopes.use()`: **Added** * `documenso.templates.update()`: * `request` **Changed** * `response` **Changed** * `error` **Changed** * `documenso.templates.duplicate()`: * `response` **Changed** * `error` **Changed** * `documenso.templates.delete()`: `error` **Changed** * `documenso.envelopes.create()`: **Added** * `documenso.templates.fields.create()`: * `request.field.[class].field_meta` **Changed** * `response` **Changed** * `error` **Changed** * `documenso.templates.fields.get()`: * `response` **Changed** * `error` **Changed** * `documenso.templates.fields.create_many()`: * `request.fields.[].[class].field_meta` **Changed** * `response.fields.[]` **Changed** * `error` **Changed** * `documenso.templates.fields.update()`: * `request.field.[class].field_meta` **Changed** * `response` **Changed** * `error` **Changed** * `documenso.templates.fields.update_many()`: * `request.fields.[].[class].field_meta` **Changed** * `response.fields.[]` **Changed** * `error` **Changed** * `documenso.templates.fields.delete()`: `error` **Changed** * `documenso.templates.recipients.get()`: * `response` **Changed** * `error` **Changed** * `documenso.templates.recipients.create()`: * `response` **Changed** * `error` **Changed** * `documenso.templates.recipients.create_many()`: * `response.recipients.[]` **Changed** * `error` **Changed** * `documenso.templates.recipients.update()`: * `response` **Changed** * `error` **Changed** * `documenso.templates.recipients.update_many()`: * `response.recipients.[]` **Changed** * `error` **Changed** * `documenso.templates.recipients.delete()`: `error` **Changed** * `documenso.templates.direct_link.create()`: * `response.envelope_id` **Added** * `error` **Changed** * `documenso.templates.direct_link.delete()`: `error` **Changed** * `documenso.templates.direct_link.toggle()`: * `response.envelope_id` **Added** * `error` **Changed** * `documenso.embedding.embedding_presign-create_embedding_presign_token()`: `error` **Changed** * `documenso.embedding.embedding_presign-verify_embedding_presign_token()`: `error` **Changed** --- .gitignore | 2 + .speakeasy/gen.lock | 2757 +++++- .speakeasy/gen.yaml | 9 +- .speakeasy/workflow.lock | 14 +- README-PYPI.md | 549 +- README.md | 549 +- RELEASES.md | 12 +- USAGE.md | 5 +- docs/models/document.md | 29 - docs/models/documentaccessauth.md | 9 +- docs/models/documentactionauth.md | 2 - ...documentattachmentcreatebadrequesterror.md | 12 + ...documentattachmentcreatebadrequestissue.md | 8 + docs/models/documentattachmentcreatedata.md | 9 + .../documentattachmentcreateforbiddenerror.md | 12 + .../documentattachmentcreateforbiddenissue.md | 8 + ...mentattachmentcreateinternalservererror.md | 12 + ...ttachmentcreateinternalservererrorissue.md | 8 + .../models/documentattachmentcreaterequest.md | 9 + .../documentattachmentcreateresponse.md | 10 + ...cumentattachmentcreateunauthorizederror.md | 12 + ...cumentattachmentcreateunauthorizedissue.md | 8 + ...documentattachmentdeletebadrequesterror.md | 12 + ...documentattachmentdeletebadrequestissue.md | 8 + .../documentattachmentdeleteforbiddenerror.md | 12 + .../documentattachmentdeleteforbiddenissue.md | 8 + ...mentattachmentdeleteinternalservererror.md | 12 + ...ttachmentdeleteinternalservererrorissue.md | 8 + .../models/documentattachmentdeleterequest.md | 8 + .../documentattachmentdeleteresponse.md | 10 + ...cumentattachmentdeleteunauthorizederror.md | 12 + ...cumentattachmentdeleteunauthorizedissue.md | 8 + ... documentattachmentfindbadrequesterror.md} | 4 +- ... documentattachmentfindbadrequestissue.md} | 2 +- docs/models/documentattachmentfinddata.md | 11 + .../documentattachmentfindforbiddenerror.md | 12 + ...> documentattachmentfindforbiddenissue.md} | 2 +- ...umentattachmentfindinternalservererror.md} | 4 +- ...attachmentfindinternalservererrorissue.md} | 2 +- .../documentattachmentfindnotfounderror.md | 12 + ...=> documentattachmentfindnotfoundissue.md} | 2 +- ...st.md => documentattachmentfindrequest.md} | 2 +- docs/models/documentattachmentfindresponse.md | 10 + docs/models/documentattachmentfindtype.md | 8 + ...documentattachmentfindunauthorizederror.md | 12 + ...documentattachmentfindunauthorizedissue.md | 8 + ...documentattachmentupdatebadrequesterror.md | 12 + ...documentattachmentupdatebadrequestissue.md | 8 + docs/models/documentattachmentupdatedata.md | 9 + .../documentattachmentupdateforbiddenerror.md | 12 + .../documentattachmentupdateforbiddenissue.md | 8 + ...mentattachmentupdateinternalservererror.md | 12 + ...ttachmentupdateinternalservererrorissue.md | 8 + .../models/documentattachmentupdaterequest.md | 9 + .../documentattachmentupdateresponse.md | 10 + ...cumentattachmentupdateunauthorizederror.md | 12 + ...cumentattachmentupdateunauthorizedissue.md | 8 + docs/models/documentcreateaccessauth.md | 9 + ...ionauth.md => documentcreateactionauth.md} | 4 +- docs/models/documentcreateattachment.md | 10 + docs/models/documentcreatebadrequesterror.md | 12 + ...ue.md => documentcreatebadrequestissue.md} | 2 +- docs/models/documentcreatedateformat.md | 29 + .../models/documentcreatedirectioncheckbox.md | 9 + docs/models/documentcreatedirectionradio.md | 9 + ...md => documentcreatedistributionmethod.md} | 2 +- ...reatedocumenttemporaryaccessauthrequest.md | 9 +- ...reatedocumenttemporaryactionauthrequest.md | 2 - ...cumentcreatedocumenttemporaryattachment.md | 10 + ...cumentcreatedocumenttemporarydateformat.md | 38 +- ...reatedocumenttemporarydirectioncheckbox.md | 9 + ...ntcreatedocumenttemporarydirectionradio.md | 9 + ...umenttemporarydistributionmethodrequest.md | 11 - ...documentcreatedocumenttemporarydocument.md | 32 + ...mentcreatedocumenttemporarydocumentdata.md | 3 +- ...mentcreatedocumenttemporarydocumentmeta.md | 8 +- ...tedocumenttemporaryemailsettingsrequest.md | 14 - ...mentcreatedocumenttemporaryenvelopeitem.md | 9 + ...entcreatedocumenttemporaryfieldcheckbox.md | 10 +- ...ocumentcreatedocumenttemporaryfielddate.md | 10 +- ...entcreatedocumenttemporaryfielddropdown.md | 10 +- ...cumentcreatedocumenttemporaryfieldemail.md | 10 +- ...eatedocumenttemporaryfieldfreesignature.md | 10 +- ...entcreatedocumenttemporaryfieldinitials.md | 10 +- ...ocumentcreatedocumenttemporaryfieldname.md | 10 +- ...umentcreatedocumenttemporaryfieldnumber.md | 10 +- ...cumentcreatedocumenttemporaryfieldradio.md | 10 +- ...ntcreatedocumenttemporaryfieldsignature.md | 17 +- ...ocumentcreatedocumenttemporaryfieldtext.md | 10 +- ...tcreatedocumenttemporaryforbiddenerror.md} | 6 +- ...tcreatedocumenttemporaryforbiddenissue.md} | 2 +- ...eatedocumenttemporaryformvaluesrequest.md} | 2 +- ...ocumenttemporaryglobalaccessauthrequest.md | 9 +- ...ocumenttemporaryglobalactionauthrequest.md | 2 - ...documentcreatedocumenttemporarylanguage.md | 2 - .../documentcreatedocumenttemporarymeta.md | 31 +- ...documenttemporarymetadistributionmethod.md | 9 + ...reatedocumenttemporarymetaemailsettings.md | 14 + ...menttemporaryrecipientfieldmetacheckbox.md | 4 +- ...documenttemporaryrecipientfieldmetadate.md | 2 +- ...menttemporaryrecipientfieldmetadropdown.md | 1 + ...ocumenttemporaryrecipientfieldmetaemail.md | 2 +- ...menttemporaryrecipientfieldmetainitials.md | 2 +- ...documenttemporaryrecipientfieldmetaname.md | 2 +- ...cumenttemporaryrecipientfieldmetanumber.md | 29 +- ...ocumenttemporaryrecipientfieldmetaradio.md | 4 +- ...enttemporaryrecipientfieldmetasignature.md | 13 + ...documenttemporaryrecipientfieldmetatext.md | 25 +- ...ocumenttemporaryrecipienttypesignature1.md | 8 + ...ocumenttemporaryrecipienttypesignature2.md | 8 + .../documentcreatedocumenttemporaryrequest.md | 10 +- ...documentcreatedocumenttemporaryresponse.md | 8 +- ...documentcreatedocumenttemporarytypelink.md | 8 + ...reatedocumenttemporaryunauthorizederror.md | 12 + ...reatedocumenttemporaryunauthorizedissue.md | 8 + ...atedocumenttemporaryverticalalignnumber.md | 10 + ...reatedocumenttemporaryverticalaligntext.md | 10 + ...reatedocumenttemporaryvisibilityrequest.md | 2 - docs/models/documentcreateemailsettings.md | 14 + docs/models/documentcreatefieldcheckbox.md | 14 + docs/models/documentcreatefielddate.md | 14 + docs/models/documentcreatefielddropdown.md | 14 + docs/models/documentcreatefieldemail.md | 14 + .../documentcreatefieldfreesignature.md | 13 + docs/models/documentcreatefieldinitials.md | 14 + .../models/documentcreatefieldmetacheckbox.md | 17 + docs/models/documentcreatefieldmetadate.md | 14 + .../models/documentcreatefieldmetadropdown.md | 15 + docs/models/documentcreatefieldmetaemail.md | 14 + .../models/documentcreatefieldmetainitials.md | 14 + docs/models/documentcreatefieldmetaname.md | 14 + docs/models/documentcreatefieldmetanumber.md | 21 + docs/models/documentcreatefieldmetaradio.md | 15 + .../documentcreatefieldmetasignature.md | 13 + docs/models/documentcreatefieldmetatext.md | 19 + docs/models/documentcreatefieldname.md | 14 + docs/models/documentcreatefieldnumber.md | 14 + docs/models/documentcreatefieldradio.md | 14 + docs/models/documentcreatefieldsignature.md | 14 + docs/models/documentcreatefieldtext.md | 14 + docs/models/documentcreatefieldunion.md | 71 + docs/models/documentcreatefile.md | 10 + ...est.md => documentcreateforbiddenerror.md} | 10 +- ...sue.md => documentcreateforbiddenissue.md} | 2 +- ...mvalues.md => documentcreateformvalues.md} | 2 +- docs/models/documentcreateglobalaccessauth.md | 9 + ...h.md => documentcreateglobalactionauth.md} | 4 +- .../documentcreateinternalservererror.md | 12 + .../documentcreateinternalservererrorissue.md | 8 + ...tlanguage.md => documentcreatelanguage.md} | 4 +- docs/models/documentcreatemeta.md | 22 + docs/models/documentcreatepayload.md | 17 + docs/models/documentcreaterecipient.md | 14 + docs/models/documentcreaterequest.md | 9 + docs/models/documentcreateresponse.md | 11 + ...documentsrole.md => documentcreaterole.md} | 2 +- ...order.md => documentcreatesigningorder.md} | 2 +- ...ign2.md => documentcreatetextaligndate.md} | 2 +- ...gn1.md => documentcreatetextalignemail.md} | 2 +- ....md => documentcreatetextaligninitials.md} | 2 +- ...ign4.md => documentcreatetextalignname.md} | 2 +- docs/models/documentcreatetextalignnumber.md | 10 + docs/models/documentcreatetextaligntext.md | 10 + docs/models/documentcreatetypecheckbox1.md | 8 + ...kbox.md => documentcreatetypecheckbox2.md} | 2 +- docs/models/documentcreatetypedate1.md | 8 + ...typedate.md => documentcreatetypedate2.md} | 2 +- docs/models/documentcreatetypedropdown1.md | 8 + ...down.md => documentcreatetypedropdown2.md} | 2 +- docs/models/documentcreatetypeemail1.md | 8 + ...peemail.md => documentcreatetypeemail2.md} | 2 +- .../models/documentcreatetypefreesignature.md | 8 + docs/models/documentcreatetypeinitials1.md | 8 + ...ials.md => documentcreatetypeinitials2.md} | 2 +- docs/models/documentcreatetypelink.md | 8 + docs/models/documentcreatetypename1.md | 8 + ...typename.md => documentcreatetypename2.md} | 2 +- docs/models/documentcreatetypenumber1.md | 8 + ...number.md => documentcreatetypenumber2.md} | 2 +- docs/models/documentcreatetyperadio1.md | 8 + ...peradio.md => documentcreatetyperadio2.md} | 2 +- ...ure.md => documentcreatetypesignature1.md} | 2 +- ...ure.md => documentcreatetypesignature2.md} | 4 +- docs/models/documentcreatetypetext1.md | 8 + ...typetext.md => documentcreatetypetext2.md} | 2 +- .../models/documentcreateunauthorizederror.md | 12 + .../models/documentcreateunauthorizedissue.md | 8 + ...lue1.md => documentcreatevaluecheckbox.md} | 2 +- ...lue3.md => documentcreatevaluedropdown.md} | 2 +- ...dvalue2.md => documentcreatevalueradio.md} | 2 +- .../documentcreateverticalalignnumber.md | 10 + .../models/documentcreateverticalaligntext.md | 10 + ...ibility.md => documentcreatevisibility.md} | 2 +- docs/models/documentdeletebadrequesterror.md | 12 + docs/models/documentdeletebadrequestissue.md | 8 + docs/models/documentdeleteforbiddenerror.md | 12 + docs/models/documentdeleteforbiddenissue.md | 8 + .../documentdeleteinternalservererror.md | 12 + .../documentdeleteinternalservererrorissue.md | 8 + ...entrequest.md => documentdeleterequest.md} | 2 +- ...tresponse.md => documentdeleteresponse.md} | 2 +- .../models/documentdeleteunauthorizederror.md | 12 + .../models/documentdeleteunauthorizedissue.md | 8 + docs/models/documentdirection1.md | 9 + docs/models/documentdirection2.md | 9 + docs/models/documentdistributeauthoptions.md | 9 + .../documentdistributebadrequesterror.md | 12 + .../documentdistributebadrequestissue.md | 8 + docs/models/documentdistributedateformat.md | 29 + .../documentdistributedistributionmethod.md | 9 + .../models/documentdistributeemailsettings.md | 14 + .../documentdistributeforbiddenerror.md | 12 + .../documentdistributeforbiddenissue.md | 8 + ...ues.md => documentdistributeformvalues.md} | 2 +- .../documentdistributeglobalaccessauth.md | 9 + ... => documentdistributeglobalactionauth.md} | 4 +- .../documentdistributeinternalservererror.md | 12 + ...umentdistributeinternalservererrorissue.md | 8 + ...guage.md => documentdistributelanguage.md} | 4 +- docs/models/documentdistributemeta.md | 17 + docs/models/documentdistributerequest.md | 9 + docs/models/documentdistributeresponse.md | 29 + ...tsource.md => documentdistributesource.md} | 2 +- ...tstatus.md => documentdistributestatus.md} | 2 +- .../documentdistributeunauthorizederror.md | 12 + .../documentdistributeunauthorizedissue.md | 8 + ...ity.md => documentdistributevisibility.md} | 2 +- ....md => documentdownloadbadrequesterror.md} | 9 +- .../models/documentdownloadbadrequestissue.md | 8 + ...=> documentdownloadbetabadrequesterror.md} | 4 +- .../documentdownloadbetabadrequestissue.md | 8 + .../documentdownloadbetaforbiddenerror.md | 12 + .../documentdownloadbetaforbiddenissue.md | 8 + ...ocumentdownloadbetainternalservererror.md} | 4 +- ...entdownloadbetainternalservererrorissue.md | 8 + .../documentdownloadbetanotfounderror.md | 12 + .../documentdownloadbetanotfoundissue.md | 8 + docs/models/documentdownloadbetarequest.md | 9 + docs/models/documentdownloadbetaresponse.md | 12 + ... documentdownloadbetaunauthorizederror.md} | 6 +- .../documentdownloadbetaunauthorizedissue.md | 8 + docs/models/documentdownloadbetaversion.md | 11 + docs/models/documentdownloadforbiddenerror.md | 12 + docs/models/documentdownloadforbiddenissue.md | 8 + ...=> documentdownloadinternalservererror.md} | 6 +- ...cumentdownloadinternalservererrorissue.md} | 2 +- docs/models/documentdownloadnotfounderror.md | 12 + docs/models/documentdownloadnotfoundissue.md | 8 + docs/models/documentdownloadrequest.md | 9 + docs/models/documentdownloadresponse.md | 9 + .../documentdownloadunauthorizederror.md | 12 + .../documentdownloadunauthorizedissue.md | 8 + docs/models/documentdownloadversion.md | 11 + .../documentduplicatebadrequesterror.md | 12 + .../documentduplicatebadrequestissue.md | 8 + .../models/documentduplicateforbiddenerror.md | 12 + .../models/documentduplicateforbiddenissue.md | 8 + .../documentduplicateinternalservererror.md | 12 + ...cumentduplicateinternalservererrorissue.md | 8 + ...esponse.md => documentduplicaterequest.md} | 4 +- docs/models/documentduplicateresponse.md | 11 + .../documentduplicateunauthorizederror.md | 12 + .../documentduplicateunauthorizedissue.md | 8 + docs/models/documentemailsettings.md | 18 +- docs/models/documentfield.md | 18 +- docs/models/documentfieldmetaunion.md | 6 + docs/models/documentfindaccessauth.md | 9 + ...ctionauth.md => documentfindactionauth.md} | 4 +- docs/models/documentfindauthoptions.md | 9 + docs/models/documentfindbadrequesterror.md | 12 + docs/models/documentfindbadrequestissue.md | 8 + docs/models/documentfinddata.md | 30 + .../models/documentfinddocumentsaccessauth.md | 10 - .../documentfinddocumentsglobalaccessauth.md | 10 - docs/models/documentfinddocumentsrecipient.md | 23 - docs/models/documentfinddocumentsresponse.md | 14 - docs/models/documentfindforbiddenerror.md | 12 + docs/models/documentfindforbiddenissue.md | 8 + ...ormvalues.md => documentfindformvalues.md} | 2 +- docs/models/documentfindglobalaccessauth.md | 9 + ...est.md => documentfindglobalactionauth.md} | 4 +- ....md => documentfindinternalservererror.md} | 6 +- .../documentfindinternalservererrorissue.md | 8 + docs/models/documentfindnotfounderror.md | 12 + docs/models/documentfindnotfoundissue.md | 8 + ...eadstatus.md => documentfindreadstatus.md} | 2 +- ...umentsdata.md => documentfindrecipient.md} | 38 +- .../documentfindrecipientauthoptions.md | 9 + ...mentsrequest.md => documentfindrequest.md} | 2 +- docs/models/documentfindresponse.md | 14 + ...detailsbyidrole.md => documentfindrole.md} | 2 +- ...endstatus.md => documentfindsendstatus.md} | 2 +- ...status.md => documentfindsigningstatus.md} | 2 +- ...nddocumentsteam.md => documentfindteam.md} | 2 +- docs/models/documentfindunauthorizederror.md | 12 + docs/models/documentfindunauthorizedissue.md | 8 + ...nddocumentsuser.md => documentfinduser.md} | 2 +- ...tyrequest.md => documentfindvisibility.md} | 2 +- docs/models/documentgetaccessauth.md | 9 + docs/models/documentgetactionauth.md | 12 + docs/models/documentgetauthoptions.md | 9 + docs/models/documentgetbadrequesterror.md | 12 + docs/models/documentgetbadrequestissue.md | 8 + docs/models/documentgetdirection1.md | 9 + docs/models/documentgetdirection2.md | 9 + docs/models/documentgetdistributionmethod.md | 9 + docs/models/documentgetdocumentdata.md | 12 + ...type.md => documentgetdocumentdatatype.md} | 2 +- docs/models/documentgetdocumentmeta.md | 25 + ...entgetdocumentwithdetailsbyidaccessauth.md | 10 - ...tdocumentwithdetailsbyidbadrequestissue.md | 8 - ...getdocumentwithdetailsbyidemailsettings.md | 14 - ...etdocumentwithdetailsbyidfieldmetaemail.md | 14 - ...etdocumentwithdetailsbyidfieldmetaunion.md | 59 - ...documentwithdetailsbyidfoldervisibility.md | 10 - ...documentwithdetailsbyidglobalaccessauth.md | 10 - ...documentwithdetailsbyidglobalactionauth.md | 13 - ...withdetailsbyidinternalservererrorissue.md | 8 - ...getdocumentwithdetailsbyidnotfoundissue.md | 8 - ...cumentgetdocumentwithdetailsbyidrequest.md | 9 - ...entgetdocumentwithdetailsbyidtextalign5.md | 10 - ...entgetdocumentwithdetailsbyidtextalign6.md | 10 - docs/models/documentgetemailsettings.md | 14 + docs/models/documentgetenvelopeitem.md | 9 + docs/models/documentgetfield.md | 23 + docs/models/documentgetfieldmetacheckbox.md | 17 + docs/models/documentgetfieldmetadate.md | 14 + docs/models/documentgetfieldmetadropdown.md | 15 + docs/models/documentgetfieldmetaemail.md | 14 + docs/models/documentgetfieldmetainitials.md | 14 + docs/models/documentgetfieldmetaname.md | 14 + docs/models/documentgetfieldmetanumber.md | 21 + docs/models/documentgetfieldmetaradio.md | 15 + ...wn.md => documentgetfieldmetasignature.md} | 10 +- docs/models/documentgetfieldmetatext.md | 19 + docs/models/documentgetfieldmetaunion.md | 65 + ...idfieldtype.md => documentgetfieldtype.md} | 2 +- docs/models/documentgetfolder.md | 17 + ...foldertype.md => documentgetfoldertype.md} | 2 +- ...onse.md => documentgetfoldervisibility.md} | 2 +- docs/models/documentgetforbiddenerror.md | 12 + docs/models/documentgetforbiddenissue.md | 8 + ...uesrequest.md => documentgetformvalues.md} | 2 +- docs/models/documentgetglobalaccessauth.md | 9 + ...uest.md => documentgetglobalactionauth.md} | 4 +- docs/models/documentgetinternalservererror.md | 12 + .../documentgetinternalservererrorissue.md | 8 + docs/models/documentgetnotfounderror.md | 12 + docs/models/documentgetnotfoundissue.md | 8 + ...readstatus.md => documentgetreadstatus.md} | 2 +- ...entresponse.md => documentgetrecipient.md} | 37 +- .../models/documentgetrecipientauthoptions.md | 9 + docs/models/documentgetrequest.md | 8 + docs/models/documentgetresponse.md | 34 + docs/models/documentgetrole.md | 12 + ...sendstatus.md => documentgetsendstatus.md} | 2 +- ...ingorder.md => documentgetsigningorder.md} | 2 +- ...gstatus.md => documentgetsigningstatus.md} | 2 +- ...documentsource.md => documentgetsource.md} | 2 +- ...documentstatus.md => documentgetstatus.md} | 2 +- docs/models/documentgettextalign1.md | 10 + docs/models/documentgettextalign2.md | 10 + docs/models/documentgettextalign3.md | 10 + docs/models/documentgettextalign4.md | 10 + docs/models/documentgettextalign5.md | 10 + docs/models/documentgettextalign6.md | 10 + ...checkbox.md => documentgettypecheckbox.md} | 2 +- ...ieldtypedate.md => documentgettypedate.md} | 2 +- ...dropdown.md => documentgettypedropdown.md} | 2 +- docs/models/documentgettypeemail.md | 8 + docs/models/documentgettypeinitials.md | 8 + docs/models/documentgettypename.md | 8 + ...typenumber.md => documentgettypenumber.md} | 2 +- ...ldtyperadio.md => documentgettyperadio.md} | 2 +- docs/models/documentgettypesignature.md | 8 + ...ieldtypetext.md => documentgettypetext.md} | 2 +- docs/models/documentgetunauthorizederror.md | 12 + docs/models/documentgetunauthorizedissue.md | 8 + docs/models/documentgetvalue1.md | 10 + docs/models/documentgetvalue2.md | 10 + docs/models/documentgetvalue3.md | 8 + docs/models/documentgetverticalalign1.md | 10 + docs/models/documentgetverticalalign2.md | 10 + docs/models/documentgetvisibility.md | 10 + docs/models/documentglobalaccessauth.md | 9 +- docs/models/documentglobalactionauth.md | 2 - docs/models/documentrecipient.md | 9 +- .../documentredistributebadrequesterror.md | 12 + .../documentredistributebadrequestissue.md | 8 + .../documentredistributeforbiddenerror.md | 12 + .../documentredistributeforbiddenissue.md | 8 + ...ocumentredistributeinternalservererror.md} | 9 +- ...entredistributeinternalservererrorissue.md | 8 + docs/models/documentredistributerequest.md | 9 + ...nse.md => documentredistributeresponse.md} | 2 +- ... documentredistributeunauthorizederror.md} | 6 +- .../documentredistributeunauthorizedissue.md | 8 + ...tresenddocumentinternalservererrorissue.md | 8 - docs/models/documentresenddocumentrequest.md | 9 - docs/models/documentsenddocumentdateformat.md | 19 - .../documentsenddocumentdistributionmethod.md | 11 - .../documentsenddocumentemailsettings.md | 14 - .../documentsenddocumentglobalaccessauth.md | 10 - ...entsenddocumentinternalservererrorissue.md | 8 - docs/models/documentsenddocumentmeta.md | 15 - docs/models/documenttypesignature.md | 8 + docs/models/documentupdateauthoptions.md | 9 + docs/models/documentupdatebadrequesterror.md | 12 + docs/models/documentupdatebadrequestissue.md | 8 + docs/models/documentupdatedata.md | 14 + .../documentupdatedataglobalaccessauth.md | 9 + .../documentupdatedataglobalactionauth.md | 11 + docs/models/documentupdatedatavisibility.md | 10 + docs/models/documentupdatedateformat.md | 29 + .../documentupdatedistributionmethod.md | 9 + .../documentupdatedocumentbadrequestissue.md | 8 - docs/models/documentupdatedocumentdata.md | 13 - .../documentupdatedocumentdateformat.md | 19 - ...ocumentupdatedocumentdistributionmethod.md | 11 - .../documentupdatedocumentemailsettings.md | 14 - ...ntupdatedocumentglobalaccessauthrequest.md | 10 - ...tupdatedocumentglobalaccessauthresponse.md | 10 - ...tupdatedocumentglobalactionauthresponse.md | 13 - ...tupdatedocumentinternalservererrorissue.md | 8 - docs/models/documentupdatedocumentresponse.md | 27 - ...documentupdatedocumentvisibilityrequest.md | 12 - docs/models/documentupdateemailsettings.md | 14 + docs/models/documentupdateforbiddenerror.md | 12 + docs/models/documentupdateforbiddenissue.md | 8 + docs/models/documentupdateformvalues.md | 23 + .../documentupdateglobalaccessauthresponse.md | 9 + .../documentupdateglobalactionauthresponse.md | 11 + .../documentupdateinternalservererror.md | 12 + .../documentupdateinternalservererrorissue.md | 8 + docs/models/documentupdatelanguage.md | 13 + docs/models/documentupdatemeta.md | 22 + docs/models/documentupdaterequest.md | 10 + docs/models/documentupdateresponse.md | 29 + docs/models/documentupdatesigningorder.md | 9 + ...sbyidsource.md => documentupdatesource.md} | 2 +- ...sbyidstatus.md => documentupdatestatus.md} | 2 +- .../models/documentupdateunauthorizederror.md | 12 + .../models/documentupdateunauthorizedissue.md | 8 + .../documentupdatevisibilityresponse.md | 10 + docs/models/documentverticalalign1.md | 10 + docs/models/documentverticalalign2.md | 10 + ...eateembeddingpresigntokenforbiddenerror.md | 12 + ...eateembeddingpresigntokenforbiddenissue.md | 8 + ...esigncreateembeddingpresigntokenrequest.md | 6 +- ...signcreateembeddingpresigntokenresponse.md | 10 +- ...eembeddingpresigntokenunauthorizederror.md | 12 + ...eembeddingpresigntokenunauthorizedissue.md | 8 + ...rifyembeddingpresigntokenforbiddenerror.md | 12 + ...rifyembeddingpresigntokenforbiddenissue.md | 8 + ...esignverifyembeddingpresigntokenrequest.md | 6 +- ...yembeddingpresigntokenunauthorizederror.md | 12 + ...yembeddingpresigntokenunauthorizedissue.md | 8 + ...envelopeattachmentcreatebadrequesterror.md | 12 + ...envelopeattachmentcreatebadrequestissue.md | 8 + docs/models/envelopeattachmentcreatedata.md | 9 + .../envelopeattachmentcreateforbiddenerror.md | 12 + .../envelopeattachmentcreateforbiddenissue.md | 8 + ...lopeattachmentcreateinternalservererror.md | 12 + ...ttachmentcreateinternalservererrorissue.md | 8 + .../models/envelopeattachmentcreaterequest.md | 9 + .../envelopeattachmentcreateresponse.md | 10 + ...velopeattachmentcreateunauthorizederror.md | 12 + ...velopeattachmentcreateunauthorizedissue.md | 8 + ...envelopeattachmentdeletebadrequesterror.md | 12 + ...envelopeattachmentdeletebadrequestissue.md | 8 + .../envelopeattachmentdeleteforbiddenerror.md | 12 + .../envelopeattachmentdeleteforbiddenissue.md | 8 + ...lopeattachmentdeleteinternalservererror.md | 12 + ...ttachmentdeleteinternalservererrorissue.md | 8 + .../models/envelopeattachmentdeleterequest.md | 8 + .../envelopeattachmentdeleteresponse.md | 10 + ...velopeattachmentdeleteunauthorizederror.md | 12 + ...velopeattachmentdeleteunauthorizedissue.md | 8 + ... envelopeattachmentfindbadrequesterror.md} | 9 +- .../envelopeattachmentfindbadrequestissue.md | 8 + docs/models/envelopeattachmentfinddata.md | 11 + .../envelopeattachmentfindforbiddenerror.md | 12 + .../envelopeattachmentfindforbiddenissue.md | 8 + ...elopeattachmentfindinternalservererror.md} | 4 +- ...eattachmentfindinternalservererrorissue.md | 8 + .../envelopeattachmentfindnotfounderror.md | 12 + .../envelopeattachmentfindnotfoundissue.md | 8 + docs/models/envelopeattachmentfindrequest.md | 9 + docs/models/envelopeattachmentfindresponse.md | 10 + docs/models/envelopeattachmentfindtype.md | 8 + ...envelopeattachmentfindunauthorizederror.md | 12 + ...envelopeattachmentfindunauthorizedissue.md | 8 + ...envelopeattachmentupdatebadrequesterror.md | 12 + ...envelopeattachmentupdatebadrequestissue.md | 8 + docs/models/envelopeattachmentupdatedata.md | 9 + .../envelopeattachmentupdateforbiddenerror.md | 12 + .../envelopeattachmentupdateforbiddenissue.md | 8 + ...lopeattachmentupdateinternalservererror.md | 12 + ...ttachmentupdateinternalservererrorissue.md | 8 + .../models/envelopeattachmentupdaterequest.md | 9 + .../envelopeattachmentupdateresponse.md | 10 + ...velopeattachmentupdateunauthorizederror.md | 12 + ...velopeattachmentupdateunauthorizedissue.md | 8 + docs/models/envelopecreateaccessauth.md | 9 + docs/models/envelopecreateactionauth.md | 12 + docs/models/envelopecreateattachment.md | 10 + docs/models/envelopecreatebadrequesterror.md | 12 + docs/models/envelopecreatebadrequestissue.md | 8 + docs/models/envelopecreatedateformat.md | 29 + .../models/envelopecreatedirectioncheckbox.md | 9 + docs/models/envelopecreatedirectionradio.md | 9 + .../envelopecreatedistributionmethod.md | 9 + docs/models/envelopecreateemailsettings.md | 14 + docs/models/envelopecreatefieldcheckbox.md | 15 + docs/models/envelopecreatefielddate.md | 15 + docs/models/envelopecreatefielddropdown.md | 15 + docs/models/envelopecreatefieldemail.md | 15 + .../envelopecreatefieldfreesignature.md | 14 + docs/models/envelopecreatefieldinitials.md | 15 + .../models/envelopecreatefieldmetacheckbox.md | 17 + docs/models/envelopecreatefieldmetadate.md | 14 + .../models/envelopecreatefieldmetadropdown.md | 15 + docs/models/envelopecreatefieldmetaemail.md | 14 + .../models/envelopecreatefieldmetainitials.md | 14 + docs/models/envelopecreatefieldmetaname.md | 14 + docs/models/envelopecreatefieldmetanumber.md | 21 + docs/models/envelopecreatefieldmetaradio.md | 15 + .../envelopecreatefieldmetasignature.md | 13 + docs/models/envelopecreatefieldmetatext.md | 19 + docs/models/envelopecreatefieldname.md | 15 + docs/models/envelopecreatefieldnumber.md | 15 + docs/models/envelopecreatefieldradio.md | 15 + docs/models/envelopecreatefieldsignature.md | 15 + docs/models/envelopecreatefieldtext.md | 15 + docs/models/envelopecreatefieldunion.md | 71 + docs/models/envelopecreatefile.md | 10 + docs/models/envelopecreateforbiddenerror.md | 12 + docs/models/envelopecreateforbiddenissue.md | 8 + docs/models/envelopecreateformvalues.md | 23 + docs/models/envelopecreateglobalaccessauth.md | 9 + docs/models/envelopecreateglobalactionauth.md | 11 + docs/models/envelopecreateidentifier1.md | 17 + docs/models/envelopecreateidentifier10.md | 17 + docs/models/envelopecreateidentifier11.md | 17 + docs/models/envelopecreateidentifier2.md | 17 + docs/models/envelopecreateidentifier3.md | 17 + docs/models/envelopecreateidentifier4.md | 17 + docs/models/envelopecreateidentifier5.md | 17 + docs/models/envelopecreateidentifier6.md | 17 + docs/models/envelopecreateidentifier7.md | 17 + docs/models/envelopecreateidentifier8.md | 17 + docs/models/envelopecreateidentifier9.md | 17 + .../envelopecreateinternalservererror.md | 12 + .../envelopecreateinternalservererrorissue.md | 8 + docs/models/envelopecreatelanguage.md | 13 + docs/models/envelopecreatemeta.md | 22 + docs/models/envelopecreatepayload.md | 18 + docs/models/envelopecreaterecipient.md | 14 + docs/models/envelopecreaterequest.md | 9 + docs/models/envelopecreateresponse.md | 10 + docs/models/envelopecreaterole.md | 12 + docs/models/envelopecreatesigningorder.md | 9 + docs/models/envelopecreatetextaligndate.md | 10 + docs/models/envelopecreatetextalignemail.md | 10 + .../models/envelopecreatetextaligninitials.md | 10 + docs/models/envelopecreatetextalignname.md | 10 + docs/models/envelopecreatetextalignnumber.md | 10 + docs/models/envelopecreatetextaligntext.md | 10 + docs/models/envelopecreatetype.md | 9 + docs/models/envelopecreatetypecheckbox1.md | 8 + docs/models/envelopecreatetypecheckbox2.md | 8 + docs/models/envelopecreatetypedate1.md | 8 + docs/models/envelopecreatetypedate2.md | 8 + docs/models/envelopecreatetypedropdown1.md | 8 + docs/models/envelopecreatetypedropdown2.md | 8 + docs/models/envelopecreatetypeemail1.md | 8 + docs/models/envelopecreatetypeemail2.md | 8 + .../models/envelopecreatetypefreesignature.md | 8 + docs/models/envelopecreatetypeinitials1.md | 8 + docs/models/envelopecreatetypeinitials2.md | 8 + docs/models/envelopecreatetypelink.md | 8 + docs/models/envelopecreatetypename1.md | 8 + docs/models/envelopecreatetypename2.md | 8 + docs/models/envelopecreatetypenumber1.md | 8 + docs/models/envelopecreatetypenumber2.md | 8 + docs/models/envelopecreatetyperadio1.md | 8 + docs/models/envelopecreatetyperadio2.md | 8 + ...ure.md => envelopecreatetypesignature1.md} | 2 +- docs/models/envelopecreatetypesignature2.md | 8 + docs/models/envelopecreatetypetext1.md | 8 + docs/models/envelopecreatetypetext2.md | 8 + .../models/envelopecreateunauthorizederror.md | 12 + .../models/envelopecreateunauthorizedissue.md | 8 + docs/models/envelopecreatevaluecheckbox.md | 10 + docs/models/envelopecreatevaluedropdown.md | 8 + docs/models/envelopecreatevalueradio.md | 10 + .../envelopecreateverticalalignnumber.md | 10 + .../models/envelopecreateverticalaligntext.md | 10 + docs/models/envelopecreatevisibility.md | 10 + docs/models/envelopedeletebadrequesterror.md | 12 + docs/models/envelopedeletebadrequestissue.md | 8 + docs/models/envelopedeleteforbiddenerror.md | 12 + docs/models/envelopedeleteforbiddenissue.md | 8 + .../envelopedeleteinternalservererror.md | 12 + .../envelopedeleteinternalservererrorissue.md | 8 + docs/models/envelopedeleterequest.md | 8 + docs/models/envelopedeleteresponse.md | 10 + .../models/envelopedeleteunauthorizederror.md | 12 + .../models/envelopedeleteunauthorizedissue.md | 8 + .../envelopedistributebadrequesterror.md | 12 + .../envelopedistributebadrequestissue.md | 8 + docs/models/envelopedistributedateformat.md | 29 + .../envelopedistributedistributionmethod.md | 9 + .../models/envelopedistributeemailsettings.md | 14 + .../envelopedistributeforbiddenerror.md | 12 + .../envelopedistributeforbiddenissue.md | 8 + .../envelopedistributeinternalservererror.md | 12 + ...elopedistributeinternalservererrorissue.md | 8 + docs/models/envelopedistributelanguage.md | 13 + docs/models/envelopedistributemeta.md | 17 + docs/models/envelopedistributerequest.md | 9 + docs/models/envelopedistributeresponse.md | 10 + .../envelopedistributeunauthorizederror.md | 12 + .../envelopedistributeunauthorizedissue.md | 8 + .../envelopeduplicatebadrequesterror.md | 12 + .../envelopeduplicatebadrequestissue.md | 8 + .../models/envelopeduplicateforbiddenerror.md | 12 + .../models/envelopeduplicateforbiddenissue.md | 8 + .../envelopeduplicateinternalservererror.md | 12 + ...velopeduplicateinternalservererrorissue.md | 8 + docs/models/envelopeduplicaterequest.md | 8 + docs/models/envelopeduplicateresponse.md | 10 + .../envelopeduplicateunauthorizederror.md | 12 + .../envelopeduplicateunauthorizedissue.md | 8 + .../envelopefieldcreatemanybadrequesterror.md | 12 + .../envelopefieldcreatemanybadrequestissue.md | 8 + .../envelopefieldcreatemanydatacheckbox.md | 16 + .../models/envelopefieldcreatemanydatadate.md | 16 + .../envelopefieldcreatemanydatadropdown.md | 16 + ...md => envelopefieldcreatemanydataemail.md} | 18 +- ...nvelopefieldcreatemanydatafreesignature.md | 15 + .../envelopefieldcreatemanydatainitials.md | 16 + .../models/envelopefieldcreatemanydataname.md | 16 + ...d => envelopefieldcreatemanydatanumber.md} | 21 +- .../envelopefieldcreatemanydataradio.md | 16 + .../envelopefieldcreatemanydataresponse.md | 23 + ...> envelopefieldcreatemanydatasignature.md} | 23 +- .../models/envelopefieldcreatemanydatatext.md | 16 + .../envelopefieldcreatemanydataunion.md | 71 + ...nvelopefieldcreatemanydirectioncheckbox.md | 9 + .../envelopefieldcreatemanydirectionradio.md | 9 + ...velopefieldcreatemanydirectionresponse1.md | 9 + ...velopefieldcreatemanydirectionresponse2.md | 9 + ...fieldcreatemanyfieldmetacheckboxrequest.md | 17 + ...ieldcreatemanyfieldmetacheckboxresponse.md | 17 + ...lopefieldcreatemanyfieldmetadaterequest.md | 14 + ...pefieldcreatemanyfieldmetadateresponse.md} | 8 +- ...ieldcreatemanyfieldmetadropdownrequest.md} | 8 +- ...ieldcreatemanyfieldmetadropdownresponse.md | 15 + ...opefieldcreatemanyfieldmetaemailrequest.md | 14 + ...pefieldcreatemanyfieldmetaemailresponse.md | 14 + ...fieldcreatemanyfieldmetainitialsrequest.md | 14 + ...ieldcreatemanyfieldmetainitialsresponse.md | 14 + ...lopefieldcreatemanyfieldmetanamerequest.md | 14 + ...opefieldcreatemanyfieldmetanameresponse.md | 14 + ...pefieldcreatemanyfieldmetanumberrequest.md | 21 + ...efieldcreatemanyfieldmetanumberresponse.md | 21 + ...opefieldcreatemanyfieldmetaradiorequest.md | 15 + ...efieldcreatemanyfieldmetaradioresponse.md} | 10 +- ...ieldcreatemanyfieldmetasignaturerequest.md | 13 + ...eldcreatemanyfieldmetasignatureresponse.md | 13 + ...opefieldcreatemanyfieldmetatextrequest.md} | 15 +- ...opefieldcreatemanyfieldmetatextresponse.md | 19 + ...opefieldcreatemanyfieldmetatypecheckbox.md | 8 + ...nvelopefieldcreatemanyfieldmetatypedate.md | 8 + ...opefieldcreatemanyfieldmetatypedropdown.md | 8 + ...velopefieldcreatemanyfieldmetatypeemail.md | 8 + ...opefieldcreatemanyfieldmetatypeinitials.md | 8 + ...nvelopefieldcreatemanyfieldmetatypename.md | 8 + ...elopefieldcreatemanyfieldmetatypenumber.md | 8 + ...velopefieldcreatemanyfieldmetatyperadio.md | 8 + ...pefieldcreatemanyfieldmetatypesignature.md | 8 + ...nvelopefieldcreatemanyfieldmetatypetext.md | 8 + .../envelopefieldcreatemanyfieldmetaunion.md | 65 + .../envelopefieldcreatemanyforbiddenerror.md | 12 + .../envelopefieldcreatemanyforbiddenissue.md | 8 + ...lopefieldcreatemanyinternalservererror.md} | 6 +- ...fieldcreatemanyinternalservererrorissue.md | 8 + docs/models/envelopefieldcreatemanyrequest.md | 9 + .../models/envelopefieldcreatemanyresponse.md | 10 + .../envelopefieldcreatemanytextaligndate.md | 10 + .../envelopefieldcreatemanytextalignemail.md | 10 + ...nvelopefieldcreatemanytextaligninitials.md | 10 + .../envelopefieldcreatemanytextalignname.md | 10 + .../envelopefieldcreatemanytextalignnumber.md | 10 + ...velopefieldcreatemanytextalignresponse1.md | 10 + ...velopefieldcreatemanytextalignresponse2.md | 10 + ...velopefieldcreatemanytextalignresponse3.md | 10 + ...velopefieldcreatemanytextalignresponse4.md | 10 + ...velopefieldcreatemanytextalignresponse5.md | 10 + ...velopefieldcreatemanytextalignresponse6.md | 10 + .../envelopefieldcreatemanytextaligntext.md | 10 + ...lopefieldcreatemanytypecheckboxrequest1.md | 8 + ...lopefieldcreatemanytypecheckboxrequest2.md | 8 + ...envelopefieldcreatemanytypedaterequest1.md | 8 + ...envelopefieldcreatemanytypedaterequest2.md | 8 + ...lopefieldcreatemanytypedropdownrequest1.md | 8 + ...lopefieldcreatemanytypedropdownrequest2.md | 8 + ...nvelopefieldcreatemanytypeemailrequest1.md | 8 + ...nvelopefieldcreatemanytypeemailrequest2.md | 8 + ...nvelopefieldcreatemanytypefreesignature.md | 8 + ...lopefieldcreatemanytypeinitialsrequest1.md | 8 + ...lopefieldcreatemanytypeinitialsrequest2.md | 8 + ...envelopefieldcreatemanytypenamerequest1.md | 8 + ...envelopefieldcreatemanytypenamerequest2.md | 8 + ...velopefieldcreatemanytypenumberrequest1.md | 8 + ...velopefieldcreatemanytypenumberrequest2.md | 8 + ...nvelopefieldcreatemanytyperadiorequest1.md | 8 + ...nvelopefieldcreatemanytyperadiorequest2.md | 8 + .../envelopefieldcreatemanytyperesponse.md | 18 + ...pefieldcreatemanytypesignaturerequest1.md} | 2 +- ...opefieldcreatemanytypesignaturerequest2.md | 8 + ...envelopefieldcreatemanytypetextrequest1.md | 8 + ...envelopefieldcreatemanytypetextrequest2.md | 8 + ...nvelopefieldcreatemanyunauthorizederror.md | 12 + ...nvelopefieldcreatemanyunauthorizedissue.md | 8 + .../envelopefieldcreatemanyvaluecheckbox.md | 10 + .../envelopefieldcreatemanyvaluedropdown.md | 8 + .../envelopefieldcreatemanyvalueradio.md | 10 + .../envelopefieldcreatemanyvalueresponse1.md | 10 + .../envelopefieldcreatemanyvalueresponse2.md | 10 + .../envelopefieldcreatemanyvalueresponse3.md | 8 + ...elopefieldcreatemanyverticalalignnumber.md | 10 + ...pefieldcreatemanyverticalalignresponse1.md | 10 + ...pefieldcreatemanyverticalalignresponse2.md | 10 + ...nvelopefieldcreatemanyverticalaligntext.md | 10 + ... => envelopefielddeletebadrequesterror.md} | 6 +- .../envelopefielddeletebadrequestissue.md | 8 + .../envelopefielddeleteforbiddenerror.md | 12 + .../envelopefielddeleteforbiddenissue.md | 8 + .../envelopefielddeleteinternalservererror.md | 12 + ...lopefielddeleteinternalservererrorissue.md | 8 + docs/models/envelopefielddeleterequest.md | 8 + docs/models/envelopefielddeleteresponse.md | 10 + .../envelopefielddeleteunauthorizederror.md | 12 + .../envelopefielddeleteunauthorizedissue.md | 8 + .../models/envelopefieldgetbadrequesterror.md | 12 + .../models/envelopefieldgetbadrequestissue.md | 8 + docs/models/envelopefieldgetdirection1.md | 9 + docs/models/envelopefieldgetdirection2.md | 9 + .../envelopefieldgetfieldmetacheckbox.md | 17 + docs/models/envelopefieldgetfieldmetadate.md | 14 + .../envelopefieldgetfieldmetadropdown.md | 15 + docs/models/envelopefieldgetfieldmetaemail.md | 14 + .../envelopefieldgetfieldmetainitials.md | 14 + docs/models/envelopefieldgetfieldmetaname.md | 14 + .../models/envelopefieldgetfieldmetanumber.md | 21 + docs/models/envelopefieldgetfieldmetaradio.md | 15 + .../envelopefieldgetfieldmetasignature.md | 13 + docs/models/envelopefieldgetfieldmetatext.md | 19 + docs/models/envelopefieldgetfieldmetaunion.md | 65 + docs/models/envelopefieldgetforbiddenerror.md | 12 + docs/models/envelopefieldgetforbiddenissue.md | 8 + .../envelopefieldgetinternalservererror.md | 12 + ...nvelopefieldgetinternalservererrorissue.md | 8 + docs/models/envelopefieldgetnotfounderror.md | 12 + docs/models/envelopefieldgetnotfoundissue.md | 8 + docs/models/envelopefieldgetrequest.md | 8 + docs/models/envelopefieldgetresponse.md | 23 + docs/models/envelopefieldgettextalign1.md | 10 + docs/models/envelopefieldgettextalign2.md | 10 + docs/models/envelopefieldgettextalign3.md | 10 + docs/models/envelopefieldgettextalign4.md | 10 + docs/models/envelopefieldgettextalign5.md | 10 + docs/models/envelopefieldgettextalign6.md | 10 + docs/models/envelopefieldgettype.md | 18 + docs/models/envelopefieldgettypecheckbox.md | 8 + docs/models/envelopefieldgettypedate.md | 8 + docs/models/envelopefieldgettypedropdown.md | 8 + docs/models/envelopefieldgettypeemail.md | 8 + docs/models/envelopefieldgettypeinitials.md | 8 + docs/models/envelopefieldgettypename.md | 8 + docs/models/envelopefieldgettypenumber.md | 8 + docs/models/envelopefieldgettyperadio.md | 8 + docs/models/envelopefieldgettypesignature.md | 8 + docs/models/envelopefieldgettypetext.md | 8 + .../envelopefieldgetunauthorizederror.md | 12 + .../envelopefieldgetunauthorizedissue.md | 8 + docs/models/envelopefieldgetvalue1.md | 10 + docs/models/envelopefieldgetvalue2.md | 10 + docs/models/envelopefieldgetvalue3.md | 8 + docs/models/envelopefieldgetverticalalign1.md | 10 + docs/models/envelopefieldgetverticalalign2.md | 10 + .../envelopefieldupdatemanybadrequesterror.md | 12 + .../envelopefieldupdatemanybadrequestissue.md | 8 + .../envelopefieldupdatemanydatacheckbox.md | 16 + .../models/envelopefieldupdatemanydatadate.md | 16 + .../envelopefieldupdatemanydatadropdown.md | 16 + ...md => envelopefieldupdatemanydataemail.md} | 20 +- ...nvelopefieldupdatemanydatafreesignature.md | 15 + .../envelopefieldupdatemanydatainitials.md | 16 + .../models/envelopefieldupdatemanydataname.md | 16 + .../envelopefieldupdatemanydatanumber.md | 16 + ...md => envelopefieldupdatemanydataradio.md} | 18 +- .../envelopefieldupdatemanydataresponse.md | 23 + .../envelopefieldupdatemanydatasignature.md | 16 + .../models/envelopefieldupdatemanydatatext.md | 16 + .../envelopefieldupdatemanydataunion.md | 71 + ...nvelopefieldupdatemanydirectioncheckbox.md | 9 + .../envelopefieldupdatemanydirectionradio.md | 9 + ...velopefieldupdatemanydirectionresponse1.md | 9 + ...velopefieldupdatemanydirectionresponse2.md | 9 + ...fieldupdatemanyfieldmetacheckboxrequest.md | 17 + ...ieldupdatemanyfieldmetacheckboxresponse.md | 17 + ...lopefieldupdatemanyfieldmetadaterequest.md | 14 + ...opefieldupdatemanyfieldmetadateresponse.md | 14 + ...fieldupdatemanyfieldmetadropdownrequest.md | 15 + ...ieldupdatemanyfieldmetadropdownresponse.md | 15 + ...opefieldupdatemanyfieldmetaemailrequest.md | 14 + ...pefieldupdatemanyfieldmetaemailresponse.md | 14 + ...fieldupdatemanyfieldmetainitialsrequest.md | 14 + ...ieldupdatemanyfieldmetainitialsresponse.md | 14 + ...lopefieldupdatemanyfieldmetanamerequest.md | 14 + ...opefieldupdatemanyfieldmetanameresponse.md | 14 + ...pefieldupdatemanyfieldmetanumberrequest.md | 21 + ...efieldupdatemanyfieldmetanumberresponse.md | 21 + ...opefieldupdatemanyfieldmetaradiorequest.md | 15 + ...pefieldupdatemanyfieldmetaradioresponse.md | 15 + ...ieldupdatemanyfieldmetasignaturerequest.md | 13 + ...eldupdatemanyfieldmetasignatureresponse.md | 13 + ...opefieldupdatemanyfieldmetatextrequest.md} | 11 +- ...opefieldupdatemanyfieldmetatextresponse.md | 19 + ...opefieldupdatemanyfieldmetatypecheckbox.md | 8 + ...nvelopefieldupdatemanyfieldmetatypedate.md | 8 + ...opefieldupdatemanyfieldmetatypedropdown.md | 8 + ...velopefieldupdatemanyfieldmetatypeemail.md | 8 + ...opefieldupdatemanyfieldmetatypeinitials.md | 8 + ...nvelopefieldupdatemanyfieldmetatypename.md | 8 + ...elopefieldupdatemanyfieldmetatypenumber.md | 8 + ...velopefieldupdatemanyfieldmetatyperadio.md | 8 + ...pefieldupdatemanyfieldmetatypesignature.md | 8 + ...nvelopefieldupdatemanyfieldmetatypetext.md | 8 + .../envelopefieldupdatemanyfieldmetaunion.md | 65 + .../envelopefieldupdatemanyforbiddenerror.md | 12 + .../envelopefieldupdatemanyforbiddenissue.md | 8 + ...lopefieldupdatemanyinternalservererror.md} | 11 +- ...fieldupdatemanyinternalservererrorissue.md | 8 + docs/models/envelopefieldupdatemanyrequest.md | 9 + .../models/envelopefieldupdatemanyresponse.md | 10 + .../envelopefieldupdatemanytextaligndate.md | 10 + .../envelopefieldupdatemanytextalignemail.md | 10 + ...nvelopefieldupdatemanytextaligninitials.md | 10 + .../envelopefieldupdatemanytextalignname.md | 10 + .../envelopefieldupdatemanytextalignnumber.md | 10 + ...velopefieldupdatemanytextalignresponse1.md | 10 + ...velopefieldupdatemanytextalignresponse2.md | 10 + ...velopefieldupdatemanytextalignresponse3.md | 10 + ...velopefieldupdatemanytextalignresponse4.md | 10 + ...velopefieldupdatemanytextalignresponse5.md | 10 + ...velopefieldupdatemanytextalignresponse6.md | 10 + .../envelopefieldupdatemanytextaligntext.md | 10 + ...lopefieldupdatemanytypecheckboxrequest1.md | 8 + ...lopefieldupdatemanytypecheckboxrequest2.md | 8 + ...envelopefieldupdatemanytypedaterequest1.md | 8 + ...envelopefieldupdatemanytypedaterequest2.md | 8 + ...lopefieldupdatemanytypedropdownrequest1.md | 8 + ...lopefieldupdatemanytypedropdownrequest2.md | 8 + ...nvelopefieldupdatemanytypeemailrequest1.md | 8 + ...nvelopefieldupdatemanytypeemailrequest2.md | 8 + ...nvelopefieldupdatemanytypefreesignature.md | 8 + ...lopefieldupdatemanytypeinitialsrequest1.md | 8 + ...lopefieldupdatemanytypeinitialsrequest2.md | 8 + ...envelopefieldupdatemanytypenamerequest1.md | 8 + ...envelopefieldupdatemanytypenamerequest2.md | 8 + ...velopefieldupdatemanytypenumberrequest1.md | 8 + ...velopefieldupdatemanytypenumberrequest2.md | 8 + ...nvelopefieldupdatemanytyperadiorequest1.md | 8 + ...nvelopefieldupdatemanytyperadiorequest2.md | 8 + .../envelopefieldupdatemanytyperesponse.md | 18 + ...pefieldupdatemanytypesignaturerequest1.md} | 2 +- ...opefieldupdatemanytypesignaturerequest2.md | 8 + ...envelopefieldupdatemanytypetextrequest1.md | 8 + ...envelopefieldupdatemanytypetextrequest2.md | 8 + ...nvelopefieldupdatemanyunauthorizederror.md | 12 + ...nvelopefieldupdatemanyunauthorizedissue.md | 8 + .../envelopefieldupdatemanyvaluecheckbox.md | 10 + .../envelopefieldupdatemanyvaluedropdown.md | 8 + .../envelopefieldupdatemanyvalueradio.md | 10 + .../envelopefieldupdatemanyvalueresponse1.md | 10 + .../envelopefieldupdatemanyvalueresponse2.md | 10 + .../envelopefieldupdatemanyvalueresponse3.md | 8 + ...elopefieldupdatemanyverticalalignnumber.md | 10 + ...pefieldupdatemanyverticalalignresponse1.md | 10 + ...pefieldupdatemanyverticalalignresponse2.md | 10 + ...nvelopefieldupdatemanyverticalaligntext.md | 10 + docs/models/envelopegetaccessauth.md | 9 + docs/models/envelopegetactionauth.md | 12 + docs/models/envelopegetauthoptions.md | 9 + docs/models/envelopegetbadrequesterror.md | 12 + docs/models/envelopegetbadrequestissue.md | 8 + docs/models/envelopegetdirection1.md | 9 + docs/models/envelopegetdirection2.md | 9 + docs/models/envelopegetdirectlink.md | 11 + docs/models/envelopegetdistributionmethod.md | 9 + docs/models/envelopegetdocumentmeta.md | 23 + docs/models/envelopegetemailsettings.md | 14 + docs/models/envelopegetenvelopeitem.md | 11 + docs/models/envelopegetfield.md | 21 + docs/models/envelopegetfieldmetacheckbox.md | 17 + docs/models/envelopegetfieldmetadate.md | 14 + docs/models/envelopegetfieldmetadropdown.md | 15 + docs/models/envelopegetfieldmetaemail.md | 14 + docs/models/envelopegetfieldmetainitials.md | 14 + docs/models/envelopegetfieldmetaname.md | 14 + docs/models/envelopegetfieldmetanumber.md | 21 + docs/models/envelopegetfieldmetaradio.md | 15 + ...ox.md => envelopegetfieldmetasignature.md} | 10 +- docs/models/envelopegetfieldmetatext.md | 19 + docs/models/envelopegetfieldmetaunion.md | 65 + docs/models/envelopegetfieldtype.md | 18 + docs/models/envelopegetforbiddenerror.md | 12 + docs/models/envelopegetforbiddenissue.md | 8 + docs/models/envelopegetformvalues.md | 23 + docs/models/envelopegetglobalaccessauth.md | 9 + docs/models/envelopegetglobalactionauth.md | 11 + docs/models/envelopegetinternalservererror.md | 12 + .../envelopegetinternalservererrorissue.md | 8 + docs/models/envelopegetnotfounderror.md | 12 + docs/models/envelopegetnotfoundissue.md | 8 + docs/models/envelopegetreadstatus.md | 9 + docs/models/envelopegetrecipient.md | 22 + .../models/envelopegetrecipientauthoptions.md | 9 + docs/models/envelopegetrequest.md | 8 + docs/models/envelopegetresponse.md | 38 + docs/models/envelopegetrole.md | 12 + docs/models/envelopegetsendstatus.md | 9 + docs/models/envelopegetsigningorder.md | 9 + docs/models/envelopegetsigningstatus.md | 10 + docs/models/envelopegetsource.md | 10 + docs/models/envelopegetstatus.md | 11 + docs/models/envelopegetteam.md | 9 + docs/models/envelopegettemplatetype.md | 9 + docs/models/envelopegettextalign1.md | 10 + docs/models/envelopegettextalign2.md | 10 + docs/models/envelopegettextalign3.md | 10 + docs/models/envelopegettextalign4.md | 10 + docs/models/envelopegettextalign5.md | 10 + docs/models/envelopegettextalign6.md | 10 + docs/models/envelopegettype.md | 9 + docs/models/envelopegettypecheckbox.md | 8 + docs/models/envelopegettypedate.md | 8 + docs/models/envelopegettypedropdown.md | 8 + docs/models/envelopegettypeemail.md | 8 + docs/models/envelopegettypeinitials.md | 8 + docs/models/envelopegettypename.md | 8 + docs/models/envelopegettypenumber.md | 8 + docs/models/envelopegettyperadio.md | 8 + docs/models/envelopegettypesignature.md | 8 + docs/models/envelopegettypetext.md | 8 + docs/models/envelopegetunauthorizederror.md | 12 + docs/models/envelopegetunauthorizedissue.md | 8 + docs/models/envelopegetuser.md | 10 + docs/models/envelopegetvalue1.md | 10 + docs/models/envelopegetvalue2.md | 10 + docs/models/envelopegetvalue3.md | 8 + docs/models/envelopegetverticalalign1.md | 10 + docs/models/envelopegetverticalalign2.md | 10 + docs/models/envelopegetvisibility.md | 10 + .../envelopeitemcreatemanybadrequesterror.md | 12 + .../envelopeitemcreatemanybadrequestissue.md | 8 + docs/models/envelopeitemcreatemanydata.md | 11 + docs/models/envelopeitemcreatemanyfile.md | 10 + .../envelopeitemcreatemanyforbiddenerror.md | 12 + .../envelopeitemcreatemanyforbiddenissue.md | 8 + ...elopeitemcreatemanyinternalservererror.md} | 4 +- ...eitemcreatemanyinternalservererrorissue.md | 8 + docs/models/envelopeitemcreatemanypayload.md | 8 + ...st.md => envelopeitemcreatemanyrequest.md} | 6 +- docs/models/envelopeitemcreatemanyresponse.md | 10 + ...envelopeitemcreatemanyunauthorizederror.md | 12 + ...envelopeitemcreatemanyunauthorizedissue.md | 8 + .../envelopeitemdeletebadrequesterror.md | 12 + .../envelopeitemdeletebadrequestissue.md | 8 + .../envelopeitemdeleteforbiddenerror.md | 12 + .../envelopeitemdeleteforbiddenissue.md | 8 + .../envelopeitemdeleteinternalservererror.md | 12 + ...elopeitemdeleteinternalservererrorissue.md | 8 + docs/models/envelopeitemdeleterequest.md | 9 + docs/models/envelopeitemdeleteresponse.md | 10 + .../envelopeitemdeleteunauthorizederror.md | 12 + .../envelopeitemdeleteunauthorizedissue.md | 8 + .../envelopeitemdownloadbadrequesterror.md | 12 + .../envelopeitemdownloadbadrequestissue.md | 8 + .../envelopeitemdownloadforbiddenerror.md | 12 + .../envelopeitemdownloadforbiddenissue.md | 8 + ...envelopeitemdownloadinternalservererror.md | 12 + ...opeitemdownloadinternalservererrorissue.md | 8 + .../envelopeitemdownloadnotfounderror.md | 12 + .../envelopeitemdownloadnotfoundissue.md | 8 + docs/models/envelopeitemdownloadrequest.md | 9 + docs/models/envelopeitemdownloadresponse.md | 9 + .../envelopeitemdownloadunauthorizederror.md | 12 + .../envelopeitemdownloadunauthorizedissue.md | 8 + docs/models/envelopeitemdownloadversion.md | 11 + .../envelopeitemupdatemanybadrequesterror.md | 12 + .../envelopeitemupdatemanybadrequestissue.md | 8 + .../envelopeitemupdatemanydatarequest.md | 10 + .../envelopeitemupdatemanydataresponse.md | 11 + .../envelopeitemupdatemanyforbiddenerror.md | 12 + .../envelopeitemupdatemanyforbiddenissue.md | 8 + ...elopeitemupdatemanyinternalservererror.md} | 9 +- ...eitemupdatemanyinternalservererrorissue.md | 8 + docs/models/envelopeitemupdatemanyrequest.md | 9 + docs/models/envelopeitemupdatemanyresponse.md | 10 + ...envelopeitemupdatemanyunauthorizederror.md | 12 + ...envelopeitemupdatemanyunauthorizedissue.md | 8 + ...operecipientcreatemanyaccessauthrequest.md | 9 + ...perecipientcreatemanyaccessauthresponse.md | 9 + ...operecipientcreatemanyactionauthrequest.md | 12 + ...perecipientcreatemanyactionauthresponse.md | 12 + .../enveloperecipientcreatemanyauthoptions.md | 9 + ...eloperecipientcreatemanybadrequesterror.md | 12 + ...eloperecipientcreatemanybadrequestissue.md | 8 + .../enveloperecipientcreatemanydatarequest.md | 13 + ...enveloperecipientcreatemanydataresponse.md | 22 + ...veloperecipientcreatemanyforbiddenerror.md | 12 + ...veloperecipientcreatemanyforbiddenissue.md | 8 + ...erecipientcreatemanyinternalservererror.md | 12 + ...pientcreatemanyinternalservererrorissue.md | 8 + .../enveloperecipientcreatemanyreadstatus.md | 9 + .../enveloperecipientcreatemanyrequest.md | 9 + .../enveloperecipientcreatemanyresponse.md | 10 + .../enveloperecipientcreatemanyrolerequest.md | 12 + ...enveloperecipientcreatemanyroleresponse.md | 12 + .../enveloperecipientcreatemanysendstatus.md | 9 + ...nveloperecipientcreatemanysigningstatus.md | 10 + ...operecipientcreatemanyunauthorizederror.md | 12 + ...operecipientcreatemanyunauthorizedissue.md | 8 + .../enveloperecipientdeletebadrequesterror.md | 12 + .../enveloperecipientdeletebadrequestissue.md | 8 + .../enveloperecipientdeleteforbiddenerror.md | 12 + .../enveloperecipientdeleteforbiddenissue.md | 8 + ...eloperecipientdeleteinternalservererror.md | 12 + ...recipientdeleteinternalservererrorissue.md | 8 + docs/models/enveloperecipientdeleterequest.md | 8 + .../models/enveloperecipientdeleteresponse.md | 10 + ...nveloperecipientdeleteunauthorizederror.md | 12 + ...nveloperecipientdeleteunauthorizedissue.md | 8 + docs/models/enveloperecipientgetaccessauth.md | 9 + docs/models/enveloperecipientgetactionauth.md | 12 + .../models/enveloperecipientgetauthoptions.md | 9 + .../enveloperecipientgetbadrequesterror.md | 12 + .../enveloperecipientgetbadrequestissue.md | 8 + docs/models/enveloperecipientgetdirection1.md | 9 + docs/models/enveloperecipientgetdirection2.md | 9 + docs/models/enveloperecipientgetfield.md | 23 + .../enveloperecipientgetfieldmetacheckbox.md | 17 + .../enveloperecipientgetfieldmetadate.md | 14 + .../enveloperecipientgetfieldmetadropdown.md | 15 + .../enveloperecipientgetfieldmetaemail.md | 14 + .../enveloperecipientgetfieldmetainitials.md | 14 + .../enveloperecipientgetfieldmetaname.md | 14 + .../enveloperecipientgetfieldmetanumber.md | 21 + .../enveloperecipientgetfieldmetaradio.md | 15 + .../enveloperecipientgetfieldmetasignature.md | 13 + .../enveloperecipientgetfieldmetatext.md | 19 + .../enveloperecipientgetfieldmetaunion.md | 65 + .../enveloperecipientgetforbiddenerror.md | 12 + .../enveloperecipientgetforbiddenissue.md | 8 + ...enveloperecipientgetinternalservererror.md | 12 + ...operecipientgetinternalservererrorissue.md | 8 + .../enveloperecipientgetnotfounderror.md | 12 + .../enveloperecipientgetnotfoundissue.md | 8 + docs/models/enveloperecipientgetreadstatus.md | 9 + docs/models/enveloperecipientgetrequest.md | 8 + docs/models/enveloperecipientgetresponse.md | 25 + docs/models/enveloperecipientgetrole.md | 12 + docs/models/enveloperecipientgetsendstatus.md | 9 + .../enveloperecipientgetsigningstatus.md | 10 + docs/models/enveloperecipientgettextalign1.md | 10 + docs/models/enveloperecipientgettextalign2.md | 10 + docs/models/enveloperecipientgettextalign3.md | 10 + docs/models/enveloperecipientgettextalign4.md | 10 + docs/models/enveloperecipientgettextalign5.md | 10 + docs/models/enveloperecipientgettextalign6.md | 10 + docs/models/enveloperecipientgettype.md | 18 + .../enveloperecipientgettypecheckbox.md | 8 + docs/models/enveloperecipientgettypedate.md | 8 + .../enveloperecipientgettypedropdown.md | 8 + docs/models/enveloperecipientgettypeemail.md | 8 + .../enveloperecipientgettypeinitials.md | 8 + docs/models/enveloperecipientgettypename.md | 8 + docs/models/enveloperecipientgettypenumber.md | 8 + docs/models/enveloperecipientgettyperadio.md | 8 + .../enveloperecipientgettypesignature.md | 8 + docs/models/enveloperecipientgettypetext.md | 8 + .../enveloperecipientgetunauthorizederror.md | 12 + .../enveloperecipientgetunauthorizedissue.md | 8 + docs/models/enveloperecipientgetvalue1.md | 10 + docs/models/enveloperecipientgetvalue2.md | 10 + docs/models/enveloperecipientgetvalue3.md | 8 + .../enveloperecipientgetverticalalign1.md | 10 + .../enveloperecipientgetverticalalign2.md | 10 + ...operecipientupdatemanyaccessauthrequest.md | 9 + ...perecipientupdatemanyaccessauthresponse.md | 9 + ...operecipientupdatemanyactionauthrequest.md | 12 + ...perecipientupdatemanyactionauthresponse.md | 12 + .../enveloperecipientupdatemanyauthoptions.md | 9 + ...eloperecipientupdatemanybadrequesterror.md | 12 + ...eloperecipientupdatemanybadrequestissue.md | 8 + .../enveloperecipientupdatemanydatarequest.md | 14 + ...enveloperecipientupdatemanydataresponse.md | 24 + ...veloperecipientupdatemanyforbiddenerror.md | 12 + ...veloperecipientupdatemanyforbiddenissue.md | 8 + ...erecipientupdatemanyinternalservererror.md | 12 + ...pientupdatemanyinternalservererrorissue.md | 8 + .../enveloperecipientupdatemanyreadstatus.md | 9 + .../enveloperecipientupdatemanyrequest.md | 9 + .../enveloperecipientupdatemanyresponse.md | 10 + .../enveloperecipientupdatemanyrolerequest.md | 12 + ...enveloperecipientupdatemanyroleresponse.md | 12 + .../enveloperecipientupdatemanysendstatus.md | 9 + ...nveloperecipientupdatemanysigningstatus.md | 10 + ...operecipientupdatemanyunauthorizederror.md | 12 + ...operecipientupdatemanyunauthorizedissue.md | 8 + .../enveloperedistributebadrequesterror.md | 12 + .../enveloperedistributebadrequestissue.md | 8 + .../enveloperedistributeforbiddenerror.md | 12 + .../enveloperedistributeforbiddenissue.md | 8 + ...enveloperedistributeinternalservererror.md | 12 + ...operedistributeinternalservererrorissue.md | 8 + docs/models/enveloperedistributerequest.md | 9 + docs/models/enveloperedistributeresponse.md | 10 + .../enveloperedistributeunauthorizederror.md | 12 + .../enveloperedistributeunauthorizedissue.md | 8 + docs/models/envelopeupdateauthoptions.md | 9 + docs/models/envelopeupdatebadrequesterror.md | 12 + docs/models/envelopeupdatebadrequestissue.md | 8 + docs/models/envelopeupdatedata.md | 13 + .../envelopeupdatedataglobalaccessauth.md | 9 + .../envelopeupdatedataglobalactionauth.md | 11 + docs/models/envelopeupdatedatavisibility.md | 10 + docs/models/envelopeupdatedateformat.md | 29 + .../envelopeupdatedistributionmethod.md | 9 + docs/models/envelopeupdateemailsettings.md | 14 + docs/models/envelopeupdateforbiddenerror.md | 12 + docs/models/envelopeupdateforbiddenissue.md | 8 + docs/models/envelopeupdateformvalues.md | 23 + .../envelopeupdateglobalaccessauthresponse.md | 9 + .../envelopeupdateglobalactionauthresponse.md | 11 + .../envelopeupdateinternalservererror.md | 12 + .../envelopeupdateinternalservererrorissue.md | 8 + docs/models/envelopeupdatelanguage.md | 13 + docs/models/envelopeupdatemeta.md | 22 + docs/models/envelopeupdaterequest.md | 10 + docs/models/envelopeupdateresponse.md | 30 + docs/models/envelopeupdatesigningorder.md | 9 + docs/models/envelopeupdatesource.md | 10 + docs/models/envelopeupdatestatus.md | 11 + docs/models/envelopeupdatetemplatetype.md | 9 + docs/models/envelopeupdatetype.md | 9 + .../models/envelopeupdateunauthorizederror.md | 12 + .../models/envelopeupdateunauthorizedissue.md | 8 + .../envelopeupdatevisibilityresponse.md | 10 + ...cumentdata.md => envelopeuseattachment.md} | 7 +- docs/models/envelopeusebadrequesterror.md | 12 + docs/models/envelopeusebadrequestissue.md | 8 + docs/models/envelopeusecustomdocumentdatum.md | 9 + docs/models/envelopeusedateformat.md | 29 + docs/models/envelopeusedistributionmethod.md | 9 + docs/models/envelopeuseemailsettings.md | 14 + docs/models/envelopeusefile.md | 10 + docs/models/envelopeuseforbiddenerror.md | 12 + docs/models/envelopeuseforbiddenissue.md | 8 + docs/models/envelopeuseidentifier.md | 17 + docs/models/envelopeuseinternalservererror.md | 12 + .../envelopeuseinternalservererrorissue.md | 8 + docs/models/envelopeuselanguage.md | 13 + docs/models/envelopeusepayload.md | 16 + .../models/envelopeuseprefillfieldcheckbox.md | 11 + docs/models/envelopeuseprefillfielddate.md | 10 + .../models/envelopeuseprefillfielddropdown.md | 11 + ...io.md => envelopeuseprefillfieldnumber.md} | 5 +- ...ext.md => envelopeuseprefillfieldradio.md} | 5 +- docs/models/envelopeuseprefillfieldtext.md | 12 + docs/models/envelopeuseprefillfieldunion.md | 41 + docs/models/envelopeuserecipient.md | 11 + docs/models/envelopeuserequest.md | 9 + docs/models/envelopeuseresponse.md | 10 + docs/models/envelopeusetypecheckbox.md | 8 + docs/models/envelopeusetypedate.md | 8 + docs/models/envelopeusetypedropdown.md | 8 + docs/models/envelopeusetypelink.md | 8 + docs/models/envelopeusetypenumber.md | 8 + docs/models/envelopeusetyperadio.md | 8 + docs/models/envelopeusetypetext.md | 8 + docs/models/envelopeuseunauthorizederror.md | 12 + docs/models/envelopeuseunauthorizedissue.md | 8 + ...eldcreatedocumentfielddirectioncheckbox.md | 9 + .../fieldcreatedocumentfielddirectionradio.md | 9 + ...ldcreatedocumentfielddirectionresponse1.md | 9 + ...ldcreatedocumentfielddirectionresponse2.md | 9 + .../fieldcreatedocumentfieldfieldcheckbox.md | 12 +- .../fieldcreatedocumentfieldfielddate.md | 12 +- .../fieldcreatedocumentfieldfielddropdown.md | 12 +- .../fieldcreatedocumentfieldfieldemail.md | 12 +- ...ldcreatedocumentfieldfieldfreesignature.md | 12 +- .../fieldcreatedocumentfieldfieldinitials.md | 12 +- ...tedocumentfieldfieldmetacheckboxrequest.md | 22 +- ...edocumentfieldfieldmetacheckboxresponse.md | 22 +- ...createdocumentfieldfieldmetadaterequest.md | 2 +- ...reatedocumentfieldfieldmetadateresponse.md | 2 +- ...tedocumentfieldfieldmetadropdownrequest.md | 1 + ...edocumentfieldfieldmetadropdownresponse.md | 1 + ...reatedocumentfieldfieldmetaemailrequest.md | 2 +- ...eatedocumentfieldfieldmetaemailresponse.md | 2 +- ...tedocumentfieldfieldmetainitialsrequest.md | 2 +- ...edocumentfieldfieldmetainitialsresponse.md | 2 +- ...createdocumentfieldfieldmetanamerequest.md | 2 +- ...reatedocumentfieldfieldmetanameresponse.md | 2 +- ...eatedocumentfieldfieldmetanumberrequest.md | 29 +- ...atedocumentfieldfieldmetanumberresponse.md | 29 +- ...reatedocumentfieldfieldmetaradiorequest.md | 18 +- ...eatedocumentfieldfieldmetaradioresponse.md | 18 +- ...edocumentfieldfieldmetasignaturerequest.md | 13 + ...documentfieldfieldmetasignatureresponse.md | 13 + ...createdocumentfieldfieldmetatextrequest.md | 25 +- ...reatedocumentfieldfieldmetatextresponse.md | 25 +- ...eatedocumentfieldfieldmetatypesignature.md | 8 + .../fieldcreatedocumentfieldfieldmetaunion.md | 6 + .../fieldcreatedocumentfieldfieldname.md | 12 +- .../fieldcreatedocumentfieldfieldnumber.md | 12 +- .../fieldcreatedocumentfieldfieldradio.md | 12 +- .../fieldcreatedocumentfieldfieldsignature.md | 19 +- .../fieldcreatedocumentfieldfieldtext.md | 12 +- .../fieldcreatedocumentfieldforbiddenerror.md | 12 + .../fieldcreatedocumentfieldforbiddenissue.md | 8 + .../fieldcreatedocumentfieldresponse.md | 18 +- ...ldcreatedocumentfieldsdirectioncheckbox.md | 9 + ...fieldcreatedocumentfieldsdirectionradio.md | 9 + ...dcreatedocumentfieldsdirectionresponse1.md | 9 + ...dcreatedocumentfieldsdirectionresponse2.md | 9 + .../fieldcreatedocumentfieldsfieldcheckbox.md | 12 +- .../fieldcreatedocumentfieldsfielddate.md | 12 +- .../fieldcreatedocumentfieldsfielddropdown.md | 12 +- .../fieldcreatedocumentfieldsfieldemail.md | 12 +- ...dcreatedocumentfieldsfieldfreesignature.md | 12 +- .../fieldcreatedocumentfieldsfieldinitials.md | 12 +- ...edocumentfieldsfieldmetacheckboxrequest.md | 22 +- ...documentfieldsfieldmetacheckboxresponse.md | 22 +- ...reatedocumentfieldsfieldmetadaterequest.md | 2 +- ...eatedocumentfieldsfieldmetadateresponse.md | 2 +- ...edocumentfieldsfieldmetadropdownrequest.md | 1 + ...documentfieldsfieldmetadropdownresponse.md | 1 + ...eatedocumentfieldsfieldmetaemailrequest.md | 2 +- ...atedocumentfieldsfieldmetaemailresponse.md | 2 +- ...edocumentfieldsfieldmetainitialsrequest.md | 2 +- ...documentfieldsfieldmetainitialsresponse.md | 2 +- ...reatedocumentfieldsfieldmetanamerequest.md | 2 +- ...eatedocumentfieldsfieldmetanameresponse.md | 2 +- ...atedocumentfieldsfieldmetanumberrequest.md | 29 +- ...tedocumentfieldsfieldmetanumberresponse.md | 29 +- ...eatedocumentfieldsfieldmetaradiorequest.md | 18 +- ...atedocumentfieldsfieldmetaradioresponse.md | 18 +- ...documentfieldsfieldmetasignaturerequest.md | 13 + ...ocumentfieldsfieldmetasignatureresponse.md | 13 + ...reatedocumentfieldsfieldmetatextrequest.md | 25 +- ...eatedocumentfieldsfieldmetatextresponse.md | 25 +- ...atedocumentfieldsfieldmetatypesignature.md | 8 + ...fieldcreatedocumentfieldsfieldmetaunion.md | 6 + .../fieldcreatedocumentfieldsfieldname.md | 12 +- .../fieldcreatedocumentfieldsfieldnumber.md | 12 +- .../fieldcreatedocumentfieldsfieldradio.md | 12 +- .../fieldcreatedocumentfieldsfieldresponse.md | 18 +- ...fieldcreatedocumentfieldsfieldsignature.md | 19 +- .../fieldcreatedocumentfieldsfieldtext.md | 12 +- ...fieldcreatedocumentfieldsforbiddenerror.md | 12 + ...fieldcreatedocumentfieldsforbiddenissue.md | 8 + ...eatedocumentfieldstypesignaturerequest1.md | 8 + ...eatedocumentfieldstypesignaturerequest2.md | 8 + ...ldcreatedocumentfieldsunauthorizederror.md | 12 + ...ldcreatedocumentfieldsunauthorizedissue.md | 8 + ...createdocumentfieldsverticalalignnumber.md | 10 + ...atedocumentfieldsverticalalignresponse1.md | 10 + ...atedocumentfieldsverticalalignresponse2.md | 10 + ...ldcreatedocumentfieldsverticalaligntext.md | 10 + ...eatedocumentfieldtypesignaturerequest1.md} | 2 +- ...reatedocumentfieldtypesignaturerequest2.md | 8 + ...eldcreatedocumentfieldunauthorizederror.md | 12 + ...eldcreatedocumentfieldunauthorizedissue.md | 8 + ...dcreatedocumentfieldverticalalignnumber.md | 10 + ...eatedocumentfieldverticalalignresponse1.md | 10 + ...eatedocumentfieldverticalalignresponse2.md | 10 + ...eldcreatedocumentfieldverticalaligntext.md | 10 + ...eldcreatetemplatefielddirectioncheckbox.md | 9 + .../fieldcreatetemplatefielddirectionradio.md | 9 + ...ldcreatetemplatefielddirectionresponse1.md | 9 + ...ldcreatetemplatefielddirectionresponse2.md | 9 + .../fieldcreatetemplatefieldfieldcheckbox.md | 12 +- .../fieldcreatetemplatefieldfielddate.md | 12 +- .../fieldcreatetemplatefieldfielddropdown.md | 12 +- .../fieldcreatetemplatefieldfieldemail.md | 12 +- ...ldcreatetemplatefieldfieldfreesignature.md | 12 +- .../fieldcreatetemplatefieldfieldinitials.md | 12 +- ...tetemplatefieldfieldmetacheckboxrequest.md | 22 +- ...etemplatefieldfieldmetacheckboxresponse.md | 22 +- ...createtemplatefieldfieldmetadaterequest.md | 2 +- ...reatetemplatefieldfieldmetadateresponse.md | 2 +- ...tetemplatefieldfieldmetadropdownrequest.md | 1 + ...etemplatefieldfieldmetadropdownresponse.md | 1 + ...reatetemplatefieldfieldmetaemailrequest.md | 2 +- ...eatetemplatefieldfieldmetaemailresponse.md | 2 +- ...tetemplatefieldfieldmetainitialsrequest.md | 2 +- ...etemplatefieldfieldmetainitialsresponse.md | 2 +- ...createtemplatefieldfieldmetanamerequest.md | 2 +- ...reatetemplatefieldfieldmetanameresponse.md | 2 +- ...eatetemplatefieldfieldmetanumberrequest.md | 29 +- ...atetemplatefieldfieldmetanumberresponse.md | 29 +- ...reatetemplatefieldfieldmetaradiorequest.md | 18 +- ...eatetemplatefieldfieldmetaradioresponse.md | 18 +- ...etemplatefieldfieldmetasignaturerequest.md | 13 + ...templatefieldfieldmetasignatureresponse.md | 13 + ...createtemplatefieldfieldmetatextrequest.md | 25 +- ...reatetemplatefieldfieldmetatextresponse.md | 25 +- ...eatetemplatefieldfieldmetatypesignature.md | 8 + .../fieldcreatetemplatefieldfieldmetaunion.md | 6 + .../fieldcreatetemplatefieldfieldname.md | 12 +- .../fieldcreatetemplatefieldfieldnumber.md | 12 +- .../fieldcreatetemplatefieldfieldradio.md | 12 +- .../fieldcreatetemplatefieldfieldsignature.md | 19 +- .../fieldcreatetemplatefieldfieldtext.md | 12 +- .../fieldcreatetemplatefieldforbiddenerror.md | 12 + .../fieldcreatetemplatefieldforbiddenissue.md | 8 + .../fieldcreatetemplatefieldresponse.md | 18 +- ...ldcreatetemplatefieldsdirectioncheckbox.md | 9 + ...fieldcreatetemplatefieldsdirectionradio.md | 9 + ...dcreatetemplatefieldsdirectionresponse1.md | 9 + ...dcreatetemplatefieldsdirectionresponse2.md | 9 + .../fieldcreatetemplatefieldsfieldcheckbox.md | 12 +- .../fieldcreatetemplatefieldsfielddate.md | 12 +- .../fieldcreatetemplatefieldsfielddropdown.md | 12 +- .../fieldcreatetemplatefieldsfieldemail.md | 12 +- ...dcreatetemplatefieldsfieldfreesignature.md | 12 +- .../fieldcreatetemplatefieldsfieldinitials.md | 12 +- ...etemplatefieldsfieldmetacheckboxrequest.md | 22 +- ...templatefieldsfieldmetacheckboxresponse.md | 22 +- ...reatetemplatefieldsfieldmetadaterequest.md | 2 +- ...eatetemplatefieldsfieldmetadateresponse.md | 2 +- ...etemplatefieldsfieldmetadropdownrequest.md | 1 + ...templatefieldsfieldmetadropdownresponse.md | 1 + ...eatetemplatefieldsfieldmetaemailrequest.md | 2 +- ...atetemplatefieldsfieldmetaemailresponse.md | 2 +- ...etemplatefieldsfieldmetainitialsrequest.md | 2 +- ...templatefieldsfieldmetainitialsresponse.md | 2 +- ...reatetemplatefieldsfieldmetanamerequest.md | 2 +- ...eatetemplatefieldsfieldmetanameresponse.md | 2 +- ...atetemplatefieldsfieldmetanumberrequest.md | 29 +- ...tetemplatefieldsfieldmetanumberresponse.md | 29 +- ...eatetemplatefieldsfieldmetaradiorequest.md | 18 +- ...atetemplatefieldsfieldmetaradioresponse.md | 18 +- ...templatefieldsfieldmetasignaturerequest.md | 13 + ...emplatefieldsfieldmetasignatureresponse.md | 13 + ...reatetemplatefieldsfieldmetatextrequest.md | 25 +- ...eatetemplatefieldsfieldmetatextresponse.md | 25 +- ...atetemplatefieldsfieldmetatypesignature.md | 8 + ...fieldcreatetemplatefieldsfieldmetaunion.md | 6 + .../fieldcreatetemplatefieldsfieldname.md | 12 +- .../fieldcreatetemplatefieldsfieldnumber.md | 12 +- .../fieldcreatetemplatefieldsfieldradio.md | 12 +- .../fieldcreatetemplatefieldsfieldresponse.md | 18 +- ...fieldcreatetemplatefieldsfieldsignature.md | 19 +- .../fieldcreatetemplatefieldsfieldtext.md | 12 +- ...fieldcreatetemplatefieldsforbiddenerror.md | 12 + ...fieldcreatetemplatefieldsforbiddenissue.md | 8 + ...eatetemplatefieldstypesignaturerequest1.md | 8 + ...eatetemplatefieldstypesignaturerequest2.md | 8 + ...ldcreatetemplatefieldsunauthorizederror.md | 12 + ...ldcreatetemplatefieldsunauthorizedissue.md | 8 + ...createtemplatefieldsverticalalignnumber.md | 10 + ...atetemplatefieldsverticalalignresponse1.md | 10 + ...atetemplatefieldsverticalalignresponse2.md | 10 + ...ldcreatetemplatefieldsverticalaligntext.md | 10 + ...eatetemplatefieldtypesignaturerequest1.md} | 2 +- ...reatetemplatefieldtypesignaturerequest2.md | 8 + ...eldcreatetemplatefieldunauthorizederror.md | 12 + ...eldcreatetemplatefieldunauthorizedissue.md | 8 + ...dcreatetemplatefieldverticalalignnumber.md | 10 + ...eatetemplatefieldverticalalignresponse1.md | 10 + ...eatetemplatefieldverticalalignresponse2.md | 10 + ...eldcreatetemplatefieldverticalaligntext.md | 10 + .../fielddeletedocumentfieldforbiddenerror.md | 12 + .../fielddeletedocumentfieldforbiddenissue.md | 8 + ...elddeletedocumentfieldunauthorizederror.md | 12 + ...elddeletedocumentfieldunauthorizedissue.md | 8 + .../fielddeletetemplatefieldforbiddenerror.md | 12 + .../fielddeletetemplatefieldforbiddenissue.md | 8 + ...elddeletetemplatefieldunauthorizederror.md | 12 + ...elddeletetemplatefieldunauthorizedissue.md | 8 + .../models/fieldgetdocumentfielddirection1.md | 9 + .../models/fieldgetdocumentfielddirection2.md | 9 + .../fieldgetdocumentfieldfieldmetacheckbox.md | 22 +- .../fieldgetdocumentfieldfieldmetadate.md | 2 +- .../fieldgetdocumentfieldfieldmetadropdown.md | 1 + .../fieldgetdocumentfieldfieldmetaemail.md | 2 +- .../fieldgetdocumentfieldfieldmetainitials.md | 2 +- .../fieldgetdocumentfieldfieldmetaname.md | 2 +- .../fieldgetdocumentfieldfieldmetanumber.md | 29 +- .../fieldgetdocumentfieldfieldmetaradio.md | 18 +- ...fieldgetdocumentfieldfieldmetasignature.md | 13 + .../fieldgetdocumentfieldfieldmetatext.md | 25 +- .../fieldgetdocumentfieldfieldmetaunion.md | 6 + .../fieldgetdocumentfieldforbiddenerror.md | 12 + .../fieldgetdocumentfieldforbiddenissue.md | 8 + docs/models/fieldgetdocumentfieldresponse.md | 18 +- .../fieldgetdocumentfieldtypesignature.md | 8 + .../fieldgetdocumentfieldunauthorizederror.md | 12 + .../fieldgetdocumentfieldunauthorizedissue.md | 8 + .../fieldgetdocumentfieldverticalalign1.md | 10 + .../fieldgetdocumentfieldverticalalign2.md | 10 + .../models/fieldgettemplatefielddirection1.md | 9 + .../models/fieldgettemplatefielddirection2.md | 9 + .../fieldgettemplatefieldfieldmetacheckbox.md | 22 +- .../fieldgettemplatefieldfieldmetadate.md | 2 +- .../fieldgettemplatefieldfieldmetadropdown.md | 1 + .../fieldgettemplatefieldfieldmetaemail.md | 2 +- .../fieldgettemplatefieldfieldmetainitials.md | 2 +- .../fieldgettemplatefieldfieldmetaname.md | 2 +- .../fieldgettemplatefieldfieldmetanumber.md | 29 +- .../fieldgettemplatefieldfieldmetaradio.md | 18 +- ...fieldgettemplatefieldfieldmetasignature.md | 13 + .../fieldgettemplatefieldfieldmetatext.md | 25 +- .../fieldgettemplatefieldfieldmetaunion.md | 6 + .../fieldgettemplatefieldforbiddenerror.md | 12 + .../fieldgettemplatefieldforbiddenissue.md | 8 + docs/models/fieldgettemplatefieldresponse.md | 18 +- .../fieldgettemplatefieldtypesignature.md | 8 + .../fieldgettemplatefieldunauthorizederror.md | 12 + .../fieldgettemplatefieldunauthorizedissue.md | 8 + .../fieldgettemplatefieldverticalalign1.md | 10 + .../fieldgettemplatefieldverticalalign2.md | 10 + docs/models/fieldmetadocumentcheckbox.md | 22 +- docs/models/fieldmetadocumentdate.md | 2 +- docs/models/fieldmetadocumentdropdown.md | 1 + docs/models/fieldmetadocumentemail.md | 2 +- docs/models/fieldmetadocumentinitials.md | 2 +- docs/models/fieldmetadocumentname.md | 2 +- docs/models/fieldmetadocumentnumber.md | 29 +- docs/models/fieldmetadocumentradio.md | 18 +- docs/models/fieldmetadocumentsignature.md | 13 + docs/models/fieldmetadocumenttext.md | 25 +- ...eldupdatedocumentfielddirectioncheckbox.md | 9 + .../fieldupdatedocumentfielddirectionradio.md | 9 + ...ldupdatedocumentfielddirectionresponse1.md | 9 + ...ldupdatedocumentfielddirectionresponse2.md | 9 + .../fieldupdatedocumentfieldfieldcheckbox.md | 12 +- .../fieldupdatedocumentfieldfielddate.md | 12 +- .../fieldupdatedocumentfieldfielddropdown.md | 12 +- .../fieldupdatedocumentfieldfieldemail.md | 12 +- ...ldupdatedocumentfieldfieldfreesignature.md | 12 +- .../fieldupdatedocumentfieldfieldinitials.md | 12 +- ...tedocumentfieldfieldmetacheckboxrequest.md | 22 +- ...edocumentfieldfieldmetacheckboxresponse.md | 22 +- ...updatedocumentfieldfieldmetadaterequest.md | 2 +- ...pdatedocumentfieldfieldmetadateresponse.md | 2 +- ...tedocumentfieldfieldmetadropdownrequest.md | 1 + ...edocumentfieldfieldmetadropdownresponse.md | 1 + ...pdatedocumentfieldfieldmetaemailrequest.md | 2 +- ...datedocumentfieldfieldmetaemailresponse.md | 2 +- ...tedocumentfieldfieldmetainitialsrequest.md | 2 +- ...edocumentfieldfieldmetainitialsresponse.md | 2 +- ...updatedocumentfieldfieldmetanamerequest.md | 2 +- ...pdatedocumentfieldfieldmetanameresponse.md | 2 +- ...datedocumentfieldfieldmetanumberrequest.md | 29 +- ...atedocumentfieldfieldmetanumberresponse.md | 29 +- ...pdatedocumentfieldfieldmetaradiorequest.md | 18 +- ...datedocumentfieldfieldmetaradioresponse.md | 18 +- ...edocumentfieldfieldmetasignaturerequest.md | 13 + ...documentfieldfieldmetasignatureresponse.md | 13 + ...updatedocumentfieldfieldmetatextrequest.md | 25 +- ...pdatedocumentfieldfieldmetatextresponse.md | 25 +- ...datedocumentfieldfieldmetatypesignature.md | 8 + .../fieldupdatedocumentfieldfieldmetaunion.md | 6 + .../fieldupdatedocumentfieldfieldname.md | 12 +- .../fieldupdatedocumentfieldfieldnumber.md | 12 +- .../fieldupdatedocumentfieldfieldradio.md | 12 +- .../fieldupdatedocumentfieldfieldsignature.md | 19 +- .../fieldupdatedocumentfieldfieldtext.md | 12 +- .../fieldupdatedocumentfieldforbiddenerror.md | 12 + .../fieldupdatedocumentfieldforbiddenissue.md | 8 + .../fieldupdatedocumentfieldresponse.md | 18 +- ...ldupdatedocumentfieldsdirectioncheckbox.md | 9 + ...fieldupdatedocumentfieldsdirectionradio.md | 9 + ...dupdatedocumentfieldsdirectionresponse1.md | 9 + ...dupdatedocumentfieldsdirectionresponse2.md | 9 + .../fieldupdatedocumentfieldsfieldcheckbox.md | 12 +- .../fieldupdatedocumentfieldsfielddate.md | 12 +- .../fieldupdatedocumentfieldsfielddropdown.md | 12 +- .../fieldupdatedocumentfieldsfieldemail.md | 12 +- ...dupdatedocumentfieldsfieldfreesignature.md | 12 +- .../fieldupdatedocumentfieldsfieldinitials.md | 12 +- ...edocumentfieldsfieldmetacheckboxrequest.md | 22 +- ...documentfieldsfieldmetacheckboxresponse.md | 22 +- ...pdatedocumentfieldsfieldmetadaterequest.md | 2 +- ...datedocumentfieldsfieldmetadateresponse.md | 2 +- ...edocumentfieldsfieldmetadropdownrequest.md | 1 + ...documentfieldsfieldmetadropdownresponse.md | 1 + ...datedocumentfieldsfieldmetaemailrequest.md | 2 +- ...atedocumentfieldsfieldmetaemailresponse.md | 2 +- ...edocumentfieldsfieldmetainitialsrequest.md | 2 +- ...documentfieldsfieldmetainitialsresponse.md | 2 +- ...pdatedocumentfieldsfieldmetanamerequest.md | 2 +- ...datedocumentfieldsfieldmetanameresponse.md | 2 +- ...atedocumentfieldsfieldmetanumberrequest.md | 29 +- ...tedocumentfieldsfieldmetanumberresponse.md | 29 +- ...datedocumentfieldsfieldmetaradiorequest.md | 18 +- ...atedocumentfieldsfieldmetaradioresponse.md | 18 +- ...documentfieldsfieldmetasignaturerequest.md | 13 + ...ocumentfieldsfieldmetasignatureresponse.md | 13 + ...pdatedocumentfieldsfieldmetatextrequest.md | 25 +- ...datedocumentfieldsfieldmetatextresponse.md | 25 +- ...atedocumentfieldsfieldmetatypesignature.md | 8 + ...fieldupdatedocumentfieldsfieldmetaunion.md | 6 + .../fieldupdatedocumentfieldsfieldname.md | 12 +- .../fieldupdatedocumentfieldsfieldnumber.md | 12 +- .../fieldupdatedocumentfieldsfieldradio.md | 12 +- .../fieldupdatedocumentfieldsfieldresponse.md | 18 +- ...fieldupdatedocumentfieldsfieldsignature.md | 19 +- .../fieldupdatedocumentfieldsfieldtext.md | 12 +- ...fieldupdatedocumentfieldsforbiddenerror.md | 12 + ...fieldupdatedocumentfieldsforbiddenissue.md | 8 + .../fieldupdatedocumentfieldstypesignature.md | 8 - ...datedocumentfieldstypesignaturerequest1.md | 8 + ...datedocumentfieldstypesignaturerequest2.md | 8 + ...ldupdatedocumentfieldsunauthorizederror.md | 12 + ...ldupdatedocumentfieldsunauthorizedissue.md | 8 + ...updatedocumentfieldsverticalalignnumber.md | 10 + ...atedocumentfieldsverticalalignresponse1.md | 10 + ...atedocumentfieldsverticalalignresponse2.md | 10 + ...ldupdatedocumentfieldsverticalaligntext.md | 10 + ...pdatedocumentfieldtypesignaturerequest1.md | 8 + ...pdatedocumentfieldtypesignaturerequest2.md | 8 + ...eldupdatedocumentfieldunauthorizederror.md | 12 + ...eldupdatedocumentfieldunauthorizedissue.md | 8 + ...dupdatedocumentfieldverticalalignnumber.md | 10 + ...datedocumentfieldverticalalignresponse1.md | 10 + ...datedocumentfieldverticalalignresponse2.md | 10 + ...eldupdatedocumentfieldverticalaligntext.md | 10 + ...eldupdatetemplatefielddirectioncheckbox.md | 9 + .../fieldupdatetemplatefielddirectionradio.md | 9 + ...ldupdatetemplatefielddirectionresponse1.md | 9 + ...ldupdatetemplatefielddirectionresponse2.md | 9 + .../fieldupdatetemplatefieldfieldcheckbox.md | 12 +- .../fieldupdatetemplatefieldfielddate.md | 12 +- .../fieldupdatetemplatefieldfielddropdown.md | 12 +- .../fieldupdatetemplatefieldfieldemail.md | 12 +- ...ldupdatetemplatefieldfieldfreesignature.md | 12 +- .../fieldupdatetemplatefieldfieldinitials.md | 12 +- ...tetemplatefieldfieldmetacheckboxrequest.md | 22 +- ...etemplatefieldfieldmetacheckboxresponse.md | 22 +- ...updatetemplatefieldfieldmetadaterequest.md | 2 +- ...pdatetemplatefieldfieldmetadateresponse.md | 2 +- ...tetemplatefieldfieldmetadropdownrequest.md | 1 + ...etemplatefieldfieldmetadropdownresponse.md | 1 + ...pdatetemplatefieldfieldmetaemailrequest.md | 2 +- ...datetemplatefieldfieldmetaemailresponse.md | 2 +- ...tetemplatefieldfieldmetainitialsrequest.md | 2 +- ...etemplatefieldfieldmetainitialsresponse.md | 2 +- ...updatetemplatefieldfieldmetanamerequest.md | 2 +- ...pdatetemplatefieldfieldmetanameresponse.md | 2 +- ...datetemplatefieldfieldmetanumberrequest.md | 29 +- ...atetemplatefieldfieldmetanumberresponse.md | 29 +- ...pdatetemplatefieldfieldmetaradiorequest.md | 18 +- ...datetemplatefieldfieldmetaradioresponse.md | 18 +- ...etemplatefieldfieldmetasignaturerequest.md | 13 + ...templatefieldfieldmetasignatureresponse.md | 13 + ...updatetemplatefieldfieldmetatextrequest.md | 25 +- ...pdatetemplatefieldfieldmetatextresponse.md | 25 +- ...datetemplatefieldfieldmetatypesignature.md | 8 + .../fieldupdatetemplatefieldfieldmetaunion.md | 6 + .../fieldupdatetemplatefieldfieldname.md | 12 +- .../fieldupdatetemplatefieldfieldnumber.md | 12 +- .../fieldupdatetemplatefieldfieldradio.md | 12 +- .../fieldupdatetemplatefieldfieldsignature.md | 19 +- .../fieldupdatetemplatefieldfieldtext.md | 12 +- .../fieldupdatetemplatefieldforbiddenerror.md | 12 + .../fieldupdatetemplatefieldforbiddenissue.md | 8 + .../fieldupdatetemplatefieldresponse.md | 18 +- ...ldupdatetemplatefieldsdirectioncheckbox.md | 9 + ...fieldupdatetemplatefieldsdirectionradio.md | 9 + ...dupdatetemplatefieldsdirectionresponse1.md | 9 + ...dupdatetemplatefieldsdirectionresponse2.md | 9 + .../fieldupdatetemplatefieldsfieldcheckbox.md | 12 +- .../fieldupdatetemplatefieldsfielddate.md | 12 +- .../fieldupdatetemplatefieldsfielddropdown.md | 12 +- .../fieldupdatetemplatefieldsfieldemail.md | 12 +- ...dupdatetemplatefieldsfieldfreesignature.md | 12 +- .../fieldupdatetemplatefieldsfieldinitials.md | 12 +- ...etemplatefieldsfieldmetacheckboxrequest.md | 22 +- ...templatefieldsfieldmetacheckboxresponse.md | 22 +- ...pdatetemplatefieldsfieldmetadaterequest.md | 2 +- ...datetemplatefieldsfieldmetadateresponse.md | 2 +- ...etemplatefieldsfieldmetadropdownrequest.md | 1 + ...templatefieldsfieldmetadropdownresponse.md | 1 + ...datetemplatefieldsfieldmetaemailrequest.md | 2 +- ...atetemplatefieldsfieldmetaemailresponse.md | 2 +- ...etemplatefieldsfieldmetainitialsrequest.md | 2 +- ...templatefieldsfieldmetainitialsresponse.md | 2 +- ...pdatetemplatefieldsfieldmetanamerequest.md | 2 +- ...datetemplatefieldsfieldmetanameresponse.md | 2 +- ...atetemplatefieldsfieldmetanumberrequest.md | 29 +- ...tetemplatefieldsfieldmetanumberresponse.md | 29 +- ...datetemplatefieldsfieldmetaradiorequest.md | 18 +- ...atetemplatefieldsfieldmetaradioresponse.md | 18 +- ...templatefieldsfieldmetasignaturerequest.md | 13 + ...emplatefieldsfieldmetasignatureresponse.md | 13 + ...pdatetemplatefieldsfieldmetatextrequest.md | 25 +- ...datetemplatefieldsfieldmetatextresponse.md | 25 +- ...atetemplatefieldsfieldmetatypesignature.md | 8 + ...fieldupdatetemplatefieldsfieldmetaunion.md | 6 + .../fieldupdatetemplatefieldsfieldname.md | 12 +- .../fieldupdatetemplatefieldsfieldnumber.md | 12 +- .../fieldupdatetemplatefieldsfieldradio.md | 12 +- .../fieldupdatetemplatefieldsfieldresponse.md | 18 +- ...fieldupdatetemplatefieldsfieldsignature.md | 19 +- .../fieldupdatetemplatefieldsfieldtext.md | 12 +- ...fieldupdatetemplatefieldsforbiddenerror.md | 12 + ...fieldupdatetemplatefieldsforbiddenissue.md | 8 + .../fieldupdatetemplatefieldstypesignature.md | 8 - ...datetemplatefieldstypesignaturerequest1.md | 8 + ...datetemplatefieldstypesignaturerequest2.md | 8 + ...ldupdatetemplatefieldsunauthorizederror.md | 12 + ...ldupdatetemplatefieldsunauthorizedissue.md | 8 + ...updatetemplatefieldsverticalalignnumber.md | 10 + ...atetemplatefieldsverticalalignresponse1.md | 10 + ...atetemplatefieldsverticalalignresponse2.md | 10 + ...ldupdatetemplatefieldsverticalaligntext.md | 10 + ...pdatetemplatefieldtypesignaturerequest1.md | 8 + ...pdatetemplatefieldtypesignaturerequest2.md | 8 + ...eldupdatetemplatefieldunauthorizederror.md | 12 + ...eldupdatetemplatefieldunauthorizedissue.md | 8 + ...dupdatetemplatefieldverticalalignnumber.md | 10 + ...datetemplatefieldverticalalignresponse1.md | 10 + ...datetemplatefieldverticalalignresponse2.md | 10 + ...eldupdatetemplatefieldverticalaligntext.md | 10 + .../foldercreatefolderbadrequesterror.md | 12 + .../foldercreatefolderbadrequestissue.md | 8 + .../foldercreatefolderforbiddenerror.md | 12 + .../foldercreatefolderforbiddenissue.md | 8 + .../foldercreatefolderinternalservererror.md | 12 + ...dercreatefolderinternalservererrorissue.md | 8 + docs/models/foldercreatefolderrequest.md | 10 + docs/models/foldercreatefolderresponse.md | 19 + docs/models/foldercreatefoldertyperequest.md | 9 + docs/models/foldercreatefoldertyperesponse.md | 9 + .../foldercreatefolderunauthorizederror.md | 12 + .../foldercreatefolderunauthorizedissue.md | 8 + docs/models/foldercreatefoldervisibility.md | 10 + .../folderdeletefolderbadrequesterror.md | 12 + .../folderdeletefolderbadrequestissue.md | 8 + .../folderdeletefolderforbiddenerror.md | 12 + .../folderdeletefolderforbiddenissue.md | 8 + .../folderdeletefolderinternalservererror.md | 12 + ...derdeletefolderinternalservererrorissue.md | 8 + docs/models/folderdeletefolderrequest.md | 8 + docs/models/folderdeletefolderresponse.md | 10 + .../folderdeletefolderunauthorizederror.md | 12 + .../folderdeletefolderunauthorizedissue.md | 8 + .../folderfindfoldersbadrequesterror.md | 12 + .../folderfindfoldersbadrequestissue.md | 8 + docs/models/folderfindfoldersdata.md | 17 + docs/models/folderfindfoldersdatatype.md | 9 + .../models/folderfindfoldersforbiddenerror.md | 12 + .../models/folderfindfoldersforbiddenissue.md | 8 + .../folderfindfoldersinternalservererror.md | 12 + ...lderfindfoldersinternalservererrorissue.md | 8 + docs/models/folderfindfoldersnotfounderror.md | 12 + docs/models/folderfindfoldersnotfoundissue.md | 8 + .../models/folderfindfoldersqueryparamtype.md | 9 + docs/models/folderfindfoldersrequest.md | 12 + docs/models/folderfindfoldersresponse.md | 14 + .../folderfindfoldersunauthorizederror.md | 12 + .../folderfindfoldersunauthorizedissue.md | 8 + docs/models/folderfindfoldersvisibility.md | 10 + .../folderupdatefolderbadrequesterror.md | 12 + .../folderupdatefolderbadrequestissue.md | 8 + docs/models/folderupdatefolderdata.md | 11 + .../folderupdatefolderdatavisibility.md | 10 + .../folderupdatefolderforbiddenerror.md | 12 + .../folderupdatefolderforbiddenissue.md | 8 + .../folderupdatefolderinternalservererror.md | 12 + ...derupdatefolderinternalservererrorissue.md | 8 + docs/models/folderupdatefolderrequest.md | 9 + docs/models/folderupdatefolderresponse.md | 19 + docs/models/folderupdatefoldertype.md | 9 + .../folderupdatefolderunauthorizederror.md | 12 + .../folderupdatefolderunauthorizedissue.md | 8 + .../folderupdatefoldervisibilityresponse.md | 10 + docs/models/override.md | 20 + docs/models/prefillfield.md | 41 - docs/models/prefillfielddate.md | 10 - docs/models/prefillfieldnumber.md | 12 - ...reatedocumentrecipientaccessauthrequest.md | 9 +- ...eatedocumentrecipientaccessauthresponse.md | 9 +- ...reatedocumentrecipientactionauthrequest.md | 2 - ...eatedocumentrecipientactionauthresponse.md | 2 - ...ntcreatedocumentrecipientforbiddenerror.md | 12 + ...ntcreatedocumentrecipientforbiddenissue.md | 8 + ...ecipientcreatedocumentrecipientresponse.md | 9 +- ...eatedocumentrecipientsaccessauthrequest.md | 9 +- ...atedocumentrecipientsaccessauthresponse.md | 9 +- ...eatedocumentrecipientsactionauthrequest.md | 2 - ...atedocumentrecipientsactionauthresponse.md | 2 - ...tcreatedocumentrecipientsforbiddenerror.md | 12 + ...tcreatedocumentrecipientsforbiddenissue.md | 8 + ...eatedocumentrecipientsrecipientresponse.md | 9 +- ...atedocumentrecipientsunauthorizederror.md} | 9 +- ...eatedocumentrecipientsunauthorizedissue.md | 8 + ...eatedocumentrecipientunauthorizederror.md} | 6 +- ...eatedocumentrecipientunauthorizedissue.md} | 2 +- ...reatetemplaterecipientaccessauthrequest.md | 9 +- ...eatetemplaterecipientaccessauthresponse.md | 9 +- ...reatetemplaterecipientactionauthrequest.md | 2 - ...eatetemplaterecipientactionauthresponse.md | 2 - ...ntcreatetemplaterecipientforbiddenerror.md | 12 + ...ntcreatetemplaterecipientforbiddenissue.md | 8 + ...ecipientcreatetemplaterecipientresponse.md | 9 +- ...eatetemplaterecipientsaccessauthrequest.md | 9 +- ...atetemplaterecipientsaccessauthresponse.md | 9 +- ...eatetemplaterecipientsactionauthrequest.md | 2 - ...atetemplaterecipientsactionauthresponse.md | 2 - ...tcreatetemplaterecipientsforbiddenerror.md | 12 + ...tcreatetemplaterecipientsforbiddenissue.md | 8 + ...eatetemplaterecipientsrecipientresponse.md | 9 +- ...atetemplaterecipientsunauthorizederror.md} | 14 +- ...eatetemplaterecipientsunauthorizedissue.md | 8 + ...eatetemplaterecipientunauthorizederror.md} | 6 +- ...reatetemplaterecipientunauthorizedissue.md | 8 + ...ntdeletedocumentrecipientforbiddenerror.md | 12 + ...ntdeletedocumentrecipientforbiddenissue.md | 8 + ...eletedocumentrecipientunauthorizederror.md | 12 + ...eletedocumentrecipientunauthorizedissue.md | 8 + ...ntdeletetemplaterecipientforbiddenerror.md | 12 + ...ntdeletetemplaterecipientforbiddenissue.md | 8 + ...eletetemplaterecipientunauthorizederror.md | 12 + ...eletetemplaterecipientunauthorizedissue.md | 8 + ...recipientgetdocumentrecipientaccessauth.md | 9 +- ...recipientgetdocumentrecipientactionauth.md | 2 - ...recipientgetdocumentrecipientdirection1.md | 9 + ...recipientgetdocumentrecipientdirection2.md | 9 + .../recipientgetdocumentrecipientfield.md | 18 +- ...ntgetdocumentrecipientfieldmetacheckbox.md | 22 +- ...ipientgetdocumentrecipientfieldmetadate.md | 2 +- ...ntgetdocumentrecipientfieldmetadropdown.md | 1 + ...pientgetdocumentrecipientfieldmetaemail.md | 2 +- ...ntgetdocumentrecipientfieldmetainitials.md | 2 +- ...ipientgetdocumentrecipientfieldmetaname.md | 2 +- ...ientgetdocumentrecipientfieldmetanumber.md | 29 +- ...pientgetdocumentrecipientfieldmetaradio.md | 18 +- ...tgetdocumentrecipientfieldmetasignature.md | 13 + ...ipientgetdocumentrecipientfieldmetatext.md | 25 +- ...pientgetdocumentrecipientfieldmetaunion.md | 6 + ...pientgetdocumentrecipientforbiddenerror.md | 12 + ...pientgetdocumentrecipientforbiddenissue.md | 8 + .../recipientgetdocumentrecipientresponse.md | 39 +- ...ipientgetdocumentrecipienttypesignature.md | 8 + ...ntgetdocumentrecipientunauthorizederror.md | 12 + ...ntgetdocumentrecipientunauthorizedissue.md | 8 + ...pientgetdocumentrecipientverticalalign1.md | 10 + ...pientgetdocumentrecipientverticalalign2.md | 10 + ...recipientgettemplaterecipientaccessauth.md | 9 +- ...recipientgettemplaterecipientactionauth.md | 2 - ...recipientgettemplaterecipientdirection1.md | 9 + ...recipientgettemplaterecipientdirection2.md | 9 + .../recipientgettemplaterecipientfield.md | 18 +- ...ntgettemplaterecipientfieldmetacheckbox.md | 22 +- ...ipientgettemplaterecipientfieldmetadate.md | 2 +- ...ntgettemplaterecipientfieldmetadropdown.md | 1 + ...pientgettemplaterecipientfieldmetaemail.md | 2 +- ...ntgettemplaterecipientfieldmetainitials.md | 2 +- ...ipientgettemplaterecipientfieldmetaname.md | 2 +- ...ientgettemplaterecipientfieldmetanumber.md | 29 +- ...pientgettemplaterecipientfieldmetaradio.md | 18 +- ...tgettemplaterecipientfieldmetasignature.md | 13 + ...ipientgettemplaterecipientfieldmetatext.md | 25 +- ...pientgettemplaterecipientfieldmetaunion.md | 6 + ...pientgettemplaterecipientforbiddenerror.md | 12 + ...pientgettemplaterecipientforbiddenissue.md | 8 + .../recipientgettemplaterecipientresponse.md | 39 +- ...ipientgettemplaterecipienttypesignature.md | 8 + ...ntgettemplaterecipientunauthorizederror.md | 12 + ...ntgettemplaterecipientunauthorizedissue.md | 8 + ...pientgettemplaterecipientverticalalign1.md | 10 + ...pientgettemplaterecipientverticalalign2.md | 10 + ...pdatedocumentrecipientaccessauthrequest.md | 9 +- ...datedocumentrecipientaccessauthresponse.md | 9 +- ...pdatedocumentrecipientactionauthrequest.md | 2 - ...datedocumentrecipientactionauthresponse.md | 2 - ...ipientupdatedocumentrecipientdirection1.md | 9 + ...ipientupdatedocumentrecipientdirection2.md | 9 + .../recipientupdatedocumentrecipientfield.md | 18 +- ...pdatedocumentrecipientfieldmetacheckbox.md | 22 +- ...entupdatedocumentrecipientfieldmetadate.md | 2 +- ...pdatedocumentrecipientfieldmetadropdown.md | 1 + ...ntupdatedocumentrecipientfieldmetaemail.md | 2 +- ...pdatedocumentrecipientfieldmetainitials.md | 2 +- ...entupdatedocumentrecipientfieldmetaname.md | 2 +- ...tupdatedocumentrecipientfieldmetanumber.md | 29 +- ...ntupdatedocumentrecipientfieldmetaradio.md | 18 +- ...datedocumentrecipientfieldmetasignature.md | 13 + ...entupdatedocumentrecipientfieldmetatext.md | 25 +- ...ntupdatedocumentrecipientfieldmetaunion.md | 6 + ...ntupdatedocumentrecipientforbiddenerror.md | 12 + ...ntupdatedocumentrecipientforbiddenissue.md | 8 + ...cipientupdatedocumentrecipientrecipient.md | 2 +- ...ecipientupdatedocumentrecipientresponse.md | 9 +- ...datedocumentrecipientsaccessauthrequest.md | 9 +- ...atedocumentrecipientsaccessauthresponse.md | 9 +- ...datedocumentrecipientsactionauthrequest.md | 2 - ...atedocumentrecipientsactionauthresponse.md | 2 - ...pientupdatedocumentrecipientsdirection1.md | 9 + ...pientupdatedocumentrecipientsdirection2.md | 9 + .../recipientupdatedocumentrecipientsfield.md | 18 +- ...datedocumentrecipientsfieldmetacheckbox.md | 22 +- ...ntupdatedocumentrecipientsfieldmetadate.md | 2 +- ...datedocumentrecipientsfieldmetadropdown.md | 1 + ...tupdatedocumentrecipientsfieldmetaemail.md | 2 +- ...datedocumentrecipientsfieldmetainitials.md | 2 +- ...ntupdatedocumentrecipientsfieldmetaname.md | 2 +- ...updatedocumentrecipientsfieldmetanumber.md | 29 +- ...tupdatedocumentrecipientsfieldmetaradio.md | 18 +- ...atedocumentrecipientsfieldmetasignature.md | 13 + ...ntupdatedocumentrecipientsfieldmetatext.md | 25 +- ...tupdatedocumentrecipientsfieldmetaunion.md | 6 + ...tupdatedocumentrecipientsforbiddenerror.md | 12 + ...tupdatedocumentrecipientsforbiddenissue.md | 8 + ...pdatedocumentrecipientsrecipientrequest.md | 2 +- ...datedocumentrecipientsrecipientresponse.md | 9 +- ...ntupdatedocumentrecipientstypesignature.md | 8 + ...datedocumentrecipientsunauthorizederror.md | 12 + ...datedocumentrecipientsunauthorizedissue.md | 8 + ...tupdatedocumentrecipientsverticalalign1.md | 10 + ...tupdatedocumentrecipientsverticalalign2.md | 10 + ...entupdatedocumentrecipienttypesignature.md | 8 + ...pdatedocumentrecipientunauthorizederror.md | 12 + ...pdatedocumentrecipientunauthorizedissue.md | 8 + ...ntupdatedocumentrecipientverticalalign1.md | 10 + ...ntupdatedocumentrecipientverticalalign2.md | 10 + ...pdatetemplaterecipientaccessauthrequest.md | 9 +- ...datetemplaterecipientaccessauthresponse.md | 9 +- ...pdatetemplaterecipientactionauthrequest.md | 2 - ...datetemplaterecipientactionauthresponse.md | 2 - ...ipientupdatetemplaterecipientdirection1.md | 9 + ...ipientupdatetemplaterecipientdirection2.md | 9 + .../recipientupdatetemplaterecipientfield.md | 18 +- ...pdatetemplaterecipientfieldmetacheckbox.md | 22 +- ...entupdatetemplaterecipientfieldmetadate.md | 2 +- ...pdatetemplaterecipientfieldmetadropdown.md | 1 + ...ntupdatetemplaterecipientfieldmetaemail.md | 2 +- ...pdatetemplaterecipientfieldmetainitials.md | 2 +- ...entupdatetemplaterecipientfieldmetaname.md | 2 +- ...tupdatetemplaterecipientfieldmetanumber.md | 29 +- ...ntupdatetemplaterecipientfieldmetaradio.md | 18 +- ...datetemplaterecipientfieldmetasignature.md | 13 + ...entupdatetemplaterecipientfieldmetatext.md | 25 +- ...ntupdatetemplaterecipientfieldmetaunion.md | 6 + ...ntupdatetemplaterecipientforbiddenerror.md | 12 + ...ntupdatetemplaterecipientforbiddenissue.md | 8 + ...cipientupdatetemplaterecipientrecipient.md | 2 +- ...ecipientupdatetemplaterecipientresponse.md | 9 +- ...datetemplaterecipientsaccessauthrequest.md | 9 +- ...atetemplaterecipientsaccessauthresponse.md | 9 +- ...datetemplaterecipientsactionauthrequest.md | 2 - ...atetemplaterecipientsactionauthresponse.md | 2 - ...pientupdatetemplaterecipientsdirection1.md | 9 + ...pientupdatetemplaterecipientsdirection2.md | 9 + .../recipientupdatetemplaterecipientsfield.md | 18 +- ...datetemplaterecipientsfieldmetacheckbox.md | 22 +- ...ntupdatetemplaterecipientsfieldmetadate.md | 2 +- ...datetemplaterecipientsfieldmetadropdown.md | 1 + ...tupdatetemplaterecipientsfieldmetaemail.md | 2 +- ...datetemplaterecipientsfieldmetainitials.md | 2 +- ...ntupdatetemplaterecipientsfieldmetaname.md | 2 +- ...updatetemplaterecipientsfieldmetanumber.md | 29 +- ...tupdatetemplaterecipientsfieldmetaradio.md | 18 +- ...atetemplaterecipientsfieldmetasignature.md | 13 + ...ntupdatetemplaterecipientsfieldmetatext.md | 25 +- ...tupdatetemplaterecipientsfieldmetaunion.md | 6 + ...tupdatetemplaterecipientsforbiddenerror.md | 12 + ...tupdatetemplaterecipientsforbiddenissue.md | 8 + ...pdatetemplaterecipientsrecipientrequest.md | 2 +- ...datetemplaterecipientsrecipientresponse.md | 9 +- ...ntupdatetemplaterecipientstypesignature.md | 8 + ...datetemplaterecipientsunauthorizederror.md | 12 + ...datetemplaterecipientsunauthorizedissue.md | 8 + ...tupdatetemplaterecipientsverticalalign1.md | 10 + ...tupdatetemplaterecipientsverticalalign2.md | 10 + ...entupdatetemplaterecipienttypesignature.md | 8 + ...pdatetemplaterecipientunauthorizederror.md | 12 + ...pdatetemplaterecipientunauthorizedissue.md | 8 + ...ntupdatetemplaterecipientverticalalign1.md | 10 + ...ntupdatetemplaterecipientverticalalign2.md | 10 + ...atecreatedocumentfromtemplateaccessauth.md | 9 +- ...atecreatedocumentfromtemplateactionauth.md | 2 - ...documentfromtemplatecustomdocumentdatum.md | 9 + ...atecreatedocumentfromtemplatedirection1.md | 9 + ...atecreatedocumentfromtemplatedirection2.md | 9 + ...ecreatedocumentfromtemplatedocumentdata.md | 3 +- ...ecreatedocumentfromtemplatedocumentmeta.md | 8 +- ...createdocumentfromtemplateemailsettings.md | 18 +- ...ecreatedocumentfromtemplateenvelopeitem.md | 9 + ...templatecreatedocumentfromtemplatefield.md | 18 +- ...tedocumentfromtemplatefieldmetacheckbox.md | 4 +- ...createdocumentfromtemplatefieldmetadate.md | 2 +- ...tedocumentfromtemplatefieldmetadropdown.md | 1 + ...reatedocumentfromtemplatefieldmetaemail.md | 2 +- ...tedocumentfromtemplatefieldmetainitials.md | 2 +- ...createdocumentfromtemplatefieldmetaname.md | 2 +- ...eatedocumentfromtemplatefieldmetanumber.md | 29 +- ...reatedocumentfromtemplatefieldmetaradio.md | 4 +- ...edocumentfromtemplatefieldmetasignature.md | 13 + ...createdocumentfromtemplatefieldmetatext.md | 25 +- ...reatedocumentfromtemplatefieldmetaunion.md | 6 + ...reatedocumentfromtemplateforbiddenerror.md | 12 + ...reatedocumentfromtemplateforbiddenissue.md | 8 + ...atedocumentfromtemplateglobalaccessauth.md | 9 +- ...atedocumentfromtemplateglobalactionauth.md | 2 - ...ocumentfromtemplateprefillfieldcheckbox.md | 11 + ...atedocumentfromtemplateprefillfielddate.md | 10 + ...ocumentfromtemplateprefillfielddropdown.md | 11 + ...edocumentfromtemplateprefillfieldnumber.md | 12 + ...tedocumentfromtemplateprefillfieldradio.md | 11 + ...atedocumentfromtemplateprefillfieldtext.md | 12 + ...entfromtemplateprefillfieldtypecheckbox.md | 8 + ...ocumentfromtemplateprefillfieldtypedate.md | 8 + ...entfromtemplateprefillfieldtypedropdown.md | 8 + ...umentfromtemplateprefillfieldtypenumber.md | 8 + ...cumentfromtemplateprefillfieldtyperadio.md | 8 + ...ocumentfromtemplateprefillfieldtypetext.md | 8 + ...tedocumentfromtemplateprefillfieldunion.md | 41 + ...atedocumentfromtemplaterecipientrequest.md | 10 +- ...tedocumentfromtemplaterecipientresponse.md | 9 +- ...mplatecreatedocumentfromtemplaterequest.md | 16 +- ...platecreatedocumentfromtemplateresponse.md | 13 +- ...createdocumentfromtemplatetypesignature.md | 8 + ...tedocumentfromtemplateunauthorizederror.md | 12 + ...tedocumentfromtemplateunauthorizedissue.md | 8 + ...reatedocumentfromtemplateverticalalign1.md | 10 + ...reatedocumentfromtemplateverticalalign2.md | 10 + .../templatecreatetemplateattachment.md | 10 + .../templatecreatetemplatebadrequesterror.md | 12 + .../templatecreatetemplatebadrequestissue.md | 8 + .../templatecreatetemplatedateformat.md | 29 + ...ecreatetemplatedirectlinkforbiddenerror.md | 12 + ...ecreatetemplatedirectlinkforbiddenissue.md | 8 + ...templatecreatetemplatedirectlinkrequest.md | 8 +- ...emplatecreatetemplatedirectlinkresponse.md | 5 +- ...eatetemplatedirectlinkunauthorizederror.md | 12 + ...eatetemplatedirectlinkunauthorizedissue.md | 8 + ...emplatecreatetemplatedistributionmethod.md | 9 + .../templatecreatetemplateemailsettings.md | 14 + docs/models/templatecreatetemplatefile.md | 10 + .../templatecreatetemplateforbiddenerror.md | 12 + .../templatecreatetemplateforbiddenissue.md | 8 + .../templatecreatetemplateglobalaccessauth.md | 9 + .../templatecreatetemplateglobalactionauth.md | 11 + ...mplatecreatetemplateinternalservererror.md | 12 + ...ecreatetemplateinternalservererrorissue.md | 8 + docs/models/templatecreatetemplatelanguage.md | 13 + ...tmeta.md => templatecreatetemplatemeta.md} | 30 +- docs/models/templatecreatetemplatepayload.md | 18 + docs/models/templatecreatetemplaterequest.md | 9 + docs/models/templatecreatetemplateresponse.md | 11 + .../templatecreatetemplatesigningorder.md | 9 + ...mplatecreatetemplatetemporaryaccessauth.md | 9 + ...mplatecreatetemplatetemporaryactionauth.md | 12 + ...mplatecreatetemplatetemporaryattachment.md | 10 + ...platecreatetemplatetemporaryauthoptions.md | 9 + ...ecreatetemplatetemporarybadrequesterror.md | 12 + ...ecreatetemplatetemporarybadrequestissue.md | 8 + ...mplatecreatetemplatetemporarydateformat.md | 29 + ...mplatecreatetemplatetemporarydirection1.md | 9 + ...mplatecreatetemplatetemporarydirection2.md | 9 + ...mplatecreatetemplatetemporarydirectlink.md | 14 + ...latecreatetemplatetemporaryenvelopeitem.md | 9 + .../templatecreatetemplatetemporaryfield.md | 23 + ...reatetemplatetemporaryfieldmetacheckbox.md | 17 + ...atecreatetemplatetemporaryfieldmetadate.md | 14 + ...reatetemplatetemporaryfieldmetadropdown.md | 15 + ...tecreatetemplatetemporaryfieldmetaemail.md | 14 + ...reatetemplatetemporaryfieldmetainitials.md | 14 + ...atecreatetemplatetemporaryfieldmetaname.md | 14 + ...ecreatetemplatetemporaryfieldmetanumber.md | 21 + ...tecreatetemplatetemporaryfieldmetaradio.md | 15 + ...eatetemplatetemporaryfieldmetasignature.md | 13 + ...atecreatetemplatetemporaryfieldmetatext.md | 19 + ...tecreatetemplatetemporaryfieldmetaunion.md | 65 + ...emplatecreatetemplatetemporaryfieldtype.md | 18 + .../templatecreatetemplatetemporaryfolder.md | 17 + ...mplatecreatetemplatetemporaryfoldertype.md | 9 + ...reatetemplatetemporaryfoldervisibility.md} | 2 +- ...tecreatetemplatetemporaryforbiddenerror.md | 12 + ...tecreatetemplatetemporaryforbiddenissue.md | 8 + ...emplatetemporaryglobalaccessauthrequest.md | 9 + ...mplatetemporaryglobalaccessauthresponse.md | 9 + ...emplatetemporaryglobalactionauthrequest.md | 11 + ...mplatetemporaryglobalactionauthresponse.md | 11 + ...atetemplatetemporaryinternalservererror.md | 12 + ...mplatetemporaryinternalservererrorissue.md | 8 + ...templatecreatetemplatetemporarylanguage.md | 13 + ...=> templatecreatetemplatetemporarymeta.md} | 37 +- ...templatetemporarymetadistributionmethod.md | 9 + ...reatetemplatetemporarymetaemailsettings.md | 14 + ...mplatecreatetemplatetemporaryreadstatus.md | 9 + ...mplatecreatetemplatetemporaryrecipient.md} | 39 +- ...tetemplatetemporaryrecipientauthoptions.md | 9 + .../templatecreatetemplatetemporaryrequest.md | 18 + ...emplatecreatetemplatetemporaryresponse.md} | 8 +- .../templatecreatetemplatetemporaryrole.md | 12 + ...mplatecreatetemplatetemporarysendstatus.md | 9 + ...atetemplatetemporarysigningorderrequest.md | 9 + ...atecreatetemplatetemporarysigningstatus.md | 10 + ...emplatecreatetemplatetemporarytemplate.md} | 39 +- ...tetemplatetemporarytemplatedocumentdata.md | 12 + ...mplatetemporarytemplatedocumentdatatype.md | 10 + ...latecreatetemplatetemporarytemplatemeta.md | 24 + ...temporarytemplatemetadistributionmethod.md | 9 + ...platetemporarytemplatemetaemailsettings.md | 14 + ...mplatetemporarytemplatemetasigningorder.md | 9 + ...mplatecreatetemplatetemporarytextalign1.md | 10 + ...mplatecreatetemplatetemporarytextalign2.md | 10 + ...mplatecreatetemplatetemporarytextalign3.md | 10 + ...mplatecreatetemplatetemporarytextalign4.md | 10 + ...mplatecreatetemplatetemporarytextalign5.md | 10 + ...mplatecreatetemplatetemporarytextalign6.md | 10 + ...latecreatetemplatetemporarytypecheckbox.md | 8 + ...templatecreatetemplatetemporarytypedate.md | 8 + ...latecreatetemplatetemporarytypedropdown.md | 8 + ...emplatecreatetemplatetemporarytypeemail.md | 8 + ...latecreatetemplatetemporarytypeinitials.md | 8 + ...templatecreatetemplatetemporarytypelink.md | 8 + ...templatecreatetemplatetemporarytypename.md | 8 + ...mplatecreatetemplatetemporarytypenumber.md | 8 + ...emplatecreatetemplatetemporarytyperadio.md | 8 + ...platecreatetemplatetemporarytyperequest.md | 9 + ...latecreatetemplatetemporarytyperesponse.md | 9 + ...atecreatetemplatetemporarytypesignature.md | 8 + ...templatecreatetemplatetemporarytypetext.md | 8 + ...reatetemplatetemporaryunauthorizederror.md | 12 + ...reatetemplatetemporaryunauthorizedissue.md | 8 + .../templatecreatetemplatetemporaryuser.md | 10 + .../templatecreatetemplatetemporaryvalue1.md | 10 + .../templatecreatetemplatetemporaryvalue2.md | 10 + .../templatecreatetemplatetemporaryvalue3.md | 8 + ...tecreatetemplatetemporaryverticalalign1.md | 10 + ...tecreatetemplatetemporaryverticalalign2.md | 10 + ...reatetemplatetemporaryvisibilityrequest.md | 10 + ...eatetemplatetemporaryvisibilityresponse.md | 10 + docs/models/templatecreatetemplatetype.md | 9 + docs/models/templatecreatetemplatetypelink.md | 8 + ...templatecreatetemplateunauthorizederror.md | 12 + ...templatecreatetemplateunauthorizedissue.md | 8 + .../templatecreatetemplatevisibility.md | 10 + ...edeletetemplatedirectlinkforbiddenerror.md | 12 + ...edeletetemplatedirectlinkforbiddenissue.md | 8 + ...letetemplatedirectlinkunauthorizederror.md | 12 + ...letetemplatedirectlinkunauthorizedissue.md | 8 + .../templatedeletetemplateforbiddenerror.md | 12 + .../templatedeletetemplateforbiddenissue.md | 8 + ...templatedeletetemplateunauthorizederror.md | 12 + ...templatedeletetemplateunauthorizedissue.md | 8 + ...templateduplicatetemplateforbiddenerror.md | 12 + ...templateduplicatetemplateforbiddenissue.md | 8 + ...mplateduplicatetemplateglobalaccessauth.md | 9 +- ...mplateduplicatetemplateglobalactionauth.md | 2 - .../templateduplicatetemplateresponse.md | 5 +- ...plateduplicatetemplateunauthorizederror.md | 12 + ...plateduplicatetemplateunauthorizedissue.md | 8 + .../models/templatefindtemplatesaccessauth.md | 9 +- .../models/templatefindtemplatesactionauth.md | 2 - docs/models/templatefindtemplatesdata.md | 5 +- .../models/templatefindtemplatesdirection1.md | 9 + .../models/templatefindtemplatesdirection2.md | 9 + docs/models/templatefindtemplatesfield.md | 18 +- .../templatefindtemplatesfieldmetacheckbox.md | 22 +- .../templatefindtemplatesfieldmetadate.md | 2 +- .../templatefindtemplatesfieldmetadropdown.md | 1 + .../templatefindtemplatesfieldmetaemail.md | 2 +- .../templatefindtemplatesfieldmetainitials.md | 2 +- .../templatefindtemplatesfieldmetaname.md | 2 +- .../templatefindtemplatesfieldmetanumber.md | 29 +- .../templatefindtemplatesfieldmetaradio.md | 18 +- ...templatefindtemplatesfieldmetasignature.md | 13 + .../templatefindtemplatesfieldmetatext.md | 25 +- .../templatefindtemplatesfieldmetaunion.md | 6 + .../templatefindtemplatesforbiddenerror.md | 12 + .../templatefindtemplatesforbiddenissue.md | 8 + .../templatefindtemplatesglobalaccessauth.md | 9 +- .../templatefindtemplatesglobalactionauth.md | 2 - ...=> templatefindtemplatesqueryparamtype.md} | 2 +- docs/models/templatefindtemplatesrecipient.md | 9 +- docs/models/templatefindtemplatesrequest.md | 14 +- docs/models/templatefindtemplatesresponse.md | 8 +- .../templatefindtemplatestemplatemeta.md | 2 +- .../templatefindtemplatestypesignature.md | 8 + .../templatefindtemplatesunauthorizederror.md | 12 + .../templatefindtemplatesunauthorizedissue.md | 8 + .../templatefindtemplatesverticalalign1.md | 10 + .../templatefindtemplatesverticalalign2.md | 10 + .../templategettemplatebyidaccessauth.md | 9 +- .../templategettemplatebyidactionauth.md | 2 - .../templategettemplatebyiddirection1.md | 9 + .../templategettemplatebyiddirection2.md | 9 + .../templategettemplatebyiddirectlink.md | 5 +- .../templategettemplatebyidemailsettings.md | 18 +- .../templategettemplatebyidenvelopeitem.md | 9 + docs/models/templategettemplatebyidfield.md | 18 +- ...emplategettemplatebyidfieldmetacheckbox.md | 22 +- .../templategettemplatebyidfieldmetadate.md | 2 +- ...emplategettemplatebyidfieldmetadropdown.md | 1 + .../templategettemplatebyidfieldmetaemail.md | 2 +- ...emplategettemplatebyidfieldmetainitials.md | 2 +- .../templategettemplatebyidfieldmetaname.md | 2 +- .../templategettemplatebyidfieldmetanumber.md | 29 +- .../templategettemplatebyidfieldmetaradio.md | 18 +- ...mplategettemplatebyidfieldmetasignature.md | 13 + .../templategettemplatebyidfieldmetatext.md | 25 +- .../templategettemplatebyidfieldmetaunion.md | 6 + .../templategettemplatebyidforbiddenerror.md | 12 + .../templategettemplatebyidforbiddenissue.md | 8 + ...templategettemplatebyidglobalaccessauth.md | 9 +- ...templategettemplatebyidglobalactionauth.md | 2 - .../templategettemplatebyidrecipient.md | 9 +- .../models/templategettemplatebyidresponse.md | 48 +- ...lategettemplatebyidtemplatedocumentdata.md | 12 + ...ettemplatebyidtemplatedocumentdatatype.md} | 2 +- .../templategettemplatebyidtemplatemeta.md | 8 +- .../templategettemplatebyidtypesignature.md | 8 + ...emplategettemplatebyidunauthorizederror.md | 12 + ...emplategettemplatebyidunauthorizedissue.md | 8 + .../templategettemplatebyidverticalalign1.md | 10 + .../templategettemplatebyidverticalalign2.md | 10 + ...etoggletemplatedirectlinkforbiddenerror.md | 12 + ...etoggletemplatedirectlinkforbiddenissue.md | 8 + ...emplatetoggletemplatedirectlinkresponse.md | 5 +- ...ggletemplatedirectlinkunauthorizederror.md | 12 + ...ggletemplatedirectlinkunauthorizedissue.md | 8 + docs/models/templateupdatetemplatedata.md | 23 +- ...plateupdatetemplatedataglobalaccessauth.md | 9 + ...plateupdatetemplatedataglobalactionauth.md | 11 + .../templateupdatetemplatedatavisibility.md | 10 + .../templateupdatetemplatedateformat.md | 38 +- ...emplateupdatetemplatedistributionmethod.md | 2 - .../templateupdatetemplateemailsettings.md | 18 +- .../templateupdatetemplateforbiddenerror.md | 12 + .../templateupdatetemplateforbiddenissue.md | 8 + ...teupdatetemplateglobalaccessauthrequest.md | 10 - ...eupdatetemplateglobalaccessauthresponse.md | 9 +- ...eupdatetemplateglobalactionauthresponse.md | 2 - docs/models/templateupdatetemplatelanguage.md | 2 - docs/models/templateupdatetemplatemeta.md | 22 +- docs/models/templateupdatetemplateresponse.md | 5 +- ...templateupdatetemplateunauthorizederror.md | 12 + ...templateupdatetemplateunauthorizedissue.md | 8 + docs/sdks/directlinksdk/README.md | 16 +- docs/sdks/documenso/README.md | 7 - docs/sdks/documents/README.md | 338 +- docs/sdks/documentsattachments/README.md | 196 + docs/sdks/documentsdk/README.md | 55 + docs/sdks/documentsfields/README.md | 12 + docs/sdks/documentsrecipients/README.md | 12 + docs/sdks/embedding/README.md | 8 +- docs/sdks/envelopes/README.md | 381 + docs/sdks/envelopesattachments/README.md | 197 + docs/sdks/envelopesfields/README.md | 190 + docs/sdks/envelopesrecipients/README.md | 201 + docs/sdks/folders/README.md | 195 + docs/sdks/items/README.md | 195 + docs/sdks/templates/README.md | 97 +- docs/sdks/templatesdk/README.md | 62 + docs/sdks/templatesfields/README.md | 14 +- docs/sdks/templatesrecipients/README.md | 12 + pyproject.toml | 3 +- src/documenso_sdk/_version.py | 8 +- src/documenso_sdk/directlink_sdk.py | 112 +- src/documenso_sdk/document_sdk.py | 247 + src/documenso_sdk/documents.py | 1555 ++- src/documenso_sdk/documents_attachments.py | 955 ++ src/documenso_sdk/documents_fields.py | 196 +- src/documenso_sdk/documents_recipients.py | 216 +- src/documenso_sdk/embedding.py | 88 +- src/documenso_sdk/envelopes.py | 1834 ++++ src/documenso_sdk/envelopes_attachments.py | 961 ++ src/documenso_sdk/envelopes_fields.py | 927 ++ src/documenso_sdk/envelopes_recipients.py | 963 ++ src/documenso_sdk/folders.py | 917 ++ src/documenso_sdk/httpclient.py | 1 - src/documenso_sdk/items.py | 967 ++ src/documenso_sdk/models/__init__.py | 8631 +++++++++++++++-- src/documenso_sdk/models/apierror.py | 2 + src/documenso_sdk/models/documensoerror.py | 18 +- .../models/document_attachment_createop.py | 180 + .../models/document_attachment_deleteop.py | 165 + .../models/document_attachment_findop.py | 227 + .../models/document_attachment_updateop.py | 179 + .../document_createdocumenttemporaryop.py | 1083 ++- src/documenso_sdk/models/document_createop.py | 1513 +++ .../models/document_deletedocumentop.py | 95 - src/documenso_sdk/models/document_deleteop.py | 166 + .../models/document_distributeop.py | 505 + .../models/document_downloadbetaop.py | 229 + .../models/document_downloadop.py | 222 + .../models/document_duplicatedocumentop.py | 95 - .../models/document_duplicateop.py | 169 + ..._finddocumentsop.py => document_findop.py} | 333 +- .../document_getdocumentwithdetailsbyidop.py | 1276 --- src/documenso_sdk/models/document_getop.py | 1535 +++ .../models/document_redistributeop.py | 169 + .../models/document_resenddocumentop.py | 100 - .../models/document_senddocumentop.py | 401 - .../models/document_updatedocumentop.py | 544 -- src/documenso_sdk/models/document_updateop.py | 638 ++ ...ngpresign_createembeddingpresigntokenop.py | 95 +- ...ngpresign_verifyembeddingpresigntokenop.py | 93 +- .../models/envelope_attachment_createop.py | 180 + .../models/envelope_attachment_deleteop.py | 165 + .../models/envelope_attachment_findop.py | 233 + .../models/envelope_attachment_updateop.py | 179 + src/documenso_sdk/models/envelope_createop.py | 1662 ++++ src/documenso_sdk/models/envelope_deleteop.py | 166 + .../models/envelope_distributeop.py | 342 + .../models/envelope_duplicateop.py | 166 + .../models/envelope_field_createmanyop.py | 1962 ++++ .../models/envelope_field_deleteop.py | 166 + .../models/envelope_field_getop.py | 909 ++ .../models/envelope_field_updatemanyop.py | 1962 ++++ src/documenso_sdk/models/envelope_getop.py | 1474 +++ .../models/envelope_item_createmanyop.py | 226 + .../models/envelope_item_deleteop.py | 169 + .../models/envelope_item_downloadop.py | 222 + .../models/envelope_item_updatemanyop.py | 200 + .../models/envelope_recipient_createmanyop.py | 375 + .../models/envelope_recipient_deleteop.py | 166 + .../models/envelope_recipient_getop.py | 1071 ++ .../models/envelope_recipient_updatemanyop.py | 396 + .../models/envelope_redistributeop.py | 169 + src/documenso_sdk/models/envelope_updateop.py | 640 ++ src/documenso_sdk/models/envelope_useop.py | 590 ++ .../models/field_createdocumentfieldop.py | 755 +- .../models/field_createdocumentfieldsop.py | 755 +- .../models/field_createtemplatefieldop.py | 755 +- .../models/field_createtemplatefieldsop.py | 755 +- .../models/field_deletedocumentfieldop.py | 79 +- .../models/field_deletetemplatefieldop.py | 79 +- .../models/field_getdocumentfieldop.py | 377 +- .../models/field_gettemplatefieldop.py | 377 +- .../models/field_updatedocumentfieldop.py | 755 +- .../models/field_updatedocumentfieldsop.py | 755 +- .../models/field_updatetemplatefieldop.py | 755 +- .../models/field_updatetemplatefieldsop.py | 755 +- .../models/folder_createfolderop.py | 247 + .../models/folder_deletefolderop.py | 166 + .../models/folder_findfoldersop.py | 331 + .../models/folder_updatefolderop.py | 300 + src/documenso_sdk/models/no_response_error.py | 6 +- .../recipient_createdocumentrecipientop.py | 124 +- .../recipient_createdocumentrecipientsop.py | 124 +- .../recipient_createtemplaterecipientop.py | 124 +- .../recipient_createtemplaterecipientsop.py | 124 +- .../recipient_deletedocumentrecipientop.py | 79 +- .../recipient_deletetemplaterecipientop.py | 79 +- .../recipient_getdocumentrecipientop.py | 409 +- .../recipient_gettemplaterecipientop.py | 409 +- .../recipient_updatedocumentrecipientop.py | 415 +- .../recipient_updatedocumentrecipientsop.py | 415 +- .../recipient_updatetemplaterecipientop.py | 415 +- .../recipient_updatetemplaterecipientsop.py | 415 +- .../models/responsevalidationerror.py | 2 + .../template_createdocumentfromtemplateop.py | 639 +- .../template_createtemplatedirectlinkop.py | 90 +- .../models/template_createtemplateop.py | 543 ++ .../template_createtemplatetemporaryop.py | 1916 ++++ .../template_deletetemplatedirectlinkop.py | 79 +- .../models/template_deletetemplateop.py | 79 +- .../models/template_duplicatetemplateop.py | 101 +- .../models/template_findtemplatesop.py | 478 +- .../models/template_gettemplatebyidop.py | 511 +- .../template_toggletemplatedirectlinkop.py | 88 +- .../models/template_updatetemplateop.py | 260 +- src/documenso_sdk/sdk.py | 21 +- src/documenso_sdk/sdkconfiguration.py | 2 +- src/documenso_sdk/template_sdk.py | 355 + src/documenso_sdk/templates.py | 524 +- src/documenso_sdk/templates_fields.py | 196 +- src/documenso_sdk/templates_recipients.py | 216 +- src/documenso_sdk/utils/annotations.py | 40 +- 2295 files changed, 78027 insertions(+), 11298 deletions(-) delete mode 100644 docs/models/document.md create mode 100644 docs/models/documentattachmentcreatebadrequesterror.md create mode 100644 docs/models/documentattachmentcreatebadrequestissue.md create mode 100644 docs/models/documentattachmentcreatedata.md create mode 100644 docs/models/documentattachmentcreateforbiddenerror.md create mode 100644 docs/models/documentattachmentcreateforbiddenissue.md create mode 100644 docs/models/documentattachmentcreateinternalservererror.md create mode 100644 docs/models/documentattachmentcreateinternalservererrorissue.md create mode 100644 docs/models/documentattachmentcreaterequest.md create mode 100644 docs/models/documentattachmentcreateresponse.md create mode 100644 docs/models/documentattachmentcreateunauthorizederror.md create mode 100644 docs/models/documentattachmentcreateunauthorizedissue.md create mode 100644 docs/models/documentattachmentdeletebadrequesterror.md create mode 100644 docs/models/documentattachmentdeletebadrequestissue.md create mode 100644 docs/models/documentattachmentdeleteforbiddenerror.md create mode 100644 docs/models/documentattachmentdeleteforbiddenissue.md create mode 100644 docs/models/documentattachmentdeleteinternalservererror.md create mode 100644 docs/models/documentattachmentdeleteinternalservererrorissue.md create mode 100644 docs/models/documentattachmentdeleterequest.md create mode 100644 docs/models/documentattachmentdeleteresponse.md create mode 100644 docs/models/documentattachmentdeleteunauthorizederror.md create mode 100644 docs/models/documentattachmentdeleteunauthorizedissue.md rename docs/models/{documentdeletedocumentbadrequesterror.md => documentattachmentfindbadrequesterror.md} (92%) rename docs/models/{documentdeletedocumentbadrequestissue.md => documentattachmentfindbadrequestissue.md} (87%) create mode 100644 docs/models/documentattachmentfinddata.md create mode 100644 docs/models/documentattachmentfindforbiddenerror.md rename docs/models/{documentfinddocumentsbadrequestissue.md => documentattachmentfindforbiddenissue.md} (87%) rename docs/models/{documentdeletedocumentinternalservererror.md => documentattachmentfindinternalservererror.md} (93%) rename docs/models/{documentdeletedocumentinternalservererrorissue.md => documentattachmentfindinternalservererrorissue.md} (84%) create mode 100644 docs/models/documentattachmentfindnotfounderror.md rename docs/models/{documentsenddocumentbadrequestissue.md => documentattachmentfindnotfoundissue.md} (87%) rename docs/models/{documentdeletedocumentrequest.md => documentattachmentfindrequest.md} (89%) create mode 100644 docs/models/documentattachmentfindresponse.md create mode 100644 docs/models/documentattachmentfindtype.md create mode 100644 docs/models/documentattachmentfindunauthorizederror.md create mode 100644 docs/models/documentattachmentfindunauthorizedissue.md create mode 100644 docs/models/documentattachmentupdatebadrequesterror.md create mode 100644 docs/models/documentattachmentupdatebadrequestissue.md create mode 100644 docs/models/documentattachmentupdatedata.md create mode 100644 docs/models/documentattachmentupdateforbiddenerror.md create mode 100644 docs/models/documentattachmentupdateforbiddenissue.md create mode 100644 docs/models/documentattachmentupdateinternalservererror.md create mode 100644 docs/models/documentattachmentupdateinternalservererrorissue.md create mode 100644 docs/models/documentattachmentupdaterequest.md create mode 100644 docs/models/documentattachmentupdateresponse.md create mode 100644 docs/models/documentattachmentupdateunauthorizederror.md create mode 100644 docs/models/documentattachmentupdateunauthorizedissue.md create mode 100644 docs/models/documentcreateaccessauth.md rename docs/models/{documentfinddocumentsactionauth.md => documentcreateactionauth.md} (73%) create mode 100644 docs/models/documentcreateattachment.md create mode 100644 docs/models/documentcreatebadrequesterror.md rename docs/models/{documentfinddocumentsnotfoundissue.md => documentcreatebadrequestissue.md} (87%) create mode 100644 docs/models/documentcreatedateformat.md create mode 100644 docs/models/documentcreatedirectioncheckbox.md create mode 100644 docs/models/documentcreatedirectionradio.md rename docs/models/{documentgetdocumentwithdetailsbyiddistributionmethod.md => documentcreatedistributionmethod.md} (64%) create mode 100644 docs/models/documentcreatedocumenttemporaryattachment.md create mode 100644 docs/models/documentcreatedocumenttemporarydirectioncheckbox.md create mode 100644 docs/models/documentcreatedocumenttemporarydirectionradio.md delete mode 100644 docs/models/documentcreatedocumenttemporarydistributionmethodrequest.md create mode 100644 docs/models/documentcreatedocumenttemporarydocument.md delete mode 100644 docs/models/documentcreatedocumenttemporaryemailsettingsrequest.md create mode 100644 docs/models/documentcreatedocumenttemporaryenvelopeitem.md rename docs/models/{documentfinddocumentsinternalservererror.md => documentcreatedocumenttemporaryforbiddenerror.md} (92%) rename docs/models/{documentfinddocumentsinternalservererrorissue.md => documentcreatedocumenttemporaryforbiddenissue.md} (84%) rename docs/models/{documentgetdocumentwithdetailsbyidformvalues.md => documentcreatedocumenttemporaryformvaluesrequest.md} (79%) create mode 100644 docs/models/documentcreatedocumenttemporarymetadistributionmethod.md create mode 100644 docs/models/documentcreatedocumenttemporarymetaemailsettings.md create mode 100644 docs/models/documentcreatedocumenttemporaryrecipientfieldmetasignature.md create mode 100644 docs/models/documentcreatedocumenttemporaryrecipienttypesignature1.md create mode 100644 docs/models/documentcreatedocumenttemporaryrecipienttypesignature2.md create mode 100644 docs/models/documentcreatedocumenttemporarytypelink.md create mode 100644 docs/models/documentcreatedocumenttemporaryunauthorizederror.md create mode 100644 docs/models/documentcreatedocumenttemporaryunauthorizedissue.md create mode 100644 docs/models/documentcreatedocumenttemporaryverticalalignnumber.md create mode 100644 docs/models/documentcreatedocumenttemporaryverticalaligntext.md create mode 100644 docs/models/documentcreateemailsettings.md create mode 100644 docs/models/documentcreatefieldcheckbox.md create mode 100644 docs/models/documentcreatefielddate.md create mode 100644 docs/models/documentcreatefielddropdown.md create mode 100644 docs/models/documentcreatefieldemail.md create mode 100644 docs/models/documentcreatefieldfreesignature.md create mode 100644 docs/models/documentcreatefieldinitials.md create mode 100644 docs/models/documentcreatefieldmetacheckbox.md create mode 100644 docs/models/documentcreatefieldmetadate.md create mode 100644 docs/models/documentcreatefieldmetadropdown.md create mode 100644 docs/models/documentcreatefieldmetaemail.md create mode 100644 docs/models/documentcreatefieldmetainitials.md create mode 100644 docs/models/documentcreatefieldmetaname.md create mode 100644 docs/models/documentcreatefieldmetanumber.md create mode 100644 docs/models/documentcreatefieldmetaradio.md create mode 100644 docs/models/documentcreatefieldmetasignature.md create mode 100644 docs/models/documentcreatefieldmetatext.md create mode 100644 docs/models/documentcreatefieldname.md create mode 100644 docs/models/documentcreatefieldnumber.md create mode 100644 docs/models/documentcreatefieldradio.md create mode 100644 docs/models/documentcreatefieldsignature.md create mode 100644 docs/models/documentcreatefieldtext.md create mode 100644 docs/models/documentcreatefieldunion.md create mode 100644 docs/models/documentcreatefile.md rename docs/models/{documentupdatedocumentrequest.md => documentcreateforbiddenerror.md} (66%) rename docs/models/{documentresenddocumentbadrequestissue.md => documentcreateforbiddenissue.md} (87%) rename docs/models/{documentsenddocumentformvalues.md => documentcreateformvalues.md} (85%) create mode 100644 docs/models/documentcreateglobalaccessauth.md rename docs/models/{documentsenddocumentglobalactionauth.md => documentcreateglobalactionauth.md} (60%) create mode 100644 docs/models/documentcreateinternalservererror.md create mode 100644 docs/models/documentcreateinternalservererrorissue.md rename docs/models/{documentsenddocumentlanguage.md => documentcreatelanguage.md} (62%) create mode 100644 docs/models/documentcreatemeta.md create mode 100644 docs/models/documentcreatepayload.md create mode 100644 docs/models/documentcreaterecipient.md create mode 100644 docs/models/documentcreaterequest.md create mode 100644 docs/models/documentcreateresponse.md rename docs/models/{documentfinddocumentsrole.md => documentcreaterole.md} (88%) rename docs/models/{documentupdatedocumentsigningorder.md => documentcreatesigningorder.md} (79%) rename docs/models/{documentgetdocumentwithdetailsbyidtextalign2.md => documentcreatetextaligndate.md} (73%) rename docs/models/{documentgetdocumentwithdetailsbyidtextalign1.md => documentcreatetextalignemail.md} (73%) rename docs/models/{documentgetdocumentwithdetailsbyidtextalign3.md => documentcreatetextaligninitials.md} (73%) rename docs/models/{documentgetdocumentwithdetailsbyidtextalign4.md => documentcreatetextalignname.md} (73%) create mode 100644 docs/models/documentcreatetextalignnumber.md create mode 100644 docs/models/documentcreatetextaligntext.md create mode 100644 docs/models/documentcreatetypecheckbox1.md rename docs/models/{documentgetdocumentwithdetailsbyidtypecheckbox.md => documentcreatetypecheckbox2.md} (66%) create mode 100644 docs/models/documentcreatetypedate1.md rename docs/models/{documentgetdocumentwithdetailsbyidtypedate.md => documentcreatetypedate2.md} (61%) create mode 100644 docs/models/documentcreatetypedropdown1.md rename docs/models/{documentgetdocumentwithdetailsbyidtypedropdown.md => documentcreatetypedropdown2.md} (66%) create mode 100644 docs/models/documentcreatetypeemail1.md rename docs/models/{documentgetdocumentwithdetailsbyidtypeemail.md => documentcreatetypeemail2.md} (62%) create mode 100644 docs/models/documentcreatetypefreesignature.md create mode 100644 docs/models/documentcreatetypeinitials1.md rename docs/models/{documentgetdocumentwithdetailsbyidtypeinitials.md => documentcreatetypeinitials2.md} (66%) create mode 100644 docs/models/documentcreatetypelink.md create mode 100644 docs/models/documentcreatetypename1.md rename docs/models/{documentgetdocumentwithdetailsbyidtypename.md => documentcreatetypename2.md} (61%) create mode 100644 docs/models/documentcreatetypenumber1.md rename docs/models/{documentgetdocumentwithdetailsbyidtypenumber.md => documentcreatetypenumber2.md} (64%) create mode 100644 docs/models/documentcreatetyperadio1.md rename docs/models/{documentgetdocumentwithdetailsbyidtyperadio.md => documentcreatetyperadio2.md} (62%) rename docs/models/{fieldupdatedocumentfieldtypesignature.md => documentcreatetypesignature1.md} (71%) rename docs/models/{fieldcreatetemplatefieldtypesignature.md => documentcreatetypesignature2.md} (51%) create mode 100644 docs/models/documentcreatetypetext1.md rename docs/models/{documentgetdocumentwithdetailsbyidtypetext.md => documentcreatetypetext2.md} (61%) create mode 100644 docs/models/documentcreateunauthorizederror.md create mode 100644 docs/models/documentcreateunauthorizedissue.md rename docs/models/{documentgetdocumentwithdetailsbyidvalue1.md => documentcreatevaluecheckbox.md} (91%) rename docs/models/{documentgetdocumentwithdetailsbyidvalue3.md => documentcreatevaluedropdown.md} (86%) rename docs/models/{documentgetdocumentwithdetailsbyidvalue2.md => documentcreatevalueradio.md} (91%) create mode 100644 docs/models/documentcreateverticalalignnumber.md create mode 100644 docs/models/documentcreateverticalaligntext.md rename docs/models/{documentsenddocumentvisibility.md => documentcreatevisibility.md} (88%) create mode 100644 docs/models/documentdeletebadrequesterror.md create mode 100644 docs/models/documentdeletebadrequestissue.md create mode 100644 docs/models/documentdeleteforbiddenerror.md create mode 100644 docs/models/documentdeleteforbiddenissue.md create mode 100644 docs/models/documentdeleteinternalservererror.md create mode 100644 docs/models/documentdeleteinternalservererrorissue.md rename docs/models/{documentduplicatedocumentrequest.md => documentdeleterequest.md} (88%) rename docs/models/{documentdeletedocumentresponse.md => documentdeleteresponse.md} (89%) create mode 100644 docs/models/documentdeleteunauthorizederror.md create mode 100644 docs/models/documentdeleteunauthorizedissue.md create mode 100644 docs/models/documentdirection1.md create mode 100644 docs/models/documentdirection2.md create mode 100644 docs/models/documentdistributeauthoptions.md create mode 100644 docs/models/documentdistributebadrequesterror.md create mode 100644 docs/models/documentdistributebadrequestissue.md create mode 100644 docs/models/documentdistributedateformat.md create mode 100644 docs/models/documentdistributedistributionmethod.md create mode 100644 docs/models/documentdistributeemailsettings.md create mode 100644 docs/models/documentdistributeforbiddenerror.md create mode 100644 docs/models/documentdistributeforbiddenissue.md rename docs/models/{documentfinddocumentsformvalues.md => documentdistributeformvalues.md} (85%) create mode 100644 docs/models/documentdistributeglobalaccessauth.md rename docs/models/{documentfinddocumentsglobalactionauth.md => documentdistributeglobalactionauth.md} (60%) create mode 100644 docs/models/documentdistributeinternalservererror.md create mode 100644 docs/models/documentdistributeinternalservererrorissue.md rename docs/models/{documentupdatedocumentlanguage.md => documentdistributelanguage.md} (61%) create mode 100644 docs/models/documentdistributemeta.md create mode 100644 docs/models/documentdistributerequest.md create mode 100644 docs/models/documentdistributeresponse.md rename docs/models/{documentsenddocumentsource.md => documentdistributesource.md} (90%) rename docs/models/{documentsenddocumentstatus.md => documentdistributestatus.md} (86%) create mode 100644 docs/models/documentdistributeunauthorizederror.md create mode 100644 docs/models/documentdistributeunauthorizedissue.md rename docs/models/{documentfinddocumentsvisibility.md => documentdistributevisibility.md} (87%) rename docs/models/{documentfinddocumentsrecipientauthoptions.md => documentdownloadbadrequesterror.md} (58%) create mode 100644 docs/models/documentdownloadbadrequestissue.md rename docs/models/{documentsenddocumentbadrequesterror.md => documentdownloadbetabadrequesterror.md} (92%) create mode 100644 docs/models/documentdownloadbetabadrequestissue.md create mode 100644 docs/models/documentdownloadbetaforbiddenerror.md create mode 100644 docs/models/documentdownloadbetaforbiddenissue.md rename docs/models/{documentsenddocumentinternalservererror.md => documentdownloadbetainternalservererror.md} (93%) create mode 100644 docs/models/documentdownloadbetainternalservererrorissue.md create mode 100644 docs/models/documentdownloadbetanotfounderror.md create mode 100644 docs/models/documentdownloadbetanotfoundissue.md create mode 100644 docs/models/documentdownloadbetarequest.md create mode 100644 docs/models/documentdownloadbetaresponse.md rename docs/models/{documentresenddocumentbadrequesterror.md => documentdownloadbetaunauthorizederror.md} (91%) create mode 100644 docs/models/documentdownloadbetaunauthorizedissue.md create mode 100644 docs/models/documentdownloadbetaversion.md create mode 100644 docs/models/documentdownloadforbiddenerror.md create mode 100644 docs/models/documentdownloadforbiddenissue.md rename docs/models/{documentduplicatedocumentbadrequesterror.md => documentdownloadinternalservererror.md} (91%) rename docs/models/{documentduplicatedocumentbadrequestissue.md => documentdownloadinternalservererrorissue.md} (86%) create mode 100644 docs/models/documentdownloadnotfounderror.md create mode 100644 docs/models/documentdownloadnotfoundissue.md create mode 100644 docs/models/documentdownloadrequest.md create mode 100644 docs/models/documentdownloadresponse.md create mode 100644 docs/models/documentdownloadunauthorizederror.md create mode 100644 docs/models/documentdownloadunauthorizedissue.md create mode 100644 docs/models/documentdownloadversion.md create mode 100644 docs/models/documentduplicatebadrequesterror.md create mode 100644 docs/models/documentduplicatebadrequestissue.md create mode 100644 docs/models/documentduplicateforbiddenerror.md create mode 100644 docs/models/documentduplicateforbiddenissue.md create mode 100644 docs/models/documentduplicateinternalservererror.md create mode 100644 docs/models/documentduplicateinternalservererrorissue.md rename docs/models/{documentduplicatedocumentresponse.md => documentduplicaterequest.md} (82%) create mode 100644 docs/models/documentduplicateresponse.md create mode 100644 docs/models/documentduplicateunauthorizederror.md create mode 100644 docs/models/documentduplicateunauthorizedissue.md create mode 100644 docs/models/documentfindaccessauth.md rename docs/models/{documentgetdocumentwithdetailsbyidactionauth.md => documentfindactionauth.md} (71%) create mode 100644 docs/models/documentfindauthoptions.md create mode 100644 docs/models/documentfindbadrequesterror.md create mode 100644 docs/models/documentfindbadrequestissue.md create mode 100644 docs/models/documentfinddata.md delete mode 100644 docs/models/documentfinddocumentsaccessauth.md delete mode 100644 docs/models/documentfinddocumentsglobalaccessauth.md delete mode 100644 docs/models/documentfinddocumentsrecipient.md delete mode 100644 docs/models/documentfinddocumentsresponse.md create mode 100644 docs/models/documentfindforbiddenerror.md create mode 100644 docs/models/documentfindforbiddenissue.md rename docs/models/{documentupdatedocumentformvalues.md => documentfindformvalues.md} (85%) create mode 100644 docs/models/documentfindglobalaccessauth.md rename docs/models/{documentupdatedocumentglobalactionauthrequest.md => documentfindglobalactionauth.md} (59%) rename docs/models/{documentfinddocumentsbadrequesterror.md => documentfindinternalservererror.md} (91%) create mode 100644 docs/models/documentfindinternalservererrorissue.md create mode 100644 docs/models/documentfindnotfounderror.md create mode 100644 docs/models/documentfindnotfoundissue.md rename docs/models/{documentfinddocumentsreadstatus.md => documentfindreadstatus.md} (80%) rename docs/models/{documentfinddocumentsdata.md => documentfindrecipient.md} (63%) create mode 100644 docs/models/documentfindrecipientauthoptions.md rename docs/models/{documentfinddocumentsrequest.md => documentfindrequest.md} (99%) create mode 100644 docs/models/documentfindresponse.md rename docs/models/{documentgetdocumentwithdetailsbyidrole.md => documentfindrole.md} (84%) rename docs/models/{documentfinddocumentssendstatus.md => documentfindsendstatus.md} (78%) rename docs/models/{documentfinddocumentssigningstatus.md => documentfindsigningstatus.md} (82%) rename docs/models/{documentfinddocumentsteam.md => documentfindteam.md} (92%) create mode 100644 docs/models/documentfindunauthorizederror.md create mode 100644 docs/models/documentfindunauthorizedissue.md rename docs/models/{documentfinddocumentsuser.md => documentfinduser.md} (94%) rename docs/models/{templateupdatetemplatevisibilityrequest.md => documentfindvisibility.md} (85%) create mode 100644 docs/models/documentgetaccessauth.md create mode 100644 docs/models/documentgetactionauth.md create mode 100644 docs/models/documentgetauthoptions.md create mode 100644 docs/models/documentgetbadrequesterror.md create mode 100644 docs/models/documentgetbadrequestissue.md create mode 100644 docs/models/documentgetdirection1.md create mode 100644 docs/models/documentgetdirection2.md create mode 100644 docs/models/documentgetdistributionmethod.md create mode 100644 docs/models/documentgetdocumentdata.md rename docs/models/{templatedocumentdatatype.md => documentgetdocumentdatatype.md} (83%) create mode 100644 docs/models/documentgetdocumentmeta.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidaccessauth.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidbadrequestissue.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidemailsettings.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidfieldmetaemail.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidfieldmetaunion.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidfoldervisibility.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidglobalaccessauth.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidglobalactionauth.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidinternalservererrorissue.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidnotfoundissue.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidrequest.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidtextalign5.md delete mode 100644 docs/models/documentgetdocumentwithdetailsbyidtextalign6.md create mode 100644 docs/models/documentgetemailsettings.md create mode 100644 docs/models/documentgetenvelopeitem.md create mode 100644 docs/models/documentgetfield.md create mode 100644 docs/models/documentgetfieldmetacheckbox.md create mode 100644 docs/models/documentgetfieldmetadate.md create mode 100644 docs/models/documentgetfieldmetadropdown.md create mode 100644 docs/models/documentgetfieldmetaemail.md create mode 100644 docs/models/documentgetfieldmetainitials.md create mode 100644 docs/models/documentgetfieldmetaname.md create mode 100644 docs/models/documentgetfieldmetanumber.md create mode 100644 docs/models/documentgetfieldmetaradio.md rename docs/models/{prefillfielddropdown.md => documentgetfieldmetasignature.md} (58%) create mode 100644 docs/models/documentgetfieldmetatext.md create mode 100644 docs/models/documentgetfieldmetaunion.md rename docs/models/{documentgetdocumentwithdetailsbyidfieldtype.md => documentgetfieldtype.md} (92%) create mode 100644 docs/models/documentgetfolder.md rename docs/models/{documentgetdocumentwithdetailsbyidfoldertype.md => documentgetfoldertype.md} (72%) rename docs/models/{documentupdatedocumentvisibilityresponse.md => documentgetfoldervisibility.md} (84%) create mode 100644 docs/models/documentgetforbiddenerror.md create mode 100644 docs/models/documentgetforbiddenissue.md rename docs/models/{formvaluesrequest.md => documentgetformvalues.md} (89%) create mode 100644 docs/models/documentgetglobalaccessauth.md rename docs/models/{templateupdatetemplateglobalactionauthrequest.md => documentgetglobalactionauth.md} (59%) create mode 100644 docs/models/documentgetinternalservererror.md create mode 100644 docs/models/documentgetinternalservererrorissue.md create mode 100644 docs/models/documentgetnotfounderror.md create mode 100644 docs/models/documentgetnotfoundissue.md rename docs/models/{documentgetdocumentwithdetailsbyidreadstatus.md => documentgetreadstatus.md} (74%) rename docs/models/{documentsenddocumentresponse.md => documentgetrecipient.md} (71%) create mode 100644 docs/models/documentgetrecipientauthoptions.md create mode 100644 docs/models/documentgetrequest.md create mode 100644 docs/models/documentgetresponse.md create mode 100644 docs/models/documentgetrole.md rename docs/models/{documentgetdocumentwithdetailsbyidsendstatus.md => documentgetsendstatus.md} (72%) rename docs/models/{documentgetdocumentwithdetailsbyidsigningorder.md => documentgetsigningorder.md} (74%) rename docs/models/{documentgetdocumentwithdetailsbyidsigningstatus.md => documentgetsigningstatus.md} (77%) rename docs/models/{documentupdatedocumentsource.md => documentgetsource.md} (89%) rename docs/models/{documentupdatedocumentstatus.md => documentgetstatus.md} (86%) create mode 100644 docs/models/documentgettextalign1.md create mode 100644 docs/models/documentgettextalign2.md create mode 100644 docs/models/documentgettextalign3.md create mode 100644 docs/models/documentgettextalign4.md create mode 100644 docs/models/documentgettextalign5.md create mode 100644 docs/models/documentgettextalign6.md rename docs/models/{prefillfieldtypecheckbox.md => documentgettypecheckbox.md} (78%) rename docs/models/{prefillfieldtypedate.md => documentgettypedate.md} (75%) rename docs/models/{prefillfieldtypedropdown.md => documentgettypedropdown.md} (78%) create mode 100644 docs/models/documentgettypeemail.md create mode 100644 docs/models/documentgettypeinitials.md create mode 100644 docs/models/documentgettypename.md rename docs/models/{prefillfieldtypenumber.md => documentgettypenumber.md} (77%) rename docs/models/{prefillfieldtyperadio.md => documentgettyperadio.md} (76%) create mode 100644 docs/models/documentgettypesignature.md rename docs/models/{prefillfieldtypetext.md => documentgettypetext.md} (75%) create mode 100644 docs/models/documentgetunauthorizederror.md create mode 100644 docs/models/documentgetunauthorizedissue.md create mode 100644 docs/models/documentgetvalue1.md create mode 100644 docs/models/documentgetvalue2.md create mode 100644 docs/models/documentgetvalue3.md create mode 100644 docs/models/documentgetverticalalign1.md create mode 100644 docs/models/documentgetverticalalign2.md create mode 100644 docs/models/documentgetvisibility.md create mode 100644 docs/models/documentredistributebadrequesterror.md create mode 100644 docs/models/documentredistributebadrequestissue.md create mode 100644 docs/models/documentredistributeforbiddenerror.md create mode 100644 docs/models/documentredistributeforbiddenissue.md rename docs/models/{documentgetdocumentwithdetailsbyidrecipientauthoptions.md => documentredistributeinternalservererror.md} (60%) create mode 100644 docs/models/documentredistributeinternalservererrorissue.md create mode 100644 docs/models/documentredistributerequest.md rename docs/models/{documentresenddocumentresponse.md => documentredistributeresponse.md} (89%) rename docs/models/{documentupdatedocumentbadrequesterror.md => documentredistributeunauthorizederror.md} (91%) create mode 100644 docs/models/documentredistributeunauthorizedissue.md delete mode 100644 docs/models/documentresenddocumentinternalservererrorissue.md delete mode 100644 docs/models/documentresenddocumentrequest.md delete mode 100644 docs/models/documentsenddocumentdateformat.md delete mode 100644 docs/models/documentsenddocumentdistributionmethod.md delete mode 100644 docs/models/documentsenddocumentemailsettings.md delete mode 100644 docs/models/documentsenddocumentglobalaccessauth.md delete mode 100644 docs/models/documentsenddocumentinternalservererrorissue.md delete mode 100644 docs/models/documentsenddocumentmeta.md create mode 100644 docs/models/documenttypesignature.md create mode 100644 docs/models/documentupdateauthoptions.md create mode 100644 docs/models/documentupdatebadrequesterror.md create mode 100644 docs/models/documentupdatebadrequestissue.md create mode 100644 docs/models/documentupdatedata.md create mode 100644 docs/models/documentupdatedataglobalaccessauth.md create mode 100644 docs/models/documentupdatedataglobalactionauth.md create mode 100644 docs/models/documentupdatedatavisibility.md create mode 100644 docs/models/documentupdatedateformat.md create mode 100644 docs/models/documentupdatedistributionmethod.md delete mode 100644 docs/models/documentupdatedocumentbadrequestissue.md delete mode 100644 docs/models/documentupdatedocumentdata.md delete mode 100644 docs/models/documentupdatedocumentdateformat.md delete mode 100644 docs/models/documentupdatedocumentdistributionmethod.md delete mode 100644 docs/models/documentupdatedocumentemailsettings.md delete mode 100644 docs/models/documentupdatedocumentglobalaccessauthrequest.md delete mode 100644 docs/models/documentupdatedocumentglobalaccessauthresponse.md delete mode 100644 docs/models/documentupdatedocumentglobalactionauthresponse.md delete mode 100644 docs/models/documentupdatedocumentinternalservererrorissue.md delete mode 100644 docs/models/documentupdatedocumentresponse.md delete mode 100644 docs/models/documentupdatedocumentvisibilityrequest.md create mode 100644 docs/models/documentupdateemailsettings.md create mode 100644 docs/models/documentupdateforbiddenerror.md create mode 100644 docs/models/documentupdateforbiddenissue.md create mode 100644 docs/models/documentupdateformvalues.md create mode 100644 docs/models/documentupdateglobalaccessauthresponse.md create mode 100644 docs/models/documentupdateglobalactionauthresponse.md create mode 100644 docs/models/documentupdateinternalservererror.md create mode 100644 docs/models/documentupdateinternalservererrorissue.md create mode 100644 docs/models/documentupdatelanguage.md create mode 100644 docs/models/documentupdatemeta.md create mode 100644 docs/models/documentupdaterequest.md create mode 100644 docs/models/documentupdateresponse.md create mode 100644 docs/models/documentupdatesigningorder.md rename docs/models/{documentgetdocumentwithdetailsbyidsource.md => documentupdatesource.md} (86%) rename docs/models/{documentgetdocumentwithdetailsbyidstatus.md => documentupdatestatus.md} (81%) create mode 100644 docs/models/documentupdateunauthorizederror.md create mode 100644 docs/models/documentupdateunauthorizedissue.md create mode 100644 docs/models/documentupdatevisibilityresponse.md create mode 100644 docs/models/documentverticalalign1.md create mode 100644 docs/models/documentverticalalign2.md create mode 100644 docs/models/embeddingpresigncreateembeddingpresigntokenforbiddenerror.md create mode 100644 docs/models/embeddingpresigncreateembeddingpresigntokenforbiddenissue.md create mode 100644 docs/models/embeddingpresigncreateembeddingpresigntokenunauthorizederror.md create mode 100644 docs/models/embeddingpresigncreateembeddingpresigntokenunauthorizedissue.md create mode 100644 docs/models/embeddingpresignverifyembeddingpresigntokenforbiddenerror.md create mode 100644 docs/models/embeddingpresignverifyembeddingpresigntokenforbiddenissue.md create mode 100644 docs/models/embeddingpresignverifyembeddingpresigntokenunauthorizederror.md create mode 100644 docs/models/embeddingpresignverifyembeddingpresigntokenunauthorizedissue.md create mode 100644 docs/models/envelopeattachmentcreatebadrequesterror.md create mode 100644 docs/models/envelopeattachmentcreatebadrequestissue.md create mode 100644 docs/models/envelopeattachmentcreatedata.md create mode 100644 docs/models/envelopeattachmentcreateforbiddenerror.md create mode 100644 docs/models/envelopeattachmentcreateforbiddenissue.md create mode 100644 docs/models/envelopeattachmentcreateinternalservererror.md create mode 100644 docs/models/envelopeattachmentcreateinternalservererrorissue.md create mode 100644 docs/models/envelopeattachmentcreaterequest.md create mode 100644 docs/models/envelopeattachmentcreateresponse.md create mode 100644 docs/models/envelopeattachmentcreateunauthorizederror.md create mode 100644 docs/models/envelopeattachmentcreateunauthorizedissue.md create mode 100644 docs/models/envelopeattachmentdeletebadrequesterror.md create mode 100644 docs/models/envelopeattachmentdeletebadrequestissue.md create mode 100644 docs/models/envelopeattachmentdeleteforbiddenerror.md create mode 100644 docs/models/envelopeattachmentdeleteforbiddenissue.md create mode 100644 docs/models/envelopeattachmentdeleteinternalservererror.md create mode 100644 docs/models/envelopeattachmentdeleteinternalservererrorissue.md create mode 100644 docs/models/envelopeattachmentdeleterequest.md create mode 100644 docs/models/envelopeattachmentdeleteresponse.md create mode 100644 docs/models/envelopeattachmentdeleteunauthorizederror.md create mode 100644 docs/models/envelopeattachmentdeleteunauthorizedissue.md rename docs/models/{documentfinddocumentsauthoptions.md => envelopeattachmentfindbadrequesterror.md} (54%) create mode 100644 docs/models/envelopeattachmentfindbadrequestissue.md create mode 100644 docs/models/envelopeattachmentfinddata.md create mode 100644 docs/models/envelopeattachmentfindforbiddenerror.md create mode 100644 docs/models/envelopeattachmentfindforbiddenissue.md rename docs/models/{documentupdatedocumentinternalservererror.md => envelopeattachmentfindinternalservererror.md} (93%) create mode 100644 docs/models/envelopeattachmentfindinternalservererrorissue.md create mode 100644 docs/models/envelopeattachmentfindnotfounderror.md create mode 100644 docs/models/envelopeattachmentfindnotfoundissue.md create mode 100644 docs/models/envelopeattachmentfindrequest.md create mode 100644 docs/models/envelopeattachmentfindresponse.md create mode 100644 docs/models/envelopeattachmentfindtype.md create mode 100644 docs/models/envelopeattachmentfindunauthorizederror.md create mode 100644 docs/models/envelopeattachmentfindunauthorizedissue.md create mode 100644 docs/models/envelopeattachmentupdatebadrequesterror.md create mode 100644 docs/models/envelopeattachmentupdatebadrequestissue.md create mode 100644 docs/models/envelopeattachmentupdatedata.md create mode 100644 docs/models/envelopeattachmentupdateforbiddenerror.md create mode 100644 docs/models/envelopeattachmentupdateforbiddenissue.md create mode 100644 docs/models/envelopeattachmentupdateinternalservererror.md create mode 100644 docs/models/envelopeattachmentupdateinternalservererrorissue.md create mode 100644 docs/models/envelopeattachmentupdaterequest.md create mode 100644 docs/models/envelopeattachmentupdateresponse.md create mode 100644 docs/models/envelopeattachmentupdateunauthorizederror.md create mode 100644 docs/models/envelopeattachmentupdateunauthorizedissue.md create mode 100644 docs/models/envelopecreateaccessauth.md create mode 100644 docs/models/envelopecreateactionauth.md create mode 100644 docs/models/envelopecreateattachment.md create mode 100644 docs/models/envelopecreatebadrequesterror.md create mode 100644 docs/models/envelopecreatebadrequestissue.md create mode 100644 docs/models/envelopecreatedateformat.md create mode 100644 docs/models/envelopecreatedirectioncheckbox.md create mode 100644 docs/models/envelopecreatedirectionradio.md create mode 100644 docs/models/envelopecreatedistributionmethod.md create mode 100644 docs/models/envelopecreateemailsettings.md create mode 100644 docs/models/envelopecreatefieldcheckbox.md create mode 100644 docs/models/envelopecreatefielddate.md create mode 100644 docs/models/envelopecreatefielddropdown.md create mode 100644 docs/models/envelopecreatefieldemail.md create mode 100644 docs/models/envelopecreatefieldfreesignature.md create mode 100644 docs/models/envelopecreatefieldinitials.md create mode 100644 docs/models/envelopecreatefieldmetacheckbox.md create mode 100644 docs/models/envelopecreatefieldmetadate.md create mode 100644 docs/models/envelopecreatefieldmetadropdown.md create mode 100644 docs/models/envelopecreatefieldmetaemail.md create mode 100644 docs/models/envelopecreatefieldmetainitials.md create mode 100644 docs/models/envelopecreatefieldmetaname.md create mode 100644 docs/models/envelopecreatefieldmetanumber.md create mode 100644 docs/models/envelopecreatefieldmetaradio.md create mode 100644 docs/models/envelopecreatefieldmetasignature.md create mode 100644 docs/models/envelopecreatefieldmetatext.md create mode 100644 docs/models/envelopecreatefieldname.md create mode 100644 docs/models/envelopecreatefieldnumber.md create mode 100644 docs/models/envelopecreatefieldradio.md create mode 100644 docs/models/envelopecreatefieldsignature.md create mode 100644 docs/models/envelopecreatefieldtext.md create mode 100644 docs/models/envelopecreatefieldunion.md create mode 100644 docs/models/envelopecreatefile.md create mode 100644 docs/models/envelopecreateforbiddenerror.md create mode 100644 docs/models/envelopecreateforbiddenissue.md create mode 100644 docs/models/envelopecreateformvalues.md create mode 100644 docs/models/envelopecreateglobalaccessauth.md create mode 100644 docs/models/envelopecreateglobalactionauth.md create mode 100644 docs/models/envelopecreateidentifier1.md create mode 100644 docs/models/envelopecreateidentifier10.md create mode 100644 docs/models/envelopecreateidentifier11.md create mode 100644 docs/models/envelopecreateidentifier2.md create mode 100644 docs/models/envelopecreateidentifier3.md create mode 100644 docs/models/envelopecreateidentifier4.md create mode 100644 docs/models/envelopecreateidentifier5.md create mode 100644 docs/models/envelopecreateidentifier6.md create mode 100644 docs/models/envelopecreateidentifier7.md create mode 100644 docs/models/envelopecreateidentifier8.md create mode 100644 docs/models/envelopecreateidentifier9.md create mode 100644 docs/models/envelopecreateinternalservererror.md create mode 100644 docs/models/envelopecreateinternalservererrorissue.md create mode 100644 docs/models/envelopecreatelanguage.md create mode 100644 docs/models/envelopecreatemeta.md create mode 100644 docs/models/envelopecreatepayload.md create mode 100644 docs/models/envelopecreaterecipient.md create mode 100644 docs/models/envelopecreaterequest.md create mode 100644 docs/models/envelopecreateresponse.md create mode 100644 docs/models/envelopecreaterole.md create mode 100644 docs/models/envelopecreatesigningorder.md create mode 100644 docs/models/envelopecreatetextaligndate.md create mode 100644 docs/models/envelopecreatetextalignemail.md create mode 100644 docs/models/envelopecreatetextaligninitials.md create mode 100644 docs/models/envelopecreatetextalignname.md create mode 100644 docs/models/envelopecreatetextalignnumber.md create mode 100644 docs/models/envelopecreatetextaligntext.md create mode 100644 docs/models/envelopecreatetype.md create mode 100644 docs/models/envelopecreatetypecheckbox1.md create mode 100644 docs/models/envelopecreatetypecheckbox2.md create mode 100644 docs/models/envelopecreatetypedate1.md create mode 100644 docs/models/envelopecreatetypedate2.md create mode 100644 docs/models/envelopecreatetypedropdown1.md create mode 100644 docs/models/envelopecreatetypedropdown2.md create mode 100644 docs/models/envelopecreatetypeemail1.md create mode 100644 docs/models/envelopecreatetypeemail2.md create mode 100644 docs/models/envelopecreatetypefreesignature.md create mode 100644 docs/models/envelopecreatetypeinitials1.md create mode 100644 docs/models/envelopecreatetypeinitials2.md create mode 100644 docs/models/envelopecreatetypelink.md create mode 100644 docs/models/envelopecreatetypename1.md create mode 100644 docs/models/envelopecreatetypename2.md create mode 100644 docs/models/envelopecreatetypenumber1.md create mode 100644 docs/models/envelopecreatetypenumber2.md create mode 100644 docs/models/envelopecreatetyperadio1.md create mode 100644 docs/models/envelopecreatetyperadio2.md rename docs/models/{fieldupdatetemplatefieldtypesignature.md => envelopecreatetypesignature1.md} (71%) create mode 100644 docs/models/envelopecreatetypesignature2.md create mode 100644 docs/models/envelopecreatetypetext1.md create mode 100644 docs/models/envelopecreatetypetext2.md create mode 100644 docs/models/envelopecreateunauthorizederror.md create mode 100644 docs/models/envelopecreateunauthorizedissue.md create mode 100644 docs/models/envelopecreatevaluecheckbox.md create mode 100644 docs/models/envelopecreatevaluedropdown.md create mode 100644 docs/models/envelopecreatevalueradio.md create mode 100644 docs/models/envelopecreateverticalalignnumber.md create mode 100644 docs/models/envelopecreateverticalaligntext.md create mode 100644 docs/models/envelopecreatevisibility.md create mode 100644 docs/models/envelopedeletebadrequesterror.md create mode 100644 docs/models/envelopedeletebadrequestissue.md create mode 100644 docs/models/envelopedeleteforbiddenerror.md create mode 100644 docs/models/envelopedeleteforbiddenissue.md create mode 100644 docs/models/envelopedeleteinternalservererror.md create mode 100644 docs/models/envelopedeleteinternalservererrorissue.md create mode 100644 docs/models/envelopedeleterequest.md create mode 100644 docs/models/envelopedeleteresponse.md create mode 100644 docs/models/envelopedeleteunauthorizederror.md create mode 100644 docs/models/envelopedeleteunauthorizedissue.md create mode 100644 docs/models/envelopedistributebadrequesterror.md create mode 100644 docs/models/envelopedistributebadrequestissue.md create mode 100644 docs/models/envelopedistributedateformat.md create mode 100644 docs/models/envelopedistributedistributionmethod.md create mode 100644 docs/models/envelopedistributeemailsettings.md create mode 100644 docs/models/envelopedistributeforbiddenerror.md create mode 100644 docs/models/envelopedistributeforbiddenissue.md create mode 100644 docs/models/envelopedistributeinternalservererror.md create mode 100644 docs/models/envelopedistributeinternalservererrorissue.md create mode 100644 docs/models/envelopedistributelanguage.md create mode 100644 docs/models/envelopedistributemeta.md create mode 100644 docs/models/envelopedistributerequest.md create mode 100644 docs/models/envelopedistributeresponse.md create mode 100644 docs/models/envelopedistributeunauthorizederror.md create mode 100644 docs/models/envelopedistributeunauthorizedissue.md create mode 100644 docs/models/envelopeduplicatebadrequesterror.md create mode 100644 docs/models/envelopeduplicatebadrequestissue.md create mode 100644 docs/models/envelopeduplicateforbiddenerror.md create mode 100644 docs/models/envelopeduplicateforbiddenissue.md create mode 100644 docs/models/envelopeduplicateinternalservererror.md create mode 100644 docs/models/envelopeduplicateinternalservererrorissue.md create mode 100644 docs/models/envelopeduplicaterequest.md create mode 100644 docs/models/envelopeduplicateresponse.md create mode 100644 docs/models/envelopeduplicateunauthorizederror.md create mode 100644 docs/models/envelopeduplicateunauthorizedissue.md create mode 100644 docs/models/envelopefieldcreatemanybadrequesterror.md create mode 100644 docs/models/envelopefieldcreatemanybadrequestissue.md create mode 100644 docs/models/envelopefieldcreatemanydatacheckbox.md create mode 100644 docs/models/envelopefieldcreatemanydatadate.md create mode 100644 docs/models/envelopefieldcreatemanydatadropdown.md rename docs/models/{documentgetdocumentwithdetailsbyidfieldmetadate.md => envelopefieldcreatemanydataemail.md} (60%) create mode 100644 docs/models/envelopefieldcreatemanydatafreesignature.md create mode 100644 docs/models/envelopefieldcreatemanydatainitials.md create mode 100644 docs/models/envelopefieldcreatemanydataname.md rename docs/models/{documentgetdocumentwithdetailsbyidfolder.md => envelopefieldcreatemanydatanumber.md} (71%) create mode 100644 docs/models/envelopefieldcreatemanydataradio.md create mode 100644 docs/models/envelopefieldcreatemanydataresponse.md rename docs/models/{documentgetdocumentwithdetailsbyidfield.md => envelopefieldcreatemanydatasignature.md} (61%) create mode 100644 docs/models/envelopefieldcreatemanydatatext.md create mode 100644 docs/models/envelopefieldcreatemanydataunion.md create mode 100644 docs/models/envelopefieldcreatemanydirectioncheckbox.md create mode 100644 docs/models/envelopefieldcreatemanydirectionradio.md create mode 100644 docs/models/envelopefieldcreatemanydirectionresponse1.md create mode 100644 docs/models/envelopefieldcreatemanydirectionresponse2.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetacheckboxrequest.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetacheckboxresponse.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetadaterequest.md rename docs/models/{documentgetdocumentwithdetailsbyidfieldmetadropdown.md => envelopefieldcreatemanyfieldmetadateresponse.md} (87%) rename docs/models/{documentgetdocumentwithdetailsbyidfieldmetaradio.md => envelopefieldcreatemanyfieldmetadropdownrequest.md} (72%) create mode 100644 docs/models/envelopefieldcreatemanyfieldmetadropdownresponse.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetaemailrequest.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetaemailresponse.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetainitialsrequest.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetainitialsresponse.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetanamerequest.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetanameresponse.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetanumberrequest.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetanumberresponse.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetaradiorequest.md rename docs/models/{documentgetdocumentwithdetailsbyidfieldmetacheckbox.md => envelopefieldcreatemanyfieldmetaradioresponse.md} (86%) create mode 100644 docs/models/envelopefieldcreatemanyfieldmetasignaturerequest.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetasignatureresponse.md rename docs/models/{documentgetdocumentwithdetailsbyidfieldmetanumber.md => envelopefieldcreatemanyfieldmetatextrequest.md} (83%) create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatextresponse.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatypecheckbox.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatypedate.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatypedropdown.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatypeemail.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatypeinitials.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatypename.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatypenumber.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatyperadio.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatypesignature.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetatypetext.md create mode 100644 docs/models/envelopefieldcreatemanyfieldmetaunion.md create mode 100644 docs/models/envelopefieldcreatemanyforbiddenerror.md create mode 100644 docs/models/envelopefieldcreatemanyforbiddenissue.md rename docs/models/{documentgetdocumentwithdetailsbyidnotfounderror.md => envelopefieldcreatemanyinternalservererror.md} (92%) create mode 100644 docs/models/envelopefieldcreatemanyinternalservererrorissue.md create mode 100644 docs/models/envelopefieldcreatemanyrequest.md create mode 100644 docs/models/envelopefieldcreatemanyresponse.md create mode 100644 docs/models/envelopefieldcreatemanytextaligndate.md create mode 100644 docs/models/envelopefieldcreatemanytextalignemail.md create mode 100644 docs/models/envelopefieldcreatemanytextaligninitials.md create mode 100644 docs/models/envelopefieldcreatemanytextalignname.md create mode 100644 docs/models/envelopefieldcreatemanytextalignnumber.md create mode 100644 docs/models/envelopefieldcreatemanytextalignresponse1.md create mode 100644 docs/models/envelopefieldcreatemanytextalignresponse2.md create mode 100644 docs/models/envelopefieldcreatemanytextalignresponse3.md create mode 100644 docs/models/envelopefieldcreatemanytextalignresponse4.md create mode 100644 docs/models/envelopefieldcreatemanytextalignresponse5.md create mode 100644 docs/models/envelopefieldcreatemanytextalignresponse6.md create mode 100644 docs/models/envelopefieldcreatemanytextaligntext.md create mode 100644 docs/models/envelopefieldcreatemanytypecheckboxrequest1.md create mode 100644 docs/models/envelopefieldcreatemanytypecheckboxrequest2.md create mode 100644 docs/models/envelopefieldcreatemanytypedaterequest1.md create mode 100644 docs/models/envelopefieldcreatemanytypedaterequest2.md create mode 100644 docs/models/envelopefieldcreatemanytypedropdownrequest1.md create mode 100644 docs/models/envelopefieldcreatemanytypedropdownrequest2.md create mode 100644 docs/models/envelopefieldcreatemanytypeemailrequest1.md create mode 100644 docs/models/envelopefieldcreatemanytypeemailrequest2.md create mode 100644 docs/models/envelopefieldcreatemanytypefreesignature.md create mode 100644 docs/models/envelopefieldcreatemanytypeinitialsrequest1.md create mode 100644 docs/models/envelopefieldcreatemanytypeinitialsrequest2.md create mode 100644 docs/models/envelopefieldcreatemanytypenamerequest1.md create mode 100644 docs/models/envelopefieldcreatemanytypenamerequest2.md create mode 100644 docs/models/envelopefieldcreatemanytypenumberrequest1.md create mode 100644 docs/models/envelopefieldcreatemanytypenumberrequest2.md create mode 100644 docs/models/envelopefieldcreatemanytyperadiorequest1.md create mode 100644 docs/models/envelopefieldcreatemanytyperadiorequest2.md create mode 100644 docs/models/envelopefieldcreatemanytyperesponse.md rename docs/models/{fieldcreatetemplatefieldstypesignature.md => envelopefieldcreatemanytypesignaturerequest1.md} (68%) create mode 100644 docs/models/envelopefieldcreatemanytypesignaturerequest2.md create mode 100644 docs/models/envelopefieldcreatemanytypetextrequest1.md create mode 100644 docs/models/envelopefieldcreatemanytypetextrequest2.md create mode 100644 docs/models/envelopefieldcreatemanyunauthorizederror.md create mode 100644 docs/models/envelopefieldcreatemanyunauthorizedissue.md create mode 100644 docs/models/envelopefieldcreatemanyvaluecheckbox.md create mode 100644 docs/models/envelopefieldcreatemanyvaluedropdown.md create mode 100644 docs/models/envelopefieldcreatemanyvalueradio.md create mode 100644 docs/models/envelopefieldcreatemanyvalueresponse1.md create mode 100644 docs/models/envelopefieldcreatemanyvalueresponse2.md create mode 100644 docs/models/envelopefieldcreatemanyvalueresponse3.md create mode 100644 docs/models/envelopefieldcreatemanyverticalalignnumber.md create mode 100644 docs/models/envelopefieldcreatemanyverticalalignresponse1.md create mode 100644 docs/models/envelopefieldcreatemanyverticalalignresponse2.md create mode 100644 docs/models/envelopefieldcreatemanyverticalaligntext.md rename docs/models/{documentfinddocumentsnotfounderror.md => envelopefielddeletebadrequesterror.md} (91%) create mode 100644 docs/models/envelopefielddeletebadrequestissue.md create mode 100644 docs/models/envelopefielddeleteforbiddenerror.md create mode 100644 docs/models/envelopefielddeleteforbiddenissue.md create mode 100644 docs/models/envelopefielddeleteinternalservererror.md create mode 100644 docs/models/envelopefielddeleteinternalservererrorissue.md create mode 100644 docs/models/envelopefielddeleterequest.md create mode 100644 docs/models/envelopefielddeleteresponse.md create mode 100644 docs/models/envelopefielddeleteunauthorizederror.md create mode 100644 docs/models/envelopefielddeleteunauthorizedissue.md create mode 100644 docs/models/envelopefieldgetbadrequesterror.md create mode 100644 docs/models/envelopefieldgetbadrequestissue.md create mode 100644 docs/models/envelopefieldgetdirection1.md create mode 100644 docs/models/envelopefieldgetdirection2.md create mode 100644 docs/models/envelopefieldgetfieldmetacheckbox.md create mode 100644 docs/models/envelopefieldgetfieldmetadate.md create mode 100644 docs/models/envelopefieldgetfieldmetadropdown.md create mode 100644 docs/models/envelopefieldgetfieldmetaemail.md create mode 100644 docs/models/envelopefieldgetfieldmetainitials.md create mode 100644 docs/models/envelopefieldgetfieldmetaname.md create mode 100644 docs/models/envelopefieldgetfieldmetanumber.md create mode 100644 docs/models/envelopefieldgetfieldmetaradio.md create mode 100644 docs/models/envelopefieldgetfieldmetasignature.md create mode 100644 docs/models/envelopefieldgetfieldmetatext.md create mode 100644 docs/models/envelopefieldgetfieldmetaunion.md create mode 100644 docs/models/envelopefieldgetforbiddenerror.md create mode 100644 docs/models/envelopefieldgetforbiddenissue.md create mode 100644 docs/models/envelopefieldgetinternalservererror.md create mode 100644 docs/models/envelopefieldgetinternalservererrorissue.md create mode 100644 docs/models/envelopefieldgetnotfounderror.md create mode 100644 docs/models/envelopefieldgetnotfoundissue.md create mode 100644 docs/models/envelopefieldgetrequest.md create mode 100644 docs/models/envelopefieldgetresponse.md create mode 100644 docs/models/envelopefieldgettextalign1.md create mode 100644 docs/models/envelopefieldgettextalign2.md create mode 100644 docs/models/envelopefieldgettextalign3.md create mode 100644 docs/models/envelopefieldgettextalign4.md create mode 100644 docs/models/envelopefieldgettextalign5.md create mode 100644 docs/models/envelopefieldgettextalign6.md create mode 100644 docs/models/envelopefieldgettype.md create mode 100644 docs/models/envelopefieldgettypecheckbox.md create mode 100644 docs/models/envelopefieldgettypedate.md create mode 100644 docs/models/envelopefieldgettypedropdown.md create mode 100644 docs/models/envelopefieldgettypeemail.md create mode 100644 docs/models/envelopefieldgettypeinitials.md create mode 100644 docs/models/envelopefieldgettypename.md create mode 100644 docs/models/envelopefieldgettypenumber.md create mode 100644 docs/models/envelopefieldgettyperadio.md create mode 100644 docs/models/envelopefieldgettypesignature.md create mode 100644 docs/models/envelopefieldgettypetext.md create mode 100644 docs/models/envelopefieldgetunauthorizederror.md create mode 100644 docs/models/envelopefieldgetunauthorizedissue.md create mode 100644 docs/models/envelopefieldgetvalue1.md create mode 100644 docs/models/envelopefieldgetvalue2.md create mode 100644 docs/models/envelopefieldgetvalue3.md create mode 100644 docs/models/envelopefieldgetverticalalign1.md create mode 100644 docs/models/envelopefieldgetverticalalign2.md create mode 100644 docs/models/envelopefieldupdatemanybadrequesterror.md create mode 100644 docs/models/envelopefieldupdatemanybadrequestissue.md create mode 100644 docs/models/envelopefieldupdatemanydatacheckbox.md create mode 100644 docs/models/envelopefieldupdatemanydatadate.md create mode 100644 docs/models/envelopefieldupdatemanydatadropdown.md rename docs/models/{documentgetdocumentwithdetailsbyidfieldmetatext.md => envelopefieldupdatemanydataemail.md} (79%) create mode 100644 docs/models/envelopefieldupdatemanydatafreesignature.md create mode 100644 docs/models/envelopefieldupdatemanydatainitials.md create mode 100644 docs/models/envelopefieldupdatemanydataname.md create mode 100644 docs/models/envelopefieldupdatemanydatanumber.md rename docs/models/{documentgetdocumentwithdetailsbyidfieldmetaname.md => envelopefieldupdatemanydataradio.md} (66%) create mode 100644 docs/models/envelopefieldupdatemanydataresponse.md create mode 100644 docs/models/envelopefieldupdatemanydatasignature.md create mode 100644 docs/models/envelopefieldupdatemanydatatext.md create mode 100644 docs/models/envelopefieldupdatemanydataunion.md create mode 100644 docs/models/envelopefieldupdatemanydirectioncheckbox.md create mode 100644 docs/models/envelopefieldupdatemanydirectionradio.md create mode 100644 docs/models/envelopefieldupdatemanydirectionresponse1.md create mode 100644 docs/models/envelopefieldupdatemanydirectionresponse2.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetacheckboxrequest.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetacheckboxresponse.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetadaterequest.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetadateresponse.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetadropdownrequest.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetadropdownresponse.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetaemailrequest.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetaemailresponse.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetainitialsrequest.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetainitialsresponse.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetanamerequest.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetanameresponse.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetanumberrequest.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetanumberresponse.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetaradiorequest.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetaradioresponse.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetasignaturerequest.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetasignatureresponse.md rename docs/models/{documentgetdocumentwithdetailsbyidfieldmetainitials.md => envelopefieldupdatemanyfieldmetatextrequest.md} (60%) create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatextresponse.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatypecheckbox.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatypedate.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatypedropdown.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatypeemail.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatypeinitials.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatypename.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatypenumber.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatyperadio.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatypesignature.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetatypetext.md create mode 100644 docs/models/envelopefieldupdatemanyfieldmetaunion.md create mode 100644 docs/models/envelopefieldupdatemanyforbiddenerror.md create mode 100644 docs/models/envelopefieldupdatemanyforbiddenissue.md rename docs/models/{documentgetdocumentwithdetailsbyiddocumentdata.md => envelopefieldupdatemanyinternalservererror.md} (69%) create mode 100644 docs/models/envelopefieldupdatemanyinternalservererrorissue.md create mode 100644 docs/models/envelopefieldupdatemanyrequest.md create mode 100644 docs/models/envelopefieldupdatemanyresponse.md create mode 100644 docs/models/envelopefieldupdatemanytextaligndate.md create mode 100644 docs/models/envelopefieldupdatemanytextalignemail.md create mode 100644 docs/models/envelopefieldupdatemanytextaligninitials.md create mode 100644 docs/models/envelopefieldupdatemanytextalignname.md create mode 100644 docs/models/envelopefieldupdatemanytextalignnumber.md create mode 100644 docs/models/envelopefieldupdatemanytextalignresponse1.md create mode 100644 docs/models/envelopefieldupdatemanytextalignresponse2.md create mode 100644 docs/models/envelopefieldupdatemanytextalignresponse3.md create mode 100644 docs/models/envelopefieldupdatemanytextalignresponse4.md create mode 100644 docs/models/envelopefieldupdatemanytextalignresponse5.md create mode 100644 docs/models/envelopefieldupdatemanytextalignresponse6.md create mode 100644 docs/models/envelopefieldupdatemanytextaligntext.md create mode 100644 docs/models/envelopefieldupdatemanytypecheckboxrequest1.md create mode 100644 docs/models/envelopefieldupdatemanytypecheckboxrequest2.md create mode 100644 docs/models/envelopefieldupdatemanytypedaterequest1.md create mode 100644 docs/models/envelopefieldupdatemanytypedaterequest2.md create mode 100644 docs/models/envelopefieldupdatemanytypedropdownrequest1.md create mode 100644 docs/models/envelopefieldupdatemanytypedropdownrequest2.md create mode 100644 docs/models/envelopefieldupdatemanytypeemailrequest1.md create mode 100644 docs/models/envelopefieldupdatemanytypeemailrequest2.md create mode 100644 docs/models/envelopefieldupdatemanytypefreesignature.md create mode 100644 docs/models/envelopefieldupdatemanytypeinitialsrequest1.md create mode 100644 docs/models/envelopefieldupdatemanytypeinitialsrequest2.md create mode 100644 docs/models/envelopefieldupdatemanytypenamerequest1.md create mode 100644 docs/models/envelopefieldupdatemanytypenamerequest2.md create mode 100644 docs/models/envelopefieldupdatemanytypenumberrequest1.md create mode 100644 docs/models/envelopefieldupdatemanytypenumberrequest2.md create mode 100644 docs/models/envelopefieldupdatemanytyperadiorequest1.md create mode 100644 docs/models/envelopefieldupdatemanytyperadiorequest2.md create mode 100644 docs/models/envelopefieldupdatemanytyperesponse.md rename docs/models/{fieldcreatedocumentfieldstypesignature.md => envelopefieldupdatemanytypesignaturerequest1.md} (68%) create mode 100644 docs/models/envelopefieldupdatemanytypesignaturerequest2.md create mode 100644 docs/models/envelopefieldupdatemanytypetextrequest1.md create mode 100644 docs/models/envelopefieldupdatemanytypetextrequest2.md create mode 100644 docs/models/envelopefieldupdatemanyunauthorizederror.md create mode 100644 docs/models/envelopefieldupdatemanyunauthorizedissue.md create mode 100644 docs/models/envelopefieldupdatemanyvaluecheckbox.md create mode 100644 docs/models/envelopefieldupdatemanyvaluedropdown.md create mode 100644 docs/models/envelopefieldupdatemanyvalueradio.md create mode 100644 docs/models/envelopefieldupdatemanyvalueresponse1.md create mode 100644 docs/models/envelopefieldupdatemanyvalueresponse2.md create mode 100644 docs/models/envelopefieldupdatemanyvalueresponse3.md create mode 100644 docs/models/envelopefieldupdatemanyverticalalignnumber.md create mode 100644 docs/models/envelopefieldupdatemanyverticalalignresponse1.md create mode 100644 docs/models/envelopefieldupdatemanyverticalalignresponse2.md create mode 100644 docs/models/envelopefieldupdatemanyverticalaligntext.md create mode 100644 docs/models/envelopegetaccessauth.md create mode 100644 docs/models/envelopegetactionauth.md create mode 100644 docs/models/envelopegetauthoptions.md create mode 100644 docs/models/envelopegetbadrequesterror.md create mode 100644 docs/models/envelopegetbadrequestissue.md create mode 100644 docs/models/envelopegetdirection1.md create mode 100644 docs/models/envelopegetdirection2.md create mode 100644 docs/models/envelopegetdirectlink.md create mode 100644 docs/models/envelopegetdistributionmethod.md create mode 100644 docs/models/envelopegetdocumentmeta.md create mode 100644 docs/models/envelopegetemailsettings.md create mode 100644 docs/models/envelopegetenvelopeitem.md create mode 100644 docs/models/envelopegetfield.md create mode 100644 docs/models/envelopegetfieldmetacheckbox.md create mode 100644 docs/models/envelopegetfieldmetadate.md create mode 100644 docs/models/envelopegetfieldmetadropdown.md create mode 100644 docs/models/envelopegetfieldmetaemail.md create mode 100644 docs/models/envelopegetfieldmetainitials.md create mode 100644 docs/models/envelopegetfieldmetaname.md create mode 100644 docs/models/envelopegetfieldmetanumber.md create mode 100644 docs/models/envelopegetfieldmetaradio.md rename docs/models/{prefillfieldcheckbox.md => envelopegetfieldmetasignature.md} (55%) create mode 100644 docs/models/envelopegetfieldmetatext.md create mode 100644 docs/models/envelopegetfieldmetaunion.md create mode 100644 docs/models/envelopegetfieldtype.md create mode 100644 docs/models/envelopegetforbiddenerror.md create mode 100644 docs/models/envelopegetforbiddenissue.md create mode 100644 docs/models/envelopegetformvalues.md create mode 100644 docs/models/envelopegetglobalaccessauth.md create mode 100644 docs/models/envelopegetglobalactionauth.md create mode 100644 docs/models/envelopegetinternalservererror.md create mode 100644 docs/models/envelopegetinternalservererrorissue.md create mode 100644 docs/models/envelopegetnotfounderror.md create mode 100644 docs/models/envelopegetnotfoundissue.md create mode 100644 docs/models/envelopegetreadstatus.md create mode 100644 docs/models/envelopegetrecipient.md create mode 100644 docs/models/envelopegetrecipientauthoptions.md create mode 100644 docs/models/envelopegetrequest.md create mode 100644 docs/models/envelopegetresponse.md create mode 100644 docs/models/envelopegetrole.md create mode 100644 docs/models/envelopegetsendstatus.md create mode 100644 docs/models/envelopegetsigningorder.md create mode 100644 docs/models/envelopegetsigningstatus.md create mode 100644 docs/models/envelopegetsource.md create mode 100644 docs/models/envelopegetstatus.md create mode 100644 docs/models/envelopegetteam.md create mode 100644 docs/models/envelopegettemplatetype.md create mode 100644 docs/models/envelopegettextalign1.md create mode 100644 docs/models/envelopegettextalign2.md create mode 100644 docs/models/envelopegettextalign3.md create mode 100644 docs/models/envelopegettextalign4.md create mode 100644 docs/models/envelopegettextalign5.md create mode 100644 docs/models/envelopegettextalign6.md create mode 100644 docs/models/envelopegettype.md create mode 100644 docs/models/envelopegettypecheckbox.md create mode 100644 docs/models/envelopegettypedate.md create mode 100644 docs/models/envelopegettypedropdown.md create mode 100644 docs/models/envelopegettypeemail.md create mode 100644 docs/models/envelopegettypeinitials.md create mode 100644 docs/models/envelopegettypename.md create mode 100644 docs/models/envelopegettypenumber.md create mode 100644 docs/models/envelopegettyperadio.md create mode 100644 docs/models/envelopegettypesignature.md create mode 100644 docs/models/envelopegettypetext.md create mode 100644 docs/models/envelopegetunauthorizederror.md create mode 100644 docs/models/envelopegetunauthorizedissue.md create mode 100644 docs/models/envelopegetuser.md create mode 100644 docs/models/envelopegetvalue1.md create mode 100644 docs/models/envelopegetvalue2.md create mode 100644 docs/models/envelopegetvalue3.md create mode 100644 docs/models/envelopegetverticalalign1.md create mode 100644 docs/models/envelopegetverticalalign2.md create mode 100644 docs/models/envelopegetvisibility.md create mode 100644 docs/models/envelopeitemcreatemanybadrequesterror.md create mode 100644 docs/models/envelopeitemcreatemanybadrequestissue.md create mode 100644 docs/models/envelopeitemcreatemanydata.md create mode 100644 docs/models/envelopeitemcreatemanyfile.md create mode 100644 docs/models/envelopeitemcreatemanyforbiddenerror.md create mode 100644 docs/models/envelopeitemcreatemanyforbiddenissue.md rename docs/models/{documentresenddocumentinternalservererror.md => envelopeitemcreatemanyinternalservererror.md} (93%) create mode 100644 docs/models/envelopeitemcreatemanyinternalservererrorissue.md create mode 100644 docs/models/envelopeitemcreatemanypayload.md rename docs/models/{documentsenddocumentrequest.md => envelopeitemcreatemanyrequest.md} (66%) create mode 100644 docs/models/envelopeitemcreatemanyresponse.md create mode 100644 docs/models/envelopeitemcreatemanyunauthorizederror.md create mode 100644 docs/models/envelopeitemcreatemanyunauthorizedissue.md create mode 100644 docs/models/envelopeitemdeletebadrequesterror.md create mode 100644 docs/models/envelopeitemdeletebadrequestissue.md create mode 100644 docs/models/envelopeitemdeleteforbiddenerror.md create mode 100644 docs/models/envelopeitemdeleteforbiddenissue.md create mode 100644 docs/models/envelopeitemdeleteinternalservererror.md create mode 100644 docs/models/envelopeitemdeleteinternalservererrorissue.md create mode 100644 docs/models/envelopeitemdeleterequest.md create mode 100644 docs/models/envelopeitemdeleteresponse.md create mode 100644 docs/models/envelopeitemdeleteunauthorizederror.md create mode 100644 docs/models/envelopeitemdeleteunauthorizedissue.md create mode 100644 docs/models/envelopeitemdownloadbadrequesterror.md create mode 100644 docs/models/envelopeitemdownloadbadrequestissue.md create mode 100644 docs/models/envelopeitemdownloadforbiddenerror.md create mode 100644 docs/models/envelopeitemdownloadforbiddenissue.md create mode 100644 docs/models/envelopeitemdownloadinternalservererror.md create mode 100644 docs/models/envelopeitemdownloadinternalservererrorissue.md create mode 100644 docs/models/envelopeitemdownloadnotfounderror.md create mode 100644 docs/models/envelopeitemdownloadnotfoundissue.md create mode 100644 docs/models/envelopeitemdownloadrequest.md create mode 100644 docs/models/envelopeitemdownloadresponse.md create mode 100644 docs/models/envelopeitemdownloadunauthorizederror.md create mode 100644 docs/models/envelopeitemdownloadunauthorizedissue.md create mode 100644 docs/models/envelopeitemdownloadversion.md create mode 100644 docs/models/envelopeitemupdatemanybadrequesterror.md create mode 100644 docs/models/envelopeitemupdatemanybadrequestissue.md create mode 100644 docs/models/envelopeitemupdatemanydatarequest.md create mode 100644 docs/models/envelopeitemupdatemanydataresponse.md create mode 100644 docs/models/envelopeitemupdatemanyforbiddenerror.md create mode 100644 docs/models/envelopeitemupdatemanyforbiddenissue.md rename docs/models/{documentupdatedocumentauthoptions.md => envelopeitemupdatemanyinternalservererror.md} (60%) create mode 100644 docs/models/envelopeitemupdatemanyinternalservererrorissue.md create mode 100644 docs/models/envelopeitemupdatemanyrequest.md create mode 100644 docs/models/envelopeitemupdatemanyresponse.md create mode 100644 docs/models/envelopeitemupdatemanyunauthorizederror.md create mode 100644 docs/models/envelopeitemupdatemanyunauthorizedissue.md create mode 100644 docs/models/enveloperecipientcreatemanyaccessauthrequest.md create mode 100644 docs/models/enveloperecipientcreatemanyaccessauthresponse.md create mode 100644 docs/models/enveloperecipientcreatemanyactionauthrequest.md create mode 100644 docs/models/enveloperecipientcreatemanyactionauthresponse.md create mode 100644 docs/models/enveloperecipientcreatemanyauthoptions.md create mode 100644 docs/models/enveloperecipientcreatemanybadrequesterror.md create mode 100644 docs/models/enveloperecipientcreatemanybadrequestissue.md create mode 100644 docs/models/enveloperecipientcreatemanydatarequest.md create mode 100644 docs/models/enveloperecipientcreatemanydataresponse.md create mode 100644 docs/models/enveloperecipientcreatemanyforbiddenerror.md create mode 100644 docs/models/enveloperecipientcreatemanyforbiddenissue.md create mode 100644 docs/models/enveloperecipientcreatemanyinternalservererror.md create mode 100644 docs/models/enveloperecipientcreatemanyinternalservererrorissue.md create mode 100644 docs/models/enveloperecipientcreatemanyreadstatus.md create mode 100644 docs/models/enveloperecipientcreatemanyrequest.md create mode 100644 docs/models/enveloperecipientcreatemanyresponse.md create mode 100644 docs/models/enveloperecipientcreatemanyrolerequest.md create mode 100644 docs/models/enveloperecipientcreatemanyroleresponse.md create mode 100644 docs/models/enveloperecipientcreatemanysendstatus.md create mode 100644 docs/models/enveloperecipientcreatemanysigningstatus.md create mode 100644 docs/models/enveloperecipientcreatemanyunauthorizederror.md create mode 100644 docs/models/enveloperecipientcreatemanyunauthorizedissue.md create mode 100644 docs/models/enveloperecipientdeletebadrequesterror.md create mode 100644 docs/models/enveloperecipientdeletebadrequestissue.md create mode 100644 docs/models/enveloperecipientdeleteforbiddenerror.md create mode 100644 docs/models/enveloperecipientdeleteforbiddenissue.md create mode 100644 docs/models/enveloperecipientdeleteinternalservererror.md create mode 100644 docs/models/enveloperecipientdeleteinternalservererrorissue.md create mode 100644 docs/models/enveloperecipientdeleterequest.md create mode 100644 docs/models/enveloperecipientdeleteresponse.md create mode 100644 docs/models/enveloperecipientdeleteunauthorizederror.md create mode 100644 docs/models/enveloperecipientdeleteunauthorizedissue.md create mode 100644 docs/models/enveloperecipientgetaccessauth.md create mode 100644 docs/models/enveloperecipientgetactionauth.md create mode 100644 docs/models/enveloperecipientgetauthoptions.md create mode 100644 docs/models/enveloperecipientgetbadrequesterror.md create mode 100644 docs/models/enveloperecipientgetbadrequestissue.md create mode 100644 docs/models/enveloperecipientgetdirection1.md create mode 100644 docs/models/enveloperecipientgetdirection2.md create mode 100644 docs/models/enveloperecipientgetfield.md create mode 100644 docs/models/enveloperecipientgetfieldmetacheckbox.md create mode 100644 docs/models/enveloperecipientgetfieldmetadate.md create mode 100644 docs/models/enveloperecipientgetfieldmetadropdown.md create mode 100644 docs/models/enveloperecipientgetfieldmetaemail.md create mode 100644 docs/models/enveloperecipientgetfieldmetainitials.md create mode 100644 docs/models/enveloperecipientgetfieldmetaname.md create mode 100644 docs/models/enveloperecipientgetfieldmetanumber.md create mode 100644 docs/models/enveloperecipientgetfieldmetaradio.md create mode 100644 docs/models/enveloperecipientgetfieldmetasignature.md create mode 100644 docs/models/enveloperecipientgetfieldmetatext.md create mode 100644 docs/models/enveloperecipientgetfieldmetaunion.md create mode 100644 docs/models/enveloperecipientgetforbiddenerror.md create mode 100644 docs/models/enveloperecipientgetforbiddenissue.md create mode 100644 docs/models/enveloperecipientgetinternalservererror.md create mode 100644 docs/models/enveloperecipientgetinternalservererrorissue.md create mode 100644 docs/models/enveloperecipientgetnotfounderror.md create mode 100644 docs/models/enveloperecipientgetnotfoundissue.md create mode 100644 docs/models/enveloperecipientgetreadstatus.md create mode 100644 docs/models/enveloperecipientgetrequest.md create mode 100644 docs/models/enveloperecipientgetresponse.md create mode 100644 docs/models/enveloperecipientgetrole.md create mode 100644 docs/models/enveloperecipientgetsendstatus.md create mode 100644 docs/models/enveloperecipientgetsigningstatus.md create mode 100644 docs/models/enveloperecipientgettextalign1.md create mode 100644 docs/models/enveloperecipientgettextalign2.md create mode 100644 docs/models/enveloperecipientgettextalign3.md create mode 100644 docs/models/enveloperecipientgettextalign4.md create mode 100644 docs/models/enveloperecipientgettextalign5.md create mode 100644 docs/models/enveloperecipientgettextalign6.md create mode 100644 docs/models/enveloperecipientgettype.md create mode 100644 docs/models/enveloperecipientgettypecheckbox.md create mode 100644 docs/models/enveloperecipientgettypedate.md create mode 100644 docs/models/enveloperecipientgettypedropdown.md create mode 100644 docs/models/enveloperecipientgettypeemail.md create mode 100644 docs/models/enveloperecipientgettypeinitials.md create mode 100644 docs/models/enveloperecipientgettypename.md create mode 100644 docs/models/enveloperecipientgettypenumber.md create mode 100644 docs/models/enveloperecipientgettyperadio.md create mode 100644 docs/models/enveloperecipientgettypesignature.md create mode 100644 docs/models/enveloperecipientgettypetext.md create mode 100644 docs/models/enveloperecipientgetunauthorizederror.md create mode 100644 docs/models/enveloperecipientgetunauthorizedissue.md create mode 100644 docs/models/enveloperecipientgetvalue1.md create mode 100644 docs/models/enveloperecipientgetvalue2.md create mode 100644 docs/models/enveloperecipientgetvalue3.md create mode 100644 docs/models/enveloperecipientgetverticalalign1.md create mode 100644 docs/models/enveloperecipientgetverticalalign2.md create mode 100644 docs/models/enveloperecipientupdatemanyaccessauthrequest.md create mode 100644 docs/models/enveloperecipientupdatemanyaccessauthresponse.md create mode 100644 docs/models/enveloperecipientupdatemanyactionauthrequest.md create mode 100644 docs/models/enveloperecipientupdatemanyactionauthresponse.md create mode 100644 docs/models/enveloperecipientupdatemanyauthoptions.md create mode 100644 docs/models/enveloperecipientupdatemanybadrequesterror.md create mode 100644 docs/models/enveloperecipientupdatemanybadrequestissue.md create mode 100644 docs/models/enveloperecipientupdatemanydatarequest.md create mode 100644 docs/models/enveloperecipientupdatemanydataresponse.md create mode 100644 docs/models/enveloperecipientupdatemanyforbiddenerror.md create mode 100644 docs/models/enveloperecipientupdatemanyforbiddenissue.md create mode 100644 docs/models/enveloperecipientupdatemanyinternalservererror.md create mode 100644 docs/models/enveloperecipientupdatemanyinternalservererrorissue.md create mode 100644 docs/models/enveloperecipientupdatemanyreadstatus.md create mode 100644 docs/models/enveloperecipientupdatemanyrequest.md create mode 100644 docs/models/enveloperecipientupdatemanyresponse.md create mode 100644 docs/models/enveloperecipientupdatemanyrolerequest.md create mode 100644 docs/models/enveloperecipientupdatemanyroleresponse.md create mode 100644 docs/models/enveloperecipientupdatemanysendstatus.md create mode 100644 docs/models/enveloperecipientupdatemanysigningstatus.md create mode 100644 docs/models/enveloperecipientupdatemanyunauthorizederror.md create mode 100644 docs/models/enveloperecipientupdatemanyunauthorizedissue.md create mode 100644 docs/models/enveloperedistributebadrequesterror.md create mode 100644 docs/models/enveloperedistributebadrequestissue.md create mode 100644 docs/models/enveloperedistributeforbiddenerror.md create mode 100644 docs/models/enveloperedistributeforbiddenissue.md create mode 100644 docs/models/enveloperedistributeinternalservererror.md create mode 100644 docs/models/enveloperedistributeinternalservererrorissue.md create mode 100644 docs/models/enveloperedistributerequest.md create mode 100644 docs/models/enveloperedistributeresponse.md create mode 100644 docs/models/enveloperedistributeunauthorizederror.md create mode 100644 docs/models/enveloperedistributeunauthorizedissue.md create mode 100644 docs/models/envelopeupdateauthoptions.md create mode 100644 docs/models/envelopeupdatebadrequesterror.md create mode 100644 docs/models/envelopeupdatebadrequestissue.md create mode 100644 docs/models/envelopeupdatedata.md create mode 100644 docs/models/envelopeupdatedataglobalaccessauth.md create mode 100644 docs/models/envelopeupdatedataglobalactionauth.md create mode 100644 docs/models/envelopeupdatedatavisibility.md create mode 100644 docs/models/envelopeupdatedateformat.md create mode 100644 docs/models/envelopeupdatedistributionmethod.md create mode 100644 docs/models/envelopeupdateemailsettings.md create mode 100644 docs/models/envelopeupdateforbiddenerror.md create mode 100644 docs/models/envelopeupdateforbiddenissue.md create mode 100644 docs/models/envelopeupdateformvalues.md create mode 100644 docs/models/envelopeupdateglobalaccessauthresponse.md create mode 100644 docs/models/envelopeupdateglobalactionauthresponse.md create mode 100644 docs/models/envelopeupdateinternalservererror.md create mode 100644 docs/models/envelopeupdateinternalservererrorissue.md create mode 100644 docs/models/envelopeupdatelanguage.md create mode 100644 docs/models/envelopeupdatemeta.md create mode 100644 docs/models/envelopeupdaterequest.md create mode 100644 docs/models/envelopeupdateresponse.md create mode 100644 docs/models/envelopeupdatesigningorder.md create mode 100644 docs/models/envelopeupdatesource.md create mode 100644 docs/models/envelopeupdatestatus.md create mode 100644 docs/models/envelopeupdatetemplatetype.md create mode 100644 docs/models/envelopeupdatetype.md create mode 100644 docs/models/envelopeupdateunauthorizederror.md create mode 100644 docs/models/envelopeupdateunauthorizedissue.md create mode 100644 docs/models/envelopeupdatevisibilityresponse.md rename docs/models/{templatedocumentdata.md => envelopeuseattachment.md} (72%) create mode 100644 docs/models/envelopeusebadrequesterror.md create mode 100644 docs/models/envelopeusebadrequestissue.md create mode 100644 docs/models/envelopeusecustomdocumentdatum.md create mode 100644 docs/models/envelopeusedateformat.md create mode 100644 docs/models/envelopeusedistributionmethod.md create mode 100644 docs/models/envelopeuseemailsettings.md create mode 100644 docs/models/envelopeusefile.md create mode 100644 docs/models/envelopeuseforbiddenerror.md create mode 100644 docs/models/envelopeuseforbiddenissue.md create mode 100644 docs/models/envelopeuseidentifier.md create mode 100644 docs/models/envelopeuseinternalservererror.md create mode 100644 docs/models/envelopeuseinternalservererrorissue.md create mode 100644 docs/models/envelopeuselanguage.md create mode 100644 docs/models/envelopeusepayload.md create mode 100644 docs/models/envelopeuseprefillfieldcheckbox.md create mode 100644 docs/models/envelopeuseprefillfielddate.md create mode 100644 docs/models/envelopeuseprefillfielddropdown.md rename docs/models/{prefillfieldradio.md => envelopeuseprefillfieldnumber.md} (77%) rename docs/models/{prefillfieldtext.md => envelopeuseprefillfieldradio.md} (78%) create mode 100644 docs/models/envelopeuseprefillfieldtext.md create mode 100644 docs/models/envelopeuseprefillfieldunion.md create mode 100644 docs/models/envelopeuserecipient.md create mode 100644 docs/models/envelopeuserequest.md create mode 100644 docs/models/envelopeuseresponse.md create mode 100644 docs/models/envelopeusetypecheckbox.md create mode 100644 docs/models/envelopeusetypedate.md create mode 100644 docs/models/envelopeusetypedropdown.md create mode 100644 docs/models/envelopeusetypelink.md create mode 100644 docs/models/envelopeusetypenumber.md create mode 100644 docs/models/envelopeusetyperadio.md create mode 100644 docs/models/envelopeusetypetext.md create mode 100644 docs/models/envelopeuseunauthorizederror.md create mode 100644 docs/models/envelopeuseunauthorizedissue.md create mode 100644 docs/models/fieldcreatedocumentfielddirectioncheckbox.md create mode 100644 docs/models/fieldcreatedocumentfielddirectionradio.md create mode 100644 docs/models/fieldcreatedocumentfielddirectionresponse1.md create mode 100644 docs/models/fieldcreatedocumentfielddirectionresponse2.md create mode 100644 docs/models/fieldcreatedocumentfieldfieldmetasignaturerequest.md create mode 100644 docs/models/fieldcreatedocumentfieldfieldmetasignatureresponse.md create mode 100644 docs/models/fieldcreatedocumentfieldfieldmetatypesignature.md create mode 100644 docs/models/fieldcreatedocumentfieldforbiddenerror.md create mode 100644 docs/models/fieldcreatedocumentfieldforbiddenissue.md create mode 100644 docs/models/fieldcreatedocumentfieldsdirectioncheckbox.md create mode 100644 docs/models/fieldcreatedocumentfieldsdirectionradio.md create mode 100644 docs/models/fieldcreatedocumentfieldsdirectionresponse1.md create mode 100644 docs/models/fieldcreatedocumentfieldsdirectionresponse2.md create mode 100644 docs/models/fieldcreatedocumentfieldsfieldmetasignaturerequest.md create mode 100644 docs/models/fieldcreatedocumentfieldsfieldmetasignatureresponse.md create mode 100644 docs/models/fieldcreatedocumentfieldsfieldmetatypesignature.md create mode 100644 docs/models/fieldcreatedocumentfieldsforbiddenerror.md create mode 100644 docs/models/fieldcreatedocumentfieldsforbiddenissue.md create mode 100644 docs/models/fieldcreatedocumentfieldstypesignaturerequest1.md create mode 100644 docs/models/fieldcreatedocumentfieldstypesignaturerequest2.md create mode 100644 docs/models/fieldcreatedocumentfieldsunauthorizederror.md create mode 100644 docs/models/fieldcreatedocumentfieldsunauthorizedissue.md create mode 100644 docs/models/fieldcreatedocumentfieldsverticalalignnumber.md create mode 100644 docs/models/fieldcreatedocumentfieldsverticalalignresponse1.md create mode 100644 docs/models/fieldcreatedocumentfieldsverticalalignresponse2.md create mode 100644 docs/models/fieldcreatedocumentfieldsverticalaligntext.md rename docs/models/{fieldcreatedocumentfieldtypesignature.md => fieldcreatedocumentfieldtypesignaturerequest1.md} (68%) create mode 100644 docs/models/fieldcreatedocumentfieldtypesignaturerequest2.md create mode 100644 docs/models/fieldcreatedocumentfieldunauthorizederror.md create mode 100644 docs/models/fieldcreatedocumentfieldunauthorizedissue.md create mode 100644 docs/models/fieldcreatedocumentfieldverticalalignnumber.md create mode 100644 docs/models/fieldcreatedocumentfieldverticalalignresponse1.md create mode 100644 docs/models/fieldcreatedocumentfieldverticalalignresponse2.md create mode 100644 docs/models/fieldcreatedocumentfieldverticalaligntext.md create mode 100644 docs/models/fieldcreatetemplatefielddirectioncheckbox.md create mode 100644 docs/models/fieldcreatetemplatefielddirectionradio.md create mode 100644 docs/models/fieldcreatetemplatefielddirectionresponse1.md create mode 100644 docs/models/fieldcreatetemplatefielddirectionresponse2.md create mode 100644 docs/models/fieldcreatetemplatefieldfieldmetasignaturerequest.md create mode 100644 docs/models/fieldcreatetemplatefieldfieldmetasignatureresponse.md create mode 100644 docs/models/fieldcreatetemplatefieldfieldmetatypesignature.md create mode 100644 docs/models/fieldcreatetemplatefieldforbiddenerror.md create mode 100644 docs/models/fieldcreatetemplatefieldforbiddenissue.md create mode 100644 docs/models/fieldcreatetemplatefieldsdirectioncheckbox.md create mode 100644 docs/models/fieldcreatetemplatefieldsdirectionradio.md create mode 100644 docs/models/fieldcreatetemplatefieldsdirectionresponse1.md create mode 100644 docs/models/fieldcreatetemplatefieldsdirectionresponse2.md create mode 100644 docs/models/fieldcreatetemplatefieldsfieldmetasignaturerequest.md create mode 100644 docs/models/fieldcreatetemplatefieldsfieldmetasignatureresponse.md create mode 100644 docs/models/fieldcreatetemplatefieldsfieldmetatypesignature.md create mode 100644 docs/models/fieldcreatetemplatefieldsforbiddenerror.md create mode 100644 docs/models/fieldcreatetemplatefieldsforbiddenissue.md create mode 100644 docs/models/fieldcreatetemplatefieldstypesignaturerequest1.md create mode 100644 docs/models/fieldcreatetemplatefieldstypesignaturerequest2.md create mode 100644 docs/models/fieldcreatetemplatefieldsunauthorizederror.md create mode 100644 docs/models/fieldcreatetemplatefieldsunauthorizedissue.md create mode 100644 docs/models/fieldcreatetemplatefieldsverticalalignnumber.md create mode 100644 docs/models/fieldcreatetemplatefieldsverticalalignresponse1.md create mode 100644 docs/models/fieldcreatetemplatefieldsverticalalignresponse2.md create mode 100644 docs/models/fieldcreatetemplatefieldsverticalaligntext.md rename docs/models/{documentcreatedocumenttemporarytypesignature.md => fieldcreatetemplatefieldtypesignaturerequest1.md} (68%) create mode 100644 docs/models/fieldcreatetemplatefieldtypesignaturerequest2.md create mode 100644 docs/models/fieldcreatetemplatefieldunauthorizederror.md create mode 100644 docs/models/fieldcreatetemplatefieldunauthorizedissue.md create mode 100644 docs/models/fieldcreatetemplatefieldverticalalignnumber.md create mode 100644 docs/models/fieldcreatetemplatefieldverticalalignresponse1.md create mode 100644 docs/models/fieldcreatetemplatefieldverticalalignresponse2.md create mode 100644 docs/models/fieldcreatetemplatefieldverticalaligntext.md create mode 100644 docs/models/fielddeletedocumentfieldforbiddenerror.md create mode 100644 docs/models/fielddeletedocumentfieldforbiddenissue.md create mode 100644 docs/models/fielddeletedocumentfieldunauthorizederror.md create mode 100644 docs/models/fielddeletedocumentfieldunauthorizedissue.md create mode 100644 docs/models/fielddeletetemplatefieldforbiddenerror.md create mode 100644 docs/models/fielddeletetemplatefieldforbiddenissue.md create mode 100644 docs/models/fielddeletetemplatefieldunauthorizederror.md create mode 100644 docs/models/fielddeletetemplatefieldunauthorizedissue.md create mode 100644 docs/models/fieldgetdocumentfielddirection1.md create mode 100644 docs/models/fieldgetdocumentfielddirection2.md create mode 100644 docs/models/fieldgetdocumentfieldfieldmetasignature.md create mode 100644 docs/models/fieldgetdocumentfieldforbiddenerror.md create mode 100644 docs/models/fieldgetdocumentfieldforbiddenissue.md create mode 100644 docs/models/fieldgetdocumentfieldtypesignature.md create mode 100644 docs/models/fieldgetdocumentfieldunauthorizederror.md create mode 100644 docs/models/fieldgetdocumentfieldunauthorizedissue.md create mode 100644 docs/models/fieldgetdocumentfieldverticalalign1.md create mode 100644 docs/models/fieldgetdocumentfieldverticalalign2.md create mode 100644 docs/models/fieldgettemplatefielddirection1.md create mode 100644 docs/models/fieldgettemplatefielddirection2.md create mode 100644 docs/models/fieldgettemplatefieldfieldmetasignature.md create mode 100644 docs/models/fieldgettemplatefieldforbiddenerror.md create mode 100644 docs/models/fieldgettemplatefieldforbiddenissue.md create mode 100644 docs/models/fieldgettemplatefieldtypesignature.md create mode 100644 docs/models/fieldgettemplatefieldunauthorizederror.md create mode 100644 docs/models/fieldgettemplatefieldunauthorizedissue.md create mode 100644 docs/models/fieldgettemplatefieldverticalalign1.md create mode 100644 docs/models/fieldgettemplatefieldverticalalign2.md create mode 100644 docs/models/fieldmetadocumentsignature.md create mode 100644 docs/models/fieldupdatedocumentfielddirectioncheckbox.md create mode 100644 docs/models/fieldupdatedocumentfielddirectionradio.md create mode 100644 docs/models/fieldupdatedocumentfielddirectionresponse1.md create mode 100644 docs/models/fieldupdatedocumentfielddirectionresponse2.md create mode 100644 docs/models/fieldupdatedocumentfieldfieldmetasignaturerequest.md create mode 100644 docs/models/fieldupdatedocumentfieldfieldmetasignatureresponse.md create mode 100644 docs/models/fieldupdatedocumentfieldfieldmetatypesignature.md create mode 100644 docs/models/fieldupdatedocumentfieldforbiddenerror.md create mode 100644 docs/models/fieldupdatedocumentfieldforbiddenissue.md create mode 100644 docs/models/fieldupdatedocumentfieldsdirectioncheckbox.md create mode 100644 docs/models/fieldupdatedocumentfieldsdirectionradio.md create mode 100644 docs/models/fieldupdatedocumentfieldsdirectionresponse1.md create mode 100644 docs/models/fieldupdatedocumentfieldsdirectionresponse2.md create mode 100644 docs/models/fieldupdatedocumentfieldsfieldmetasignaturerequest.md create mode 100644 docs/models/fieldupdatedocumentfieldsfieldmetasignatureresponse.md create mode 100644 docs/models/fieldupdatedocumentfieldsfieldmetatypesignature.md create mode 100644 docs/models/fieldupdatedocumentfieldsforbiddenerror.md create mode 100644 docs/models/fieldupdatedocumentfieldsforbiddenissue.md delete mode 100644 docs/models/fieldupdatedocumentfieldstypesignature.md create mode 100644 docs/models/fieldupdatedocumentfieldstypesignaturerequest1.md create mode 100644 docs/models/fieldupdatedocumentfieldstypesignaturerequest2.md create mode 100644 docs/models/fieldupdatedocumentfieldsunauthorizederror.md create mode 100644 docs/models/fieldupdatedocumentfieldsunauthorizedissue.md create mode 100644 docs/models/fieldupdatedocumentfieldsverticalalignnumber.md create mode 100644 docs/models/fieldupdatedocumentfieldsverticalalignresponse1.md create mode 100644 docs/models/fieldupdatedocumentfieldsverticalalignresponse2.md create mode 100644 docs/models/fieldupdatedocumentfieldsverticalaligntext.md create mode 100644 docs/models/fieldupdatedocumentfieldtypesignaturerequest1.md create mode 100644 docs/models/fieldupdatedocumentfieldtypesignaturerequest2.md create mode 100644 docs/models/fieldupdatedocumentfieldunauthorizederror.md create mode 100644 docs/models/fieldupdatedocumentfieldunauthorizedissue.md create mode 100644 docs/models/fieldupdatedocumentfieldverticalalignnumber.md create mode 100644 docs/models/fieldupdatedocumentfieldverticalalignresponse1.md create mode 100644 docs/models/fieldupdatedocumentfieldverticalalignresponse2.md create mode 100644 docs/models/fieldupdatedocumentfieldverticalaligntext.md create mode 100644 docs/models/fieldupdatetemplatefielddirectioncheckbox.md create mode 100644 docs/models/fieldupdatetemplatefielddirectionradio.md create mode 100644 docs/models/fieldupdatetemplatefielddirectionresponse1.md create mode 100644 docs/models/fieldupdatetemplatefielddirectionresponse2.md create mode 100644 docs/models/fieldupdatetemplatefieldfieldmetasignaturerequest.md create mode 100644 docs/models/fieldupdatetemplatefieldfieldmetasignatureresponse.md create mode 100644 docs/models/fieldupdatetemplatefieldfieldmetatypesignature.md create mode 100644 docs/models/fieldupdatetemplatefieldforbiddenerror.md create mode 100644 docs/models/fieldupdatetemplatefieldforbiddenissue.md create mode 100644 docs/models/fieldupdatetemplatefieldsdirectioncheckbox.md create mode 100644 docs/models/fieldupdatetemplatefieldsdirectionradio.md create mode 100644 docs/models/fieldupdatetemplatefieldsdirectionresponse1.md create mode 100644 docs/models/fieldupdatetemplatefieldsdirectionresponse2.md create mode 100644 docs/models/fieldupdatetemplatefieldsfieldmetasignaturerequest.md create mode 100644 docs/models/fieldupdatetemplatefieldsfieldmetasignatureresponse.md create mode 100644 docs/models/fieldupdatetemplatefieldsfieldmetatypesignature.md create mode 100644 docs/models/fieldupdatetemplatefieldsforbiddenerror.md create mode 100644 docs/models/fieldupdatetemplatefieldsforbiddenissue.md delete mode 100644 docs/models/fieldupdatetemplatefieldstypesignature.md create mode 100644 docs/models/fieldupdatetemplatefieldstypesignaturerequest1.md create mode 100644 docs/models/fieldupdatetemplatefieldstypesignaturerequest2.md create mode 100644 docs/models/fieldupdatetemplatefieldsunauthorizederror.md create mode 100644 docs/models/fieldupdatetemplatefieldsunauthorizedissue.md create mode 100644 docs/models/fieldupdatetemplatefieldsverticalalignnumber.md create mode 100644 docs/models/fieldupdatetemplatefieldsverticalalignresponse1.md create mode 100644 docs/models/fieldupdatetemplatefieldsverticalalignresponse2.md create mode 100644 docs/models/fieldupdatetemplatefieldsverticalaligntext.md create mode 100644 docs/models/fieldupdatetemplatefieldtypesignaturerequest1.md create mode 100644 docs/models/fieldupdatetemplatefieldtypesignaturerequest2.md create mode 100644 docs/models/fieldupdatetemplatefieldunauthorizederror.md create mode 100644 docs/models/fieldupdatetemplatefieldunauthorizedissue.md create mode 100644 docs/models/fieldupdatetemplatefieldverticalalignnumber.md create mode 100644 docs/models/fieldupdatetemplatefieldverticalalignresponse1.md create mode 100644 docs/models/fieldupdatetemplatefieldverticalalignresponse2.md create mode 100644 docs/models/fieldupdatetemplatefieldverticalaligntext.md create mode 100644 docs/models/foldercreatefolderbadrequesterror.md create mode 100644 docs/models/foldercreatefolderbadrequestissue.md create mode 100644 docs/models/foldercreatefolderforbiddenerror.md create mode 100644 docs/models/foldercreatefolderforbiddenissue.md create mode 100644 docs/models/foldercreatefolderinternalservererror.md create mode 100644 docs/models/foldercreatefolderinternalservererrorissue.md create mode 100644 docs/models/foldercreatefolderrequest.md create mode 100644 docs/models/foldercreatefolderresponse.md create mode 100644 docs/models/foldercreatefoldertyperequest.md create mode 100644 docs/models/foldercreatefoldertyperesponse.md create mode 100644 docs/models/foldercreatefolderunauthorizederror.md create mode 100644 docs/models/foldercreatefolderunauthorizedissue.md create mode 100644 docs/models/foldercreatefoldervisibility.md create mode 100644 docs/models/folderdeletefolderbadrequesterror.md create mode 100644 docs/models/folderdeletefolderbadrequestissue.md create mode 100644 docs/models/folderdeletefolderforbiddenerror.md create mode 100644 docs/models/folderdeletefolderforbiddenissue.md create mode 100644 docs/models/folderdeletefolderinternalservererror.md create mode 100644 docs/models/folderdeletefolderinternalservererrorissue.md create mode 100644 docs/models/folderdeletefolderrequest.md create mode 100644 docs/models/folderdeletefolderresponse.md create mode 100644 docs/models/folderdeletefolderunauthorizederror.md create mode 100644 docs/models/folderdeletefolderunauthorizedissue.md create mode 100644 docs/models/folderfindfoldersbadrequesterror.md create mode 100644 docs/models/folderfindfoldersbadrequestissue.md create mode 100644 docs/models/folderfindfoldersdata.md create mode 100644 docs/models/folderfindfoldersdatatype.md create mode 100644 docs/models/folderfindfoldersforbiddenerror.md create mode 100644 docs/models/folderfindfoldersforbiddenissue.md create mode 100644 docs/models/folderfindfoldersinternalservererror.md create mode 100644 docs/models/folderfindfoldersinternalservererrorissue.md create mode 100644 docs/models/folderfindfoldersnotfounderror.md create mode 100644 docs/models/folderfindfoldersnotfoundissue.md create mode 100644 docs/models/folderfindfoldersqueryparamtype.md create mode 100644 docs/models/folderfindfoldersrequest.md create mode 100644 docs/models/folderfindfoldersresponse.md create mode 100644 docs/models/folderfindfoldersunauthorizederror.md create mode 100644 docs/models/folderfindfoldersunauthorizedissue.md create mode 100644 docs/models/folderfindfoldersvisibility.md create mode 100644 docs/models/folderupdatefolderbadrequesterror.md create mode 100644 docs/models/folderupdatefolderbadrequestissue.md create mode 100644 docs/models/folderupdatefolderdata.md create mode 100644 docs/models/folderupdatefolderdatavisibility.md create mode 100644 docs/models/folderupdatefolderforbiddenerror.md create mode 100644 docs/models/folderupdatefolderforbiddenissue.md create mode 100644 docs/models/folderupdatefolderinternalservererror.md create mode 100644 docs/models/folderupdatefolderinternalservererrorissue.md create mode 100644 docs/models/folderupdatefolderrequest.md create mode 100644 docs/models/folderupdatefolderresponse.md create mode 100644 docs/models/folderupdatefoldertype.md create mode 100644 docs/models/folderupdatefolderunauthorizederror.md create mode 100644 docs/models/folderupdatefolderunauthorizedissue.md create mode 100644 docs/models/folderupdatefoldervisibilityresponse.md create mode 100644 docs/models/override.md delete mode 100644 docs/models/prefillfield.md delete mode 100644 docs/models/prefillfielddate.md delete mode 100644 docs/models/prefillfieldnumber.md create mode 100644 docs/models/recipientcreatedocumentrecipientforbiddenerror.md create mode 100644 docs/models/recipientcreatedocumentrecipientforbiddenissue.md create mode 100644 docs/models/recipientcreatedocumentrecipientsforbiddenerror.md create mode 100644 docs/models/recipientcreatedocumentrecipientsforbiddenissue.md rename docs/models/{documentgetdocumentwithdetailsbyidauthoptions.md => recipientcreatedocumentrecipientsunauthorizederror.md} (59%) create mode 100644 docs/models/recipientcreatedocumentrecipientsunauthorizedissue.md rename docs/models/{documentgetdocumentwithdetailsbyidbadrequesterror.md => recipientcreatedocumentrecipientunauthorizederror.md} (92%) rename docs/models/{documentduplicatedocumentinternalservererrorissue.md => recipientcreatedocumentrecipientunauthorizedissue.md} (83%) create mode 100644 docs/models/recipientcreatetemplaterecipientforbiddenerror.md create mode 100644 docs/models/recipientcreatetemplaterecipientforbiddenissue.md create mode 100644 docs/models/recipientcreatetemplaterecipientsforbiddenerror.md create mode 100644 docs/models/recipientcreatetemplaterecipientsforbiddenissue.md rename docs/models/{documentgetdocumentwithdetailsbyidinternalservererror.md => recipientcreatetemplaterecipientsunauthorizederror.md} (53%) create mode 100644 docs/models/recipientcreatetemplaterecipientsunauthorizedissue.md rename docs/models/{documentduplicatedocumentinternalservererror.md => recipientcreatetemplaterecipientunauthorizederror.md} (92%) create mode 100644 docs/models/recipientcreatetemplaterecipientunauthorizedissue.md create mode 100644 docs/models/recipientdeletedocumentrecipientforbiddenerror.md create mode 100644 docs/models/recipientdeletedocumentrecipientforbiddenissue.md create mode 100644 docs/models/recipientdeletedocumentrecipientunauthorizederror.md create mode 100644 docs/models/recipientdeletedocumentrecipientunauthorizedissue.md create mode 100644 docs/models/recipientdeletetemplaterecipientforbiddenerror.md create mode 100644 docs/models/recipientdeletetemplaterecipientforbiddenissue.md create mode 100644 docs/models/recipientdeletetemplaterecipientunauthorizederror.md create mode 100644 docs/models/recipientdeletetemplaterecipientunauthorizedissue.md create mode 100644 docs/models/recipientgetdocumentrecipientdirection1.md create mode 100644 docs/models/recipientgetdocumentrecipientdirection2.md create mode 100644 docs/models/recipientgetdocumentrecipientfieldmetasignature.md create mode 100644 docs/models/recipientgetdocumentrecipientforbiddenerror.md create mode 100644 docs/models/recipientgetdocumentrecipientforbiddenissue.md create mode 100644 docs/models/recipientgetdocumentrecipienttypesignature.md create mode 100644 docs/models/recipientgetdocumentrecipientunauthorizederror.md create mode 100644 docs/models/recipientgetdocumentrecipientunauthorizedissue.md create mode 100644 docs/models/recipientgetdocumentrecipientverticalalign1.md create mode 100644 docs/models/recipientgetdocumentrecipientverticalalign2.md create mode 100644 docs/models/recipientgettemplaterecipientdirection1.md create mode 100644 docs/models/recipientgettemplaterecipientdirection2.md create mode 100644 docs/models/recipientgettemplaterecipientfieldmetasignature.md create mode 100644 docs/models/recipientgettemplaterecipientforbiddenerror.md create mode 100644 docs/models/recipientgettemplaterecipientforbiddenissue.md create mode 100644 docs/models/recipientgettemplaterecipienttypesignature.md create mode 100644 docs/models/recipientgettemplaterecipientunauthorizederror.md create mode 100644 docs/models/recipientgettemplaterecipientunauthorizedissue.md create mode 100644 docs/models/recipientgettemplaterecipientverticalalign1.md create mode 100644 docs/models/recipientgettemplaterecipientverticalalign2.md create mode 100644 docs/models/recipientupdatedocumentrecipientdirection1.md create mode 100644 docs/models/recipientupdatedocumentrecipientdirection2.md create mode 100644 docs/models/recipientupdatedocumentrecipientfieldmetasignature.md create mode 100644 docs/models/recipientupdatedocumentrecipientforbiddenerror.md create mode 100644 docs/models/recipientupdatedocumentrecipientforbiddenissue.md create mode 100644 docs/models/recipientupdatedocumentrecipientsdirection1.md create mode 100644 docs/models/recipientupdatedocumentrecipientsdirection2.md create mode 100644 docs/models/recipientupdatedocumentrecipientsfieldmetasignature.md create mode 100644 docs/models/recipientupdatedocumentrecipientsforbiddenerror.md create mode 100644 docs/models/recipientupdatedocumentrecipientsforbiddenissue.md create mode 100644 docs/models/recipientupdatedocumentrecipientstypesignature.md create mode 100644 docs/models/recipientupdatedocumentrecipientsunauthorizederror.md create mode 100644 docs/models/recipientupdatedocumentrecipientsunauthorizedissue.md create mode 100644 docs/models/recipientupdatedocumentrecipientsverticalalign1.md create mode 100644 docs/models/recipientupdatedocumentrecipientsverticalalign2.md create mode 100644 docs/models/recipientupdatedocumentrecipienttypesignature.md create mode 100644 docs/models/recipientupdatedocumentrecipientunauthorizederror.md create mode 100644 docs/models/recipientupdatedocumentrecipientunauthorizedissue.md create mode 100644 docs/models/recipientupdatedocumentrecipientverticalalign1.md create mode 100644 docs/models/recipientupdatedocumentrecipientverticalalign2.md create mode 100644 docs/models/recipientupdatetemplaterecipientdirection1.md create mode 100644 docs/models/recipientupdatetemplaterecipientdirection2.md create mode 100644 docs/models/recipientupdatetemplaterecipientfieldmetasignature.md create mode 100644 docs/models/recipientupdatetemplaterecipientforbiddenerror.md create mode 100644 docs/models/recipientupdatetemplaterecipientforbiddenissue.md create mode 100644 docs/models/recipientupdatetemplaterecipientsdirection1.md create mode 100644 docs/models/recipientupdatetemplaterecipientsdirection2.md create mode 100644 docs/models/recipientupdatetemplaterecipientsfieldmetasignature.md create mode 100644 docs/models/recipientupdatetemplaterecipientsforbiddenerror.md create mode 100644 docs/models/recipientupdatetemplaterecipientsforbiddenissue.md create mode 100644 docs/models/recipientupdatetemplaterecipientstypesignature.md create mode 100644 docs/models/recipientupdatetemplaterecipientsunauthorizederror.md create mode 100644 docs/models/recipientupdatetemplaterecipientsunauthorizedissue.md create mode 100644 docs/models/recipientupdatetemplaterecipientsverticalalign1.md create mode 100644 docs/models/recipientupdatetemplaterecipientsverticalalign2.md create mode 100644 docs/models/recipientupdatetemplaterecipienttypesignature.md create mode 100644 docs/models/recipientupdatetemplaterecipientunauthorizederror.md create mode 100644 docs/models/recipientupdatetemplaterecipientunauthorizedissue.md create mode 100644 docs/models/recipientupdatetemplaterecipientverticalalign1.md create mode 100644 docs/models/recipientupdatetemplaterecipientverticalalign2.md create mode 100644 docs/models/templatecreatedocumentfromtemplatecustomdocumentdatum.md create mode 100644 docs/models/templatecreatedocumentfromtemplatedirection1.md create mode 100644 docs/models/templatecreatedocumentfromtemplatedirection2.md create mode 100644 docs/models/templatecreatedocumentfromtemplateenvelopeitem.md create mode 100644 docs/models/templatecreatedocumentfromtemplatefieldmetasignature.md create mode 100644 docs/models/templatecreatedocumentfromtemplateforbiddenerror.md create mode 100644 docs/models/templatecreatedocumentfromtemplateforbiddenissue.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldcheckbox.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfielddate.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfielddropdown.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldnumber.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldradio.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldtext.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldtypecheckbox.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldtypedate.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldtypedropdown.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldtypenumber.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldtyperadio.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldtypetext.md create mode 100644 docs/models/templatecreatedocumentfromtemplateprefillfieldunion.md create mode 100644 docs/models/templatecreatedocumentfromtemplatetypesignature.md create mode 100644 docs/models/templatecreatedocumentfromtemplateunauthorizederror.md create mode 100644 docs/models/templatecreatedocumentfromtemplateunauthorizedissue.md create mode 100644 docs/models/templatecreatedocumentfromtemplateverticalalign1.md create mode 100644 docs/models/templatecreatedocumentfromtemplateverticalalign2.md create mode 100644 docs/models/templatecreatetemplateattachment.md create mode 100644 docs/models/templatecreatetemplatebadrequesterror.md create mode 100644 docs/models/templatecreatetemplatebadrequestissue.md create mode 100644 docs/models/templatecreatetemplatedateformat.md create mode 100644 docs/models/templatecreatetemplatedirectlinkforbiddenerror.md create mode 100644 docs/models/templatecreatetemplatedirectlinkforbiddenissue.md create mode 100644 docs/models/templatecreatetemplatedirectlinkunauthorizederror.md create mode 100644 docs/models/templatecreatetemplatedirectlinkunauthorizedissue.md create mode 100644 docs/models/templatecreatetemplatedistributionmethod.md create mode 100644 docs/models/templatecreatetemplateemailsettings.md create mode 100644 docs/models/templatecreatetemplatefile.md create mode 100644 docs/models/templatecreatetemplateforbiddenerror.md create mode 100644 docs/models/templatecreatetemplateforbiddenissue.md create mode 100644 docs/models/templatecreatetemplateglobalaccessauth.md create mode 100644 docs/models/templatecreatetemplateglobalactionauth.md create mode 100644 docs/models/templatecreatetemplateinternalservererror.md create mode 100644 docs/models/templatecreatetemplateinternalservererrorissue.md create mode 100644 docs/models/templatecreatetemplatelanguage.md rename docs/models/{documentupdatedocumentmeta.md => templatecreatetemplatemeta.md} (63%) create mode 100644 docs/models/templatecreatetemplatepayload.md create mode 100644 docs/models/templatecreatetemplaterequest.md create mode 100644 docs/models/templatecreatetemplateresponse.md create mode 100644 docs/models/templatecreatetemplatesigningorder.md create mode 100644 docs/models/templatecreatetemplatetemporaryaccessauth.md create mode 100644 docs/models/templatecreatetemplatetemporaryactionauth.md create mode 100644 docs/models/templatecreatetemplatetemporaryattachment.md create mode 100644 docs/models/templatecreatetemplatetemporaryauthoptions.md create mode 100644 docs/models/templatecreatetemplatetemporarybadrequesterror.md create mode 100644 docs/models/templatecreatetemplatetemporarybadrequestissue.md create mode 100644 docs/models/templatecreatetemplatetemporarydateformat.md create mode 100644 docs/models/templatecreatetemplatetemporarydirection1.md create mode 100644 docs/models/templatecreatetemplatetemporarydirection2.md create mode 100644 docs/models/templatecreatetemplatetemporarydirectlink.md create mode 100644 docs/models/templatecreatetemplatetemporaryenvelopeitem.md create mode 100644 docs/models/templatecreatetemplatetemporaryfield.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetacheckbox.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetadate.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetadropdown.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetaemail.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetainitials.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetaname.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetanumber.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetaradio.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetasignature.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetatext.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldmetaunion.md create mode 100644 docs/models/templatecreatetemplatetemporaryfieldtype.md create mode 100644 docs/models/templatecreatetemplatetemporaryfolder.md create mode 100644 docs/models/templatecreatetemplatetemporaryfoldertype.md rename docs/models/{documentgetdocumentwithdetailsbyidvisibility.md => templatecreatetemplatetemporaryfoldervisibility.md} (82%) create mode 100644 docs/models/templatecreatetemplatetemporaryforbiddenerror.md create mode 100644 docs/models/templatecreatetemplatetemporaryforbiddenissue.md create mode 100644 docs/models/templatecreatetemplatetemporaryglobalaccessauthrequest.md create mode 100644 docs/models/templatecreatetemplatetemporaryglobalaccessauthresponse.md create mode 100644 docs/models/templatecreatetemplatetemporaryglobalactionauthrequest.md create mode 100644 docs/models/templatecreatetemplatetemporaryglobalactionauthresponse.md create mode 100644 docs/models/templatecreatetemplatetemporaryinternalservererror.md create mode 100644 docs/models/templatecreatetemplatetemporaryinternalservererrorissue.md create mode 100644 docs/models/templatecreatetemplatetemporarylanguage.md rename docs/models/{documentgetdocumentwithdetailsbyiddocumentmeta.md => templatecreatetemplatetemporarymeta.md} (51%) create mode 100644 docs/models/templatecreatetemplatetemporarymetadistributionmethod.md create mode 100644 docs/models/templatecreatetemplatetemporarymetaemailsettings.md create mode 100644 docs/models/templatecreatetemplatetemporaryreadstatus.md rename docs/models/{documentgetdocumentwithdetailsbyidrecipient.md => templatecreatetemplatetemporaryrecipient.md} (53%) create mode 100644 docs/models/templatecreatetemplatetemporaryrecipientauthoptions.md create mode 100644 docs/models/templatecreatetemplatetemporaryrequest.md rename docs/models/{documentsenddocumentauthoptions.md => templatecreatetemplatetemporaryresponse.md} (67%) create mode 100644 docs/models/templatecreatetemplatetemporaryrole.md create mode 100644 docs/models/templatecreatetemplatetemporarysendstatus.md create mode 100644 docs/models/templatecreatetemplatetemporarysigningorderrequest.md create mode 100644 docs/models/templatecreatetemplatetemporarysigningstatus.md rename docs/models/{documentgetdocumentwithdetailsbyidresponse.md => templatecreatetemplatetemporarytemplate.md} (78%) create mode 100644 docs/models/templatecreatetemplatetemporarytemplatedocumentdata.md create mode 100644 docs/models/templatecreatetemplatetemporarytemplatedocumentdatatype.md create mode 100644 docs/models/templatecreatetemplatetemporarytemplatemeta.md create mode 100644 docs/models/templatecreatetemplatetemporarytemplatemetadistributionmethod.md create mode 100644 docs/models/templatecreatetemplatetemporarytemplatemetaemailsettings.md create mode 100644 docs/models/templatecreatetemplatetemporarytemplatemetasigningorder.md create mode 100644 docs/models/templatecreatetemplatetemporarytextalign1.md create mode 100644 docs/models/templatecreatetemplatetemporarytextalign2.md create mode 100644 docs/models/templatecreatetemplatetemporarytextalign3.md create mode 100644 docs/models/templatecreatetemplatetemporarytextalign4.md create mode 100644 docs/models/templatecreatetemplatetemporarytextalign5.md create mode 100644 docs/models/templatecreatetemplatetemporarytextalign6.md create mode 100644 docs/models/templatecreatetemplatetemporarytypecheckbox.md create mode 100644 docs/models/templatecreatetemplatetemporarytypedate.md create mode 100644 docs/models/templatecreatetemplatetemporarytypedropdown.md create mode 100644 docs/models/templatecreatetemplatetemporarytypeemail.md create mode 100644 docs/models/templatecreatetemplatetemporarytypeinitials.md create mode 100644 docs/models/templatecreatetemplatetemporarytypelink.md create mode 100644 docs/models/templatecreatetemplatetemporarytypename.md create mode 100644 docs/models/templatecreatetemplatetemporarytypenumber.md create mode 100644 docs/models/templatecreatetemplatetemporarytyperadio.md create mode 100644 docs/models/templatecreatetemplatetemporarytyperequest.md create mode 100644 docs/models/templatecreatetemplatetemporarytyperesponse.md create mode 100644 docs/models/templatecreatetemplatetemporarytypesignature.md create mode 100644 docs/models/templatecreatetemplatetemporarytypetext.md create mode 100644 docs/models/templatecreatetemplatetemporaryunauthorizederror.md create mode 100644 docs/models/templatecreatetemplatetemporaryunauthorizedissue.md create mode 100644 docs/models/templatecreatetemplatetemporaryuser.md create mode 100644 docs/models/templatecreatetemplatetemporaryvalue1.md create mode 100644 docs/models/templatecreatetemplatetemporaryvalue2.md create mode 100644 docs/models/templatecreatetemplatetemporaryvalue3.md create mode 100644 docs/models/templatecreatetemplatetemporaryverticalalign1.md create mode 100644 docs/models/templatecreatetemplatetemporaryverticalalign2.md create mode 100644 docs/models/templatecreatetemplatetemporaryvisibilityrequest.md create mode 100644 docs/models/templatecreatetemplatetemporaryvisibilityresponse.md create mode 100644 docs/models/templatecreatetemplatetype.md create mode 100644 docs/models/templatecreatetemplatetypelink.md create mode 100644 docs/models/templatecreatetemplateunauthorizederror.md create mode 100644 docs/models/templatecreatetemplateunauthorizedissue.md create mode 100644 docs/models/templatecreatetemplatevisibility.md create mode 100644 docs/models/templatedeletetemplatedirectlinkforbiddenerror.md create mode 100644 docs/models/templatedeletetemplatedirectlinkforbiddenissue.md create mode 100644 docs/models/templatedeletetemplatedirectlinkunauthorizederror.md create mode 100644 docs/models/templatedeletetemplatedirectlinkunauthorizedissue.md create mode 100644 docs/models/templatedeletetemplateforbiddenerror.md create mode 100644 docs/models/templatedeletetemplateforbiddenissue.md create mode 100644 docs/models/templatedeletetemplateunauthorizederror.md create mode 100644 docs/models/templatedeletetemplateunauthorizedissue.md create mode 100644 docs/models/templateduplicatetemplateforbiddenerror.md create mode 100644 docs/models/templateduplicatetemplateforbiddenissue.md create mode 100644 docs/models/templateduplicatetemplateunauthorizederror.md create mode 100644 docs/models/templateduplicatetemplateunauthorizedissue.md create mode 100644 docs/models/templatefindtemplatesdirection1.md create mode 100644 docs/models/templatefindtemplatesdirection2.md create mode 100644 docs/models/templatefindtemplatesfieldmetasignature.md create mode 100644 docs/models/templatefindtemplatesforbiddenerror.md create mode 100644 docs/models/templatefindtemplatesforbiddenissue.md rename docs/models/{queryparamtype.md => templatefindtemplatesqueryparamtype.md} (79%) create mode 100644 docs/models/templatefindtemplatestypesignature.md create mode 100644 docs/models/templatefindtemplatesunauthorizederror.md create mode 100644 docs/models/templatefindtemplatesunauthorizedissue.md create mode 100644 docs/models/templatefindtemplatesverticalalign1.md create mode 100644 docs/models/templatefindtemplatesverticalalign2.md create mode 100644 docs/models/templategettemplatebyiddirection1.md create mode 100644 docs/models/templategettemplatebyiddirection2.md create mode 100644 docs/models/templategettemplatebyidenvelopeitem.md create mode 100644 docs/models/templategettemplatebyidfieldmetasignature.md create mode 100644 docs/models/templategettemplatebyidforbiddenerror.md create mode 100644 docs/models/templategettemplatebyidforbiddenissue.md create mode 100644 docs/models/templategettemplatebyidtemplatedocumentdata.md rename docs/models/{documentgetdocumentwithdetailsbyiddocumentdatatype.md => templategettemplatebyidtemplatedocumentdatatype.md} (74%) create mode 100644 docs/models/templategettemplatebyidtypesignature.md create mode 100644 docs/models/templategettemplatebyidunauthorizederror.md create mode 100644 docs/models/templategettemplatebyidunauthorizedissue.md create mode 100644 docs/models/templategettemplatebyidverticalalign1.md create mode 100644 docs/models/templategettemplatebyidverticalalign2.md create mode 100644 docs/models/templatetoggletemplatedirectlinkforbiddenerror.md create mode 100644 docs/models/templatetoggletemplatedirectlinkforbiddenissue.md create mode 100644 docs/models/templatetoggletemplatedirectlinkunauthorizederror.md create mode 100644 docs/models/templatetoggletemplatedirectlinkunauthorizedissue.md create mode 100644 docs/models/templateupdatetemplatedataglobalaccessauth.md create mode 100644 docs/models/templateupdatetemplatedataglobalactionauth.md create mode 100644 docs/models/templateupdatetemplatedatavisibility.md create mode 100644 docs/models/templateupdatetemplateforbiddenerror.md create mode 100644 docs/models/templateupdatetemplateforbiddenissue.md delete mode 100644 docs/models/templateupdatetemplateglobalaccessauthrequest.md create mode 100644 docs/models/templateupdatetemplateunauthorizederror.md create mode 100644 docs/models/templateupdatetemplateunauthorizedissue.md delete mode 100644 docs/sdks/documenso/README.md create mode 100644 docs/sdks/documentsattachments/README.md create mode 100644 docs/sdks/documentsdk/README.md create mode 100644 docs/sdks/envelopes/README.md create mode 100644 docs/sdks/envelopesattachments/README.md create mode 100644 docs/sdks/envelopesfields/README.md create mode 100644 docs/sdks/envelopesrecipients/README.md create mode 100644 docs/sdks/folders/README.md create mode 100644 docs/sdks/items/README.md create mode 100644 docs/sdks/templatesdk/README.md create mode 100644 src/documenso_sdk/document_sdk.py create mode 100644 src/documenso_sdk/documents_attachments.py create mode 100644 src/documenso_sdk/envelopes.py create mode 100644 src/documenso_sdk/envelopes_attachments.py create mode 100644 src/documenso_sdk/envelopes_fields.py create mode 100644 src/documenso_sdk/envelopes_recipients.py create mode 100644 src/documenso_sdk/folders.py create mode 100644 src/documenso_sdk/items.py create mode 100644 src/documenso_sdk/models/document_attachment_createop.py create mode 100644 src/documenso_sdk/models/document_attachment_deleteop.py create mode 100644 src/documenso_sdk/models/document_attachment_findop.py create mode 100644 src/documenso_sdk/models/document_attachment_updateop.py create mode 100644 src/documenso_sdk/models/document_createop.py delete mode 100644 src/documenso_sdk/models/document_deletedocumentop.py create mode 100644 src/documenso_sdk/models/document_deleteop.py create mode 100644 src/documenso_sdk/models/document_distributeop.py create mode 100644 src/documenso_sdk/models/document_downloadbetaop.py create mode 100644 src/documenso_sdk/models/document_downloadop.py delete mode 100644 src/documenso_sdk/models/document_duplicatedocumentop.py create mode 100644 src/documenso_sdk/models/document_duplicateop.py rename src/documenso_sdk/models/{document_finddocumentsop.py => document_findop.py} (61%) delete mode 100644 src/documenso_sdk/models/document_getdocumentwithdetailsbyidop.py create mode 100644 src/documenso_sdk/models/document_getop.py create mode 100644 src/documenso_sdk/models/document_redistributeop.py delete mode 100644 src/documenso_sdk/models/document_resenddocumentop.py delete mode 100644 src/documenso_sdk/models/document_senddocumentop.py delete mode 100644 src/documenso_sdk/models/document_updatedocumentop.py create mode 100644 src/documenso_sdk/models/document_updateop.py create mode 100644 src/documenso_sdk/models/envelope_attachment_createop.py create mode 100644 src/documenso_sdk/models/envelope_attachment_deleteop.py create mode 100644 src/documenso_sdk/models/envelope_attachment_findop.py create mode 100644 src/documenso_sdk/models/envelope_attachment_updateop.py create mode 100644 src/documenso_sdk/models/envelope_createop.py create mode 100644 src/documenso_sdk/models/envelope_deleteop.py create mode 100644 src/documenso_sdk/models/envelope_distributeop.py create mode 100644 src/documenso_sdk/models/envelope_duplicateop.py create mode 100644 src/documenso_sdk/models/envelope_field_createmanyop.py create mode 100644 src/documenso_sdk/models/envelope_field_deleteop.py create mode 100644 src/documenso_sdk/models/envelope_field_getop.py create mode 100644 src/documenso_sdk/models/envelope_field_updatemanyop.py create mode 100644 src/documenso_sdk/models/envelope_getop.py create mode 100644 src/documenso_sdk/models/envelope_item_createmanyop.py create mode 100644 src/documenso_sdk/models/envelope_item_deleteop.py create mode 100644 src/documenso_sdk/models/envelope_item_downloadop.py create mode 100644 src/documenso_sdk/models/envelope_item_updatemanyop.py create mode 100644 src/documenso_sdk/models/envelope_recipient_createmanyop.py create mode 100644 src/documenso_sdk/models/envelope_recipient_deleteop.py create mode 100644 src/documenso_sdk/models/envelope_recipient_getop.py create mode 100644 src/documenso_sdk/models/envelope_recipient_updatemanyop.py create mode 100644 src/documenso_sdk/models/envelope_redistributeop.py create mode 100644 src/documenso_sdk/models/envelope_updateop.py create mode 100644 src/documenso_sdk/models/envelope_useop.py create mode 100644 src/documenso_sdk/models/folder_createfolderop.py create mode 100644 src/documenso_sdk/models/folder_deletefolderop.py create mode 100644 src/documenso_sdk/models/folder_findfoldersop.py create mode 100644 src/documenso_sdk/models/folder_updatefolderop.py create mode 100644 src/documenso_sdk/models/template_createtemplateop.py create mode 100644 src/documenso_sdk/models/template_createtemplatetemporaryop.py create mode 100644 src/documenso_sdk/template_sdk.py 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..7a73bca 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 - docVersion: 0.0.0 - speakeasyVersion: 1.606.10 - generationVersion: 2.687.13 - releaseVersion: 0.3.0 - configChecksum: 8f932295d68232771fc1632f3a315deb + docChecksum: d4156690edb6babf72c9cf9548e8b789 + docVersion: 1.0.0 + speakeasyVersion: 1.654.0 + generationVersion: 2.750.0 + 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,28 @@ 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 + multipartFileContentType: 1.0.0 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 + uploadStreams: 1.0.0 generatedFiles: - .devcontainer/README.md - .devcontainer/devcontainer.json @@ -42,19 +45,76 @@ generatedFiles: - USAGE.md - docs/models/datasource.md - docs/models/datastatus.md - - docs/models/document.md - docs/models/documentaccessauth.md - docs/models/documentactionauth.md + - docs/models/documentattachmentcreatebadrequesterror.md + - docs/models/documentattachmentcreatebadrequestissue.md + - docs/models/documentattachmentcreatedata.md + - docs/models/documentattachmentcreateforbiddenerror.md + - docs/models/documentattachmentcreateforbiddenissue.md + - docs/models/documentattachmentcreateinternalservererror.md + - docs/models/documentattachmentcreateinternalservererrorissue.md + - docs/models/documentattachmentcreaterequest.md + - docs/models/documentattachmentcreateresponse.md + - docs/models/documentattachmentcreateunauthorizederror.md + - docs/models/documentattachmentcreateunauthorizedissue.md + - docs/models/documentattachmentdeletebadrequesterror.md + - docs/models/documentattachmentdeletebadrequestissue.md + - docs/models/documentattachmentdeleteforbiddenerror.md + - docs/models/documentattachmentdeleteforbiddenissue.md + - docs/models/documentattachmentdeleteinternalservererror.md + - docs/models/documentattachmentdeleteinternalservererrorissue.md + - docs/models/documentattachmentdeleterequest.md + - docs/models/documentattachmentdeleteresponse.md + - docs/models/documentattachmentdeleteunauthorizederror.md + - docs/models/documentattachmentdeleteunauthorizedissue.md + - docs/models/documentattachmentfindbadrequesterror.md + - docs/models/documentattachmentfindbadrequestissue.md + - docs/models/documentattachmentfinddata.md + - docs/models/documentattachmentfindforbiddenerror.md + - docs/models/documentattachmentfindforbiddenissue.md + - docs/models/documentattachmentfindinternalservererror.md + - docs/models/documentattachmentfindinternalservererrorissue.md + - docs/models/documentattachmentfindnotfounderror.md + - docs/models/documentattachmentfindnotfoundissue.md + - docs/models/documentattachmentfindrequest.md + - docs/models/documentattachmentfindresponse.md + - docs/models/documentattachmentfindtype.md + - docs/models/documentattachmentfindunauthorizederror.md + - docs/models/documentattachmentfindunauthorizedissue.md + - docs/models/documentattachmentupdatebadrequesterror.md + - docs/models/documentattachmentupdatebadrequestissue.md + - docs/models/documentattachmentupdatedata.md + - docs/models/documentattachmentupdateforbiddenerror.md + - docs/models/documentattachmentupdateforbiddenissue.md + - docs/models/documentattachmentupdateinternalservererror.md + - docs/models/documentattachmentupdateinternalservererrorissue.md + - docs/models/documentattachmentupdaterequest.md + - docs/models/documentattachmentupdateresponse.md + - docs/models/documentattachmentupdateunauthorizederror.md + - docs/models/documentattachmentupdateunauthorizedissue.md + - docs/models/documentcreateaccessauth.md + - docs/models/documentcreateactionauth.md + - docs/models/documentcreateattachment.md + - docs/models/documentcreatebadrequesterror.md + - docs/models/documentcreatebadrequestissue.md + - docs/models/documentcreatedateformat.md + - docs/models/documentcreatedirectioncheckbox.md + - docs/models/documentcreatedirectionradio.md + - docs/models/documentcreatedistributionmethod.md - docs/models/documentcreatedocumenttemporaryaccessauthrequest.md - docs/models/documentcreatedocumenttemporaryactionauthrequest.md + - docs/models/documentcreatedocumenttemporaryattachment.md - docs/models/documentcreatedocumenttemporaryauthoptions.md - docs/models/documentcreatedocumenttemporarybadrequesterror.md - docs/models/documentcreatedocumenttemporarybadrequestissue.md - docs/models/documentcreatedocumenttemporarydateformat.md - - docs/models/documentcreatedocumenttemporarydistributionmethodrequest.md + - docs/models/documentcreatedocumenttemporarydirectioncheckbox.md + - docs/models/documentcreatedocumenttemporarydirectionradio.md + - docs/models/documentcreatedocumenttemporarydocument.md - docs/models/documentcreatedocumenttemporarydocumentdata.md - docs/models/documentcreatedocumenttemporarydocumentmeta.md - - docs/models/documentcreatedocumenttemporaryemailsettingsrequest.md + - docs/models/documentcreatedocumenttemporaryenvelopeitem.md - docs/models/documentcreatedocumenttemporaryfieldcheckbox.md - docs/models/documentcreatedocumenttemporaryfielddate.md - docs/models/documentcreatedocumenttemporaryfielddropdown.md @@ -68,12 +128,17 @@ generatedFiles: - docs/models/documentcreatedocumenttemporaryfieldtext.md - docs/models/documentcreatedocumenttemporaryfieldunion.md - docs/models/documentcreatedocumenttemporaryfolder.md + - docs/models/documentcreatedocumenttemporaryforbiddenerror.md + - docs/models/documentcreatedocumenttemporaryforbiddenissue.md + - docs/models/documentcreatedocumenttemporaryformvaluesrequest.md - docs/models/documentcreatedocumenttemporaryglobalaccessauthrequest.md - docs/models/documentcreatedocumenttemporaryglobalactionauthrequest.md - docs/models/documentcreatedocumenttemporaryinternalservererror.md - docs/models/documentcreatedocumenttemporaryinternalservererrorissue.md - docs/models/documentcreatedocumenttemporarylanguage.md - docs/models/documentcreatedocumenttemporarymeta.md + - docs/models/documentcreatedocumenttemporarymetadistributionmethod.md + - docs/models/documentcreatedocumenttemporarymetaemailsettings.md - docs/models/documentcreatedocumenttemporaryreadstatus.md - docs/models/documentcreatedocumenttemporaryrecipientauthoptions.md - docs/models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md @@ -84,6 +149,7 @@ generatedFiles: - docs/models/documentcreatedocumenttemporaryrecipientfieldmetaname.md - docs/models/documentcreatedocumenttemporaryrecipientfieldmetanumber.md - docs/models/documentcreatedocumenttemporaryrecipientfieldmetaradio.md + - docs/models/documentcreatedocumenttemporaryrecipientfieldmetasignature.md - docs/models/documentcreatedocumenttemporaryrecipientfieldmetatext.md - docs/models/documentcreatedocumenttemporaryrecipientrequest.md - docs/models/documentcreatedocumenttemporaryrecipienttypecheckbox1.md @@ -102,6 +168,8 @@ generatedFiles: - docs/models/documentcreatedocumenttemporaryrecipienttypenumber2.md - docs/models/documentcreatedocumenttemporaryrecipienttyperadio1.md - docs/models/documentcreatedocumenttemporaryrecipienttyperadio2.md + - docs/models/documentcreatedocumenttemporaryrecipienttypesignature1.md + - docs/models/documentcreatedocumenttemporaryrecipienttypesignature2.md - docs/models/documentcreatedocumenttemporaryrecipienttypetext1.md - docs/models/documentcreatedocumenttemporaryrecipienttypetext2.md - docs/models/documentcreatedocumenttemporaryrequest.md @@ -119,146 +187,284 @@ generatedFiles: - docs/models/documentcreatedocumenttemporarytextalignnumber.md - docs/models/documentcreatedocumenttemporarytextaligntext.md - docs/models/documentcreatedocumenttemporarytypefreesignature.md - - docs/models/documentcreatedocumenttemporarytypesignature.md + - docs/models/documentcreatedocumenttemporarytypelink.md + - docs/models/documentcreatedocumenttemporaryunauthorizederror.md + - docs/models/documentcreatedocumenttemporaryunauthorizedissue.md - docs/models/documentcreatedocumenttemporaryvaluecheckbox.md - docs/models/documentcreatedocumenttemporaryvaluedropdown.md - docs/models/documentcreatedocumenttemporaryvalueradio.md + - docs/models/documentcreatedocumenttemporaryverticalalignnumber.md + - docs/models/documentcreatedocumenttemporaryverticalaligntext.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/documentcreateemailsettings.md + - docs/models/documentcreatefieldcheckbox.md + - docs/models/documentcreatefielddate.md + - docs/models/documentcreatefielddropdown.md + - docs/models/documentcreatefieldemail.md + - docs/models/documentcreatefieldfreesignature.md + - docs/models/documentcreatefieldinitials.md + - docs/models/documentcreatefieldmetacheckbox.md + - docs/models/documentcreatefieldmetadate.md + - docs/models/documentcreatefieldmetadropdown.md + - docs/models/documentcreatefieldmetaemail.md + - docs/models/documentcreatefieldmetainitials.md + - docs/models/documentcreatefieldmetaname.md + - docs/models/documentcreatefieldmetanumber.md + - docs/models/documentcreatefieldmetaradio.md + - docs/models/documentcreatefieldmetasignature.md + - docs/models/documentcreatefieldmetatext.md + - docs/models/documentcreatefieldname.md + - docs/models/documentcreatefieldnumber.md + - docs/models/documentcreatefieldradio.md + - docs/models/documentcreatefieldsignature.md + - docs/models/documentcreatefieldtext.md + - docs/models/documentcreatefieldunion.md + - docs/models/documentcreatefile.md + - docs/models/documentcreateforbiddenerror.md + - docs/models/documentcreateforbiddenissue.md + - docs/models/documentcreateformvalues.md + - docs/models/documentcreateglobalaccessauth.md + - docs/models/documentcreateglobalactionauth.md + - docs/models/documentcreateinternalservererror.md + - docs/models/documentcreateinternalservererrorissue.md + - docs/models/documentcreatelanguage.md + - docs/models/documentcreatemeta.md + - docs/models/documentcreatepayload.md + - docs/models/documentcreaterecipient.md + - docs/models/documentcreaterequest.md + - docs/models/documentcreateresponse.md + - docs/models/documentcreaterole.md + - docs/models/documentcreatesigningorder.md + - docs/models/documentcreatetextaligndate.md + - docs/models/documentcreatetextalignemail.md + - docs/models/documentcreatetextaligninitials.md + - docs/models/documentcreatetextalignname.md + - docs/models/documentcreatetextalignnumber.md + - docs/models/documentcreatetextaligntext.md + - docs/models/documentcreatetypecheckbox1.md + - docs/models/documentcreatetypecheckbox2.md + - docs/models/documentcreatetypedate1.md + - docs/models/documentcreatetypedate2.md + - docs/models/documentcreatetypedropdown1.md + - docs/models/documentcreatetypedropdown2.md + - docs/models/documentcreatetypeemail1.md + - docs/models/documentcreatetypeemail2.md + - docs/models/documentcreatetypefreesignature.md + - docs/models/documentcreatetypeinitials1.md + - docs/models/documentcreatetypeinitials2.md + - docs/models/documentcreatetypelink.md + - docs/models/documentcreatetypename1.md + - docs/models/documentcreatetypename2.md + - docs/models/documentcreatetypenumber1.md + - docs/models/documentcreatetypenumber2.md + - docs/models/documentcreatetyperadio1.md + - docs/models/documentcreatetyperadio2.md + - docs/models/documentcreatetypesignature1.md + - docs/models/documentcreatetypesignature2.md + - docs/models/documentcreatetypetext1.md + - docs/models/documentcreatetypetext2.md + - docs/models/documentcreateunauthorizederror.md + - docs/models/documentcreateunauthorizedissue.md + - docs/models/documentcreatevaluecheckbox.md + - docs/models/documentcreatevaluedropdown.md + - docs/models/documentcreatevalueradio.md + - docs/models/documentcreateverticalalignnumber.md + - docs/models/documentcreateverticalaligntext.md + - docs/models/documentcreatevisibility.md + - docs/models/documentdeletebadrequesterror.md + - docs/models/documentdeletebadrequestissue.md + - docs/models/documentdeleteforbiddenerror.md + - docs/models/documentdeleteforbiddenissue.md + - docs/models/documentdeleteinternalservererror.md + - docs/models/documentdeleteinternalservererrorissue.md + - docs/models/documentdeleterequest.md + - docs/models/documentdeleteresponse.md + - docs/models/documentdeleteunauthorizederror.md + - docs/models/documentdeleteunauthorizedissue.md + - docs/models/documentdirection1.md + - docs/models/documentdirection2.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/documentdistributeforbiddenerror.md + - docs/models/documentdistributeforbiddenissue.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/documentdistributeunauthorizederror.md + - docs/models/documentdistributeunauthorizedissue.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/documentdownloadbetabadrequesterror.md + - docs/models/documentdownloadbetabadrequestissue.md + - docs/models/documentdownloadbetaforbiddenerror.md + - docs/models/documentdownloadbetaforbiddenissue.md + - docs/models/documentdownloadbetainternalservererror.md + - docs/models/documentdownloadbetainternalservererrorissue.md + - docs/models/documentdownloadbetanotfounderror.md + - docs/models/documentdownloadbetanotfoundissue.md + - docs/models/documentdownloadbetarequest.md + - docs/models/documentdownloadbetaresponse.md + - docs/models/documentdownloadbetaunauthorizederror.md + - docs/models/documentdownloadbetaunauthorizedissue.md + - docs/models/documentdownloadbetaversion.md + - docs/models/documentdownloadforbiddenerror.md + - docs/models/documentdownloadforbiddenissue.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/documentdownloadunauthorizederror.md + - docs/models/documentdownloadunauthorizedissue.md + - docs/models/documentdownloadversion.md + - docs/models/documentduplicatebadrequesterror.md + - docs/models/documentduplicatebadrequestissue.md + - docs/models/documentduplicateforbiddenerror.md + - docs/models/documentduplicateforbiddenissue.md + - docs/models/documentduplicateinternalservererror.md + - docs/models/documentduplicateinternalservererrorissue.md + - docs/models/documentduplicaterequest.md + - docs/models/documentduplicateresponse.md + - docs/models/documentduplicateunauthorizederror.md + - docs/models/documentduplicateunauthorizedissue.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/documentfindforbiddenerror.md + - docs/models/documentfindforbiddenissue.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/documentfindunauthorizederror.md + - docs/models/documentfindunauthorizedissue.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/documentgetdirection1.md + - docs/models/documentgetdirection2.md + - docs/models/documentgetdistributionmethod.md + - docs/models/documentgetdocumentdata.md + - docs/models/documentgetdocumentdatatype.md + - docs/models/documentgetdocumentmeta.md + - docs/models/documentgetemailsettings.md + - docs/models/documentgetenvelopeitem.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/documentgetfieldmetasignature.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/documentgetforbiddenerror.md + - docs/models/documentgetforbiddenissue.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/documentgettypesignature.md + - docs/models/documentgettypetext.md + - docs/models/documentgetunauthorizederror.md + - docs/models/documentgetunauthorizedissue.md + - docs/models/documentgetvalue1.md + - docs/models/documentgetvalue2.md + - docs/models/documentgetvalue3.md + - docs/models/documentgetverticalalign1.md + - docs/models/documentgetverticalalign2.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/documentredistributeforbiddenerror.md + - docs/models/documentredistributeforbiddenissue.md + - docs/models/documentredistributeinternalservererror.md + - docs/models/documentredistributeinternalservererrorissue.md + - docs/models/documentredistributerequest.md + - docs/models/documentredistributeresponse.md + - docs/models/documentredistributeunauthorizederror.md + - docs/models/documentredistributeunauthorizedissue.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 @@ -274,48 +480,808 @@ generatedFiles: - docs/models/documenttypename.md - docs/models/documenttypenumber.md - docs/models/documenttyperadio.md + - docs/models/documenttypesignature.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/documentupdatedataglobalaccessauth.md + - docs/models/documentupdatedataglobalactionauth.md + - docs/models/documentupdatedatavisibility.md + - docs/models/documentupdatedateformat.md + - docs/models/documentupdatedistributionmethod.md + - docs/models/documentupdateemailsettings.md + - docs/models/documentupdateforbiddenerror.md + - docs/models/documentupdateforbiddenissue.md + - docs/models/documentupdateformvalues.md + - docs/models/documentupdateglobalaccessauthresponse.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/documentupdateunauthorizederror.md + - docs/models/documentupdateunauthorizedissue.md + - docs/models/documentupdatevisibilityresponse.md - docs/models/documentvalue1.md - docs/models/documentvalue2.md - docs/models/documentvalue3.md + - docs/models/documentverticalalign1.md + - docs/models/documentverticalalign2.md - docs/models/documentvisibility.md - docs/models/embeddingpresigncreateembeddingpresigntokenbadrequesterror.md - docs/models/embeddingpresigncreateembeddingpresigntokenbadrequestissue.md + - docs/models/embeddingpresigncreateembeddingpresigntokenforbiddenerror.md + - docs/models/embeddingpresigncreateembeddingpresigntokenforbiddenissue.md - docs/models/embeddingpresigncreateembeddingpresigntokeninternalservererror.md - docs/models/embeddingpresigncreateembeddingpresigntokeninternalservererrorissue.md - docs/models/embeddingpresigncreateembeddingpresigntokenrequest.md - docs/models/embeddingpresigncreateembeddingpresigntokenresponse.md + - docs/models/embeddingpresigncreateembeddingpresigntokenunauthorizederror.md + - docs/models/embeddingpresigncreateembeddingpresigntokenunauthorizedissue.md - docs/models/embeddingpresignverifyembeddingpresigntokenbadrequesterror.md - docs/models/embeddingpresignverifyembeddingpresigntokenbadrequestissue.md + - docs/models/embeddingpresignverifyembeddingpresigntokenforbiddenerror.md + - docs/models/embeddingpresignverifyembeddingpresigntokenforbiddenissue.md - docs/models/embeddingpresignverifyembeddingpresigntokeninternalservererror.md - docs/models/embeddingpresignverifyembeddingpresigntokeninternalservererrorissue.md - docs/models/embeddingpresignverifyembeddingpresigntokenrequest.md - docs/models/embeddingpresignverifyembeddingpresigntokenresponse.md + - docs/models/embeddingpresignverifyembeddingpresigntokenunauthorizederror.md + - docs/models/embeddingpresignverifyembeddingpresigntokenunauthorizedissue.md + - docs/models/envelopeattachmentcreatebadrequesterror.md + - docs/models/envelopeattachmentcreatebadrequestissue.md + - docs/models/envelopeattachmentcreatedata.md + - docs/models/envelopeattachmentcreateforbiddenerror.md + - docs/models/envelopeattachmentcreateforbiddenissue.md + - docs/models/envelopeattachmentcreateinternalservererror.md + - docs/models/envelopeattachmentcreateinternalservererrorissue.md + - docs/models/envelopeattachmentcreaterequest.md + - docs/models/envelopeattachmentcreateresponse.md + - docs/models/envelopeattachmentcreateunauthorizederror.md + - docs/models/envelopeattachmentcreateunauthorizedissue.md + - docs/models/envelopeattachmentdeletebadrequesterror.md + - docs/models/envelopeattachmentdeletebadrequestissue.md + - docs/models/envelopeattachmentdeleteforbiddenerror.md + - docs/models/envelopeattachmentdeleteforbiddenissue.md + - docs/models/envelopeattachmentdeleteinternalservererror.md + - docs/models/envelopeattachmentdeleteinternalservererrorissue.md + - docs/models/envelopeattachmentdeleterequest.md + - docs/models/envelopeattachmentdeleteresponse.md + - docs/models/envelopeattachmentdeleteunauthorizederror.md + - docs/models/envelopeattachmentdeleteunauthorizedissue.md + - docs/models/envelopeattachmentfindbadrequesterror.md + - docs/models/envelopeattachmentfindbadrequestissue.md + - docs/models/envelopeattachmentfinddata.md + - docs/models/envelopeattachmentfindforbiddenerror.md + - docs/models/envelopeattachmentfindforbiddenissue.md + - docs/models/envelopeattachmentfindinternalservererror.md + - docs/models/envelopeattachmentfindinternalservererrorissue.md + - docs/models/envelopeattachmentfindnotfounderror.md + - docs/models/envelopeattachmentfindnotfoundissue.md + - docs/models/envelopeattachmentfindrequest.md + - docs/models/envelopeattachmentfindresponse.md + - docs/models/envelopeattachmentfindtype.md + - docs/models/envelopeattachmentfindunauthorizederror.md + - docs/models/envelopeattachmentfindunauthorizedissue.md + - docs/models/envelopeattachmentupdatebadrequesterror.md + - docs/models/envelopeattachmentupdatebadrequestissue.md + - docs/models/envelopeattachmentupdatedata.md + - docs/models/envelopeattachmentupdateforbiddenerror.md + - docs/models/envelopeattachmentupdateforbiddenissue.md + - docs/models/envelopeattachmentupdateinternalservererror.md + - docs/models/envelopeattachmentupdateinternalservererrorissue.md + - docs/models/envelopeattachmentupdaterequest.md + - docs/models/envelopeattachmentupdateresponse.md + - docs/models/envelopeattachmentupdateunauthorizederror.md + - docs/models/envelopeattachmentupdateunauthorizedissue.md + - docs/models/envelopecreateaccessauth.md + - docs/models/envelopecreateactionauth.md + - docs/models/envelopecreateattachment.md + - docs/models/envelopecreatebadrequesterror.md + - docs/models/envelopecreatebadrequestissue.md + - docs/models/envelopecreatedateformat.md + - docs/models/envelopecreatedirectioncheckbox.md + - docs/models/envelopecreatedirectionradio.md + - docs/models/envelopecreatedistributionmethod.md + - docs/models/envelopecreateemailsettings.md + - docs/models/envelopecreatefieldcheckbox.md + - docs/models/envelopecreatefielddate.md + - docs/models/envelopecreatefielddropdown.md + - docs/models/envelopecreatefieldemail.md + - docs/models/envelopecreatefieldfreesignature.md + - docs/models/envelopecreatefieldinitials.md + - docs/models/envelopecreatefieldmetacheckbox.md + - docs/models/envelopecreatefieldmetadate.md + - docs/models/envelopecreatefieldmetadropdown.md + - docs/models/envelopecreatefieldmetaemail.md + - docs/models/envelopecreatefieldmetainitials.md + - docs/models/envelopecreatefieldmetaname.md + - docs/models/envelopecreatefieldmetanumber.md + - docs/models/envelopecreatefieldmetaradio.md + - docs/models/envelopecreatefieldmetasignature.md + - docs/models/envelopecreatefieldmetatext.md + - docs/models/envelopecreatefieldname.md + - docs/models/envelopecreatefieldnumber.md + - docs/models/envelopecreatefieldradio.md + - docs/models/envelopecreatefieldsignature.md + - docs/models/envelopecreatefieldtext.md + - docs/models/envelopecreatefieldunion.md + - docs/models/envelopecreatefile.md + - docs/models/envelopecreateforbiddenerror.md + - docs/models/envelopecreateforbiddenissue.md + - docs/models/envelopecreateformvalues.md + - docs/models/envelopecreateglobalaccessauth.md + - docs/models/envelopecreateglobalactionauth.md + - docs/models/envelopecreateidentifier1.md + - docs/models/envelopecreateidentifier10.md + - docs/models/envelopecreateidentifier11.md + - docs/models/envelopecreateidentifier2.md + - docs/models/envelopecreateidentifier3.md + - docs/models/envelopecreateidentifier4.md + - docs/models/envelopecreateidentifier5.md + - docs/models/envelopecreateidentifier6.md + - docs/models/envelopecreateidentifier7.md + - docs/models/envelopecreateidentifier8.md + - docs/models/envelopecreateidentifier9.md + - docs/models/envelopecreateinternalservererror.md + - docs/models/envelopecreateinternalservererrorissue.md + - docs/models/envelopecreatelanguage.md + - docs/models/envelopecreatemeta.md + - docs/models/envelopecreatepayload.md + - docs/models/envelopecreaterecipient.md + - docs/models/envelopecreaterequest.md + - docs/models/envelopecreateresponse.md + - docs/models/envelopecreaterole.md + - docs/models/envelopecreatesigningorder.md + - docs/models/envelopecreatetextaligndate.md + - docs/models/envelopecreatetextalignemail.md + - docs/models/envelopecreatetextaligninitials.md + - docs/models/envelopecreatetextalignname.md + - docs/models/envelopecreatetextalignnumber.md + - docs/models/envelopecreatetextaligntext.md + - docs/models/envelopecreatetype.md + - docs/models/envelopecreatetypecheckbox1.md + - docs/models/envelopecreatetypecheckbox2.md + - docs/models/envelopecreatetypedate1.md + - docs/models/envelopecreatetypedate2.md + - docs/models/envelopecreatetypedropdown1.md + - docs/models/envelopecreatetypedropdown2.md + - docs/models/envelopecreatetypeemail1.md + - docs/models/envelopecreatetypeemail2.md + - docs/models/envelopecreatetypefreesignature.md + - docs/models/envelopecreatetypeinitials1.md + - docs/models/envelopecreatetypeinitials2.md + - docs/models/envelopecreatetypelink.md + - docs/models/envelopecreatetypename1.md + - docs/models/envelopecreatetypename2.md + - docs/models/envelopecreatetypenumber1.md + - docs/models/envelopecreatetypenumber2.md + - docs/models/envelopecreatetyperadio1.md + - docs/models/envelopecreatetyperadio2.md + - docs/models/envelopecreatetypesignature1.md + - docs/models/envelopecreatetypesignature2.md + - docs/models/envelopecreatetypetext1.md + - docs/models/envelopecreatetypetext2.md + - docs/models/envelopecreateunauthorizederror.md + - docs/models/envelopecreateunauthorizedissue.md + - docs/models/envelopecreatevaluecheckbox.md + - docs/models/envelopecreatevaluedropdown.md + - docs/models/envelopecreatevalueradio.md + - docs/models/envelopecreateverticalalignnumber.md + - docs/models/envelopecreateverticalaligntext.md + - docs/models/envelopecreatevisibility.md + - docs/models/envelopedeletebadrequesterror.md + - docs/models/envelopedeletebadrequestissue.md + - docs/models/envelopedeleteforbiddenerror.md + - docs/models/envelopedeleteforbiddenissue.md + - docs/models/envelopedeleteinternalservererror.md + - docs/models/envelopedeleteinternalservererrorissue.md + - docs/models/envelopedeleterequest.md + - docs/models/envelopedeleteresponse.md + - docs/models/envelopedeleteunauthorizederror.md + - docs/models/envelopedeleteunauthorizedissue.md + - docs/models/envelopedistributebadrequesterror.md + - docs/models/envelopedistributebadrequestissue.md + - docs/models/envelopedistributedateformat.md + - docs/models/envelopedistributedistributionmethod.md + - docs/models/envelopedistributeemailsettings.md + - docs/models/envelopedistributeforbiddenerror.md + - docs/models/envelopedistributeforbiddenissue.md + - docs/models/envelopedistributeinternalservererror.md + - docs/models/envelopedistributeinternalservererrorissue.md + - docs/models/envelopedistributelanguage.md + - docs/models/envelopedistributemeta.md + - docs/models/envelopedistributerequest.md + - docs/models/envelopedistributeresponse.md + - docs/models/envelopedistributeunauthorizederror.md + - docs/models/envelopedistributeunauthorizedissue.md + - docs/models/envelopeduplicatebadrequesterror.md + - docs/models/envelopeduplicatebadrequestissue.md + - docs/models/envelopeduplicateforbiddenerror.md + - docs/models/envelopeduplicateforbiddenissue.md + - docs/models/envelopeduplicateinternalservererror.md + - docs/models/envelopeduplicateinternalservererrorissue.md + - docs/models/envelopeduplicaterequest.md + - docs/models/envelopeduplicateresponse.md + - docs/models/envelopeduplicateunauthorizederror.md + - docs/models/envelopeduplicateunauthorizedissue.md + - docs/models/envelopefieldcreatemanybadrequesterror.md + - docs/models/envelopefieldcreatemanybadrequestissue.md + - docs/models/envelopefieldcreatemanydatacheckbox.md + - docs/models/envelopefieldcreatemanydatadate.md + - docs/models/envelopefieldcreatemanydatadropdown.md + - docs/models/envelopefieldcreatemanydataemail.md + - docs/models/envelopefieldcreatemanydatafreesignature.md + - docs/models/envelopefieldcreatemanydatainitials.md + - docs/models/envelopefieldcreatemanydataname.md + - docs/models/envelopefieldcreatemanydatanumber.md + - docs/models/envelopefieldcreatemanydataradio.md + - docs/models/envelopefieldcreatemanydataresponse.md + - docs/models/envelopefieldcreatemanydatasignature.md + - docs/models/envelopefieldcreatemanydatatext.md + - docs/models/envelopefieldcreatemanydataunion.md + - docs/models/envelopefieldcreatemanydirectioncheckbox.md + - docs/models/envelopefieldcreatemanydirectionradio.md + - docs/models/envelopefieldcreatemanydirectionresponse1.md + - docs/models/envelopefieldcreatemanydirectionresponse2.md + - docs/models/envelopefieldcreatemanyfieldmetacheckboxrequest.md + - docs/models/envelopefieldcreatemanyfieldmetacheckboxresponse.md + - docs/models/envelopefieldcreatemanyfieldmetadaterequest.md + - docs/models/envelopefieldcreatemanyfieldmetadateresponse.md + - docs/models/envelopefieldcreatemanyfieldmetadropdownrequest.md + - docs/models/envelopefieldcreatemanyfieldmetadropdownresponse.md + - docs/models/envelopefieldcreatemanyfieldmetaemailrequest.md + - docs/models/envelopefieldcreatemanyfieldmetaemailresponse.md + - docs/models/envelopefieldcreatemanyfieldmetainitialsrequest.md + - docs/models/envelopefieldcreatemanyfieldmetainitialsresponse.md + - docs/models/envelopefieldcreatemanyfieldmetanamerequest.md + - docs/models/envelopefieldcreatemanyfieldmetanameresponse.md + - docs/models/envelopefieldcreatemanyfieldmetanumberrequest.md + - docs/models/envelopefieldcreatemanyfieldmetanumberresponse.md + - docs/models/envelopefieldcreatemanyfieldmetaradiorequest.md + - docs/models/envelopefieldcreatemanyfieldmetaradioresponse.md + - docs/models/envelopefieldcreatemanyfieldmetasignaturerequest.md + - docs/models/envelopefieldcreatemanyfieldmetasignatureresponse.md + - docs/models/envelopefieldcreatemanyfieldmetatextrequest.md + - docs/models/envelopefieldcreatemanyfieldmetatextresponse.md + - docs/models/envelopefieldcreatemanyfieldmetatypecheckbox.md + - docs/models/envelopefieldcreatemanyfieldmetatypedate.md + - docs/models/envelopefieldcreatemanyfieldmetatypedropdown.md + - docs/models/envelopefieldcreatemanyfieldmetatypeemail.md + - docs/models/envelopefieldcreatemanyfieldmetatypeinitials.md + - docs/models/envelopefieldcreatemanyfieldmetatypename.md + - docs/models/envelopefieldcreatemanyfieldmetatypenumber.md + - docs/models/envelopefieldcreatemanyfieldmetatyperadio.md + - docs/models/envelopefieldcreatemanyfieldmetatypesignature.md + - docs/models/envelopefieldcreatemanyfieldmetatypetext.md + - docs/models/envelopefieldcreatemanyfieldmetaunion.md + - docs/models/envelopefieldcreatemanyforbiddenerror.md + - docs/models/envelopefieldcreatemanyforbiddenissue.md + - docs/models/envelopefieldcreatemanyinternalservererror.md + - docs/models/envelopefieldcreatemanyinternalservererrorissue.md + - docs/models/envelopefieldcreatemanyrequest.md + - docs/models/envelopefieldcreatemanyresponse.md + - docs/models/envelopefieldcreatemanytextaligndate.md + - docs/models/envelopefieldcreatemanytextalignemail.md + - docs/models/envelopefieldcreatemanytextaligninitials.md + - docs/models/envelopefieldcreatemanytextalignname.md + - docs/models/envelopefieldcreatemanytextalignnumber.md + - docs/models/envelopefieldcreatemanytextalignresponse1.md + - docs/models/envelopefieldcreatemanytextalignresponse2.md + - docs/models/envelopefieldcreatemanytextalignresponse3.md + - docs/models/envelopefieldcreatemanytextalignresponse4.md + - docs/models/envelopefieldcreatemanytextalignresponse5.md + - docs/models/envelopefieldcreatemanytextalignresponse6.md + - docs/models/envelopefieldcreatemanytextaligntext.md + - docs/models/envelopefieldcreatemanytypecheckboxrequest1.md + - docs/models/envelopefieldcreatemanytypecheckboxrequest2.md + - docs/models/envelopefieldcreatemanytypedaterequest1.md + - docs/models/envelopefieldcreatemanytypedaterequest2.md + - docs/models/envelopefieldcreatemanytypedropdownrequest1.md + - docs/models/envelopefieldcreatemanytypedropdownrequest2.md + - docs/models/envelopefieldcreatemanytypeemailrequest1.md + - docs/models/envelopefieldcreatemanytypeemailrequest2.md + - docs/models/envelopefieldcreatemanytypefreesignature.md + - docs/models/envelopefieldcreatemanytypeinitialsrequest1.md + - docs/models/envelopefieldcreatemanytypeinitialsrequest2.md + - docs/models/envelopefieldcreatemanytypenamerequest1.md + - docs/models/envelopefieldcreatemanytypenamerequest2.md + - docs/models/envelopefieldcreatemanytypenumberrequest1.md + - docs/models/envelopefieldcreatemanytypenumberrequest2.md + - docs/models/envelopefieldcreatemanytyperadiorequest1.md + - docs/models/envelopefieldcreatemanytyperadiorequest2.md + - docs/models/envelopefieldcreatemanytyperesponse.md + - docs/models/envelopefieldcreatemanytypesignaturerequest1.md + - docs/models/envelopefieldcreatemanytypesignaturerequest2.md + - docs/models/envelopefieldcreatemanytypetextrequest1.md + - docs/models/envelopefieldcreatemanytypetextrequest2.md + - docs/models/envelopefieldcreatemanyunauthorizederror.md + - docs/models/envelopefieldcreatemanyunauthorizedissue.md + - docs/models/envelopefieldcreatemanyvaluecheckbox.md + - docs/models/envelopefieldcreatemanyvaluedropdown.md + - docs/models/envelopefieldcreatemanyvalueradio.md + - docs/models/envelopefieldcreatemanyvalueresponse1.md + - docs/models/envelopefieldcreatemanyvalueresponse2.md + - docs/models/envelopefieldcreatemanyvalueresponse3.md + - docs/models/envelopefieldcreatemanyverticalalignnumber.md + - docs/models/envelopefieldcreatemanyverticalalignresponse1.md + - docs/models/envelopefieldcreatemanyverticalalignresponse2.md + - docs/models/envelopefieldcreatemanyverticalaligntext.md + - docs/models/envelopefielddeletebadrequesterror.md + - docs/models/envelopefielddeletebadrequestissue.md + - docs/models/envelopefielddeleteforbiddenerror.md + - docs/models/envelopefielddeleteforbiddenissue.md + - docs/models/envelopefielddeleteinternalservererror.md + - docs/models/envelopefielddeleteinternalservererrorissue.md + - docs/models/envelopefielddeleterequest.md + - docs/models/envelopefielddeleteresponse.md + - docs/models/envelopefielddeleteunauthorizederror.md + - docs/models/envelopefielddeleteunauthorizedissue.md + - docs/models/envelopefieldgetbadrequesterror.md + - docs/models/envelopefieldgetbadrequestissue.md + - docs/models/envelopefieldgetdirection1.md + - docs/models/envelopefieldgetdirection2.md + - docs/models/envelopefieldgetfieldmetacheckbox.md + - docs/models/envelopefieldgetfieldmetadate.md + - docs/models/envelopefieldgetfieldmetadropdown.md + - docs/models/envelopefieldgetfieldmetaemail.md + - docs/models/envelopefieldgetfieldmetainitials.md + - docs/models/envelopefieldgetfieldmetaname.md + - docs/models/envelopefieldgetfieldmetanumber.md + - docs/models/envelopefieldgetfieldmetaradio.md + - docs/models/envelopefieldgetfieldmetasignature.md + - docs/models/envelopefieldgetfieldmetatext.md + - docs/models/envelopefieldgetfieldmetaunion.md + - docs/models/envelopefieldgetforbiddenerror.md + - docs/models/envelopefieldgetforbiddenissue.md + - docs/models/envelopefieldgetinternalservererror.md + - docs/models/envelopefieldgetinternalservererrorissue.md + - docs/models/envelopefieldgetnotfounderror.md + - docs/models/envelopefieldgetnotfoundissue.md + - docs/models/envelopefieldgetrequest.md + - docs/models/envelopefieldgetresponse.md + - docs/models/envelopefieldgettextalign1.md + - docs/models/envelopefieldgettextalign2.md + - docs/models/envelopefieldgettextalign3.md + - docs/models/envelopefieldgettextalign4.md + - docs/models/envelopefieldgettextalign5.md + - docs/models/envelopefieldgettextalign6.md + - docs/models/envelopefieldgettype.md + - docs/models/envelopefieldgettypecheckbox.md + - docs/models/envelopefieldgettypedate.md + - docs/models/envelopefieldgettypedropdown.md + - docs/models/envelopefieldgettypeemail.md + - docs/models/envelopefieldgettypeinitials.md + - docs/models/envelopefieldgettypename.md + - docs/models/envelopefieldgettypenumber.md + - docs/models/envelopefieldgettyperadio.md + - docs/models/envelopefieldgettypesignature.md + - docs/models/envelopefieldgettypetext.md + - docs/models/envelopefieldgetunauthorizederror.md + - docs/models/envelopefieldgetunauthorizedissue.md + - docs/models/envelopefieldgetvalue1.md + - docs/models/envelopefieldgetvalue2.md + - docs/models/envelopefieldgetvalue3.md + - docs/models/envelopefieldgetverticalalign1.md + - docs/models/envelopefieldgetverticalalign2.md + - docs/models/envelopefieldupdatemanybadrequesterror.md + - docs/models/envelopefieldupdatemanybadrequestissue.md + - docs/models/envelopefieldupdatemanydatacheckbox.md + - docs/models/envelopefieldupdatemanydatadate.md + - docs/models/envelopefieldupdatemanydatadropdown.md + - docs/models/envelopefieldupdatemanydataemail.md + - docs/models/envelopefieldupdatemanydatafreesignature.md + - docs/models/envelopefieldupdatemanydatainitials.md + - docs/models/envelopefieldupdatemanydataname.md + - docs/models/envelopefieldupdatemanydatanumber.md + - docs/models/envelopefieldupdatemanydataradio.md + - docs/models/envelopefieldupdatemanydataresponse.md + - docs/models/envelopefieldupdatemanydatasignature.md + - docs/models/envelopefieldupdatemanydatatext.md + - docs/models/envelopefieldupdatemanydataunion.md + - docs/models/envelopefieldupdatemanydirectioncheckbox.md + - docs/models/envelopefieldupdatemanydirectionradio.md + - docs/models/envelopefieldupdatemanydirectionresponse1.md + - docs/models/envelopefieldupdatemanydirectionresponse2.md + - docs/models/envelopefieldupdatemanyfieldmetacheckboxrequest.md + - docs/models/envelopefieldupdatemanyfieldmetacheckboxresponse.md + - docs/models/envelopefieldupdatemanyfieldmetadaterequest.md + - docs/models/envelopefieldupdatemanyfieldmetadateresponse.md + - docs/models/envelopefieldupdatemanyfieldmetadropdownrequest.md + - docs/models/envelopefieldupdatemanyfieldmetadropdownresponse.md + - docs/models/envelopefieldupdatemanyfieldmetaemailrequest.md + - docs/models/envelopefieldupdatemanyfieldmetaemailresponse.md + - docs/models/envelopefieldupdatemanyfieldmetainitialsrequest.md + - docs/models/envelopefieldupdatemanyfieldmetainitialsresponse.md + - docs/models/envelopefieldupdatemanyfieldmetanamerequest.md + - docs/models/envelopefieldupdatemanyfieldmetanameresponse.md + - docs/models/envelopefieldupdatemanyfieldmetanumberrequest.md + - docs/models/envelopefieldupdatemanyfieldmetanumberresponse.md + - docs/models/envelopefieldupdatemanyfieldmetaradiorequest.md + - docs/models/envelopefieldupdatemanyfieldmetaradioresponse.md + - docs/models/envelopefieldupdatemanyfieldmetasignaturerequest.md + - docs/models/envelopefieldupdatemanyfieldmetasignatureresponse.md + - docs/models/envelopefieldupdatemanyfieldmetatextrequest.md + - docs/models/envelopefieldupdatemanyfieldmetatextresponse.md + - docs/models/envelopefieldupdatemanyfieldmetatypecheckbox.md + - docs/models/envelopefieldupdatemanyfieldmetatypedate.md + - docs/models/envelopefieldupdatemanyfieldmetatypedropdown.md + - docs/models/envelopefieldupdatemanyfieldmetatypeemail.md + - docs/models/envelopefieldupdatemanyfieldmetatypeinitials.md + - docs/models/envelopefieldupdatemanyfieldmetatypename.md + - docs/models/envelopefieldupdatemanyfieldmetatypenumber.md + - docs/models/envelopefieldupdatemanyfieldmetatyperadio.md + - docs/models/envelopefieldupdatemanyfieldmetatypesignature.md + - docs/models/envelopefieldupdatemanyfieldmetatypetext.md + - docs/models/envelopefieldupdatemanyfieldmetaunion.md + - docs/models/envelopefieldupdatemanyforbiddenerror.md + - docs/models/envelopefieldupdatemanyforbiddenissue.md + - docs/models/envelopefieldupdatemanyinternalservererror.md + - docs/models/envelopefieldupdatemanyinternalservererrorissue.md + - docs/models/envelopefieldupdatemanyrequest.md + - docs/models/envelopefieldupdatemanyresponse.md + - docs/models/envelopefieldupdatemanytextaligndate.md + - docs/models/envelopefieldupdatemanytextalignemail.md + - docs/models/envelopefieldupdatemanytextaligninitials.md + - docs/models/envelopefieldupdatemanytextalignname.md + - docs/models/envelopefieldupdatemanytextalignnumber.md + - docs/models/envelopefieldupdatemanytextalignresponse1.md + - docs/models/envelopefieldupdatemanytextalignresponse2.md + - docs/models/envelopefieldupdatemanytextalignresponse3.md + - docs/models/envelopefieldupdatemanytextalignresponse4.md + - docs/models/envelopefieldupdatemanytextalignresponse5.md + - docs/models/envelopefieldupdatemanytextalignresponse6.md + - docs/models/envelopefieldupdatemanytextaligntext.md + - docs/models/envelopefieldupdatemanytypecheckboxrequest1.md + - docs/models/envelopefieldupdatemanytypecheckboxrequest2.md + - docs/models/envelopefieldupdatemanytypedaterequest1.md + - docs/models/envelopefieldupdatemanytypedaterequest2.md + - docs/models/envelopefieldupdatemanytypedropdownrequest1.md + - docs/models/envelopefieldupdatemanytypedropdownrequest2.md + - docs/models/envelopefieldupdatemanytypeemailrequest1.md + - docs/models/envelopefieldupdatemanytypeemailrequest2.md + - docs/models/envelopefieldupdatemanytypefreesignature.md + - docs/models/envelopefieldupdatemanytypeinitialsrequest1.md + - docs/models/envelopefieldupdatemanytypeinitialsrequest2.md + - docs/models/envelopefieldupdatemanytypenamerequest1.md + - docs/models/envelopefieldupdatemanytypenamerequest2.md + - docs/models/envelopefieldupdatemanytypenumberrequest1.md + - docs/models/envelopefieldupdatemanytypenumberrequest2.md + - docs/models/envelopefieldupdatemanytyperadiorequest1.md + - docs/models/envelopefieldupdatemanytyperadiorequest2.md + - docs/models/envelopefieldupdatemanytyperesponse.md + - docs/models/envelopefieldupdatemanytypesignaturerequest1.md + - docs/models/envelopefieldupdatemanytypesignaturerequest2.md + - docs/models/envelopefieldupdatemanytypetextrequest1.md + - docs/models/envelopefieldupdatemanytypetextrequest2.md + - docs/models/envelopefieldupdatemanyunauthorizederror.md + - docs/models/envelopefieldupdatemanyunauthorizedissue.md + - docs/models/envelopefieldupdatemanyvaluecheckbox.md + - docs/models/envelopefieldupdatemanyvaluedropdown.md + - docs/models/envelopefieldupdatemanyvalueradio.md + - docs/models/envelopefieldupdatemanyvalueresponse1.md + - docs/models/envelopefieldupdatemanyvalueresponse2.md + - docs/models/envelopefieldupdatemanyvalueresponse3.md + - docs/models/envelopefieldupdatemanyverticalalignnumber.md + - docs/models/envelopefieldupdatemanyverticalalignresponse1.md + - docs/models/envelopefieldupdatemanyverticalalignresponse2.md + - docs/models/envelopefieldupdatemanyverticalaligntext.md + - docs/models/envelopegetaccessauth.md + - docs/models/envelopegetactionauth.md + - docs/models/envelopegetauthoptions.md + - docs/models/envelopegetbadrequesterror.md + - docs/models/envelopegetbadrequestissue.md + - docs/models/envelopegetdirection1.md + - docs/models/envelopegetdirection2.md + - docs/models/envelopegetdirectlink.md + - docs/models/envelopegetdistributionmethod.md + - docs/models/envelopegetdocumentmeta.md + - docs/models/envelopegetemailsettings.md + - docs/models/envelopegetenvelopeitem.md + - docs/models/envelopegetfield.md + - docs/models/envelopegetfieldmetacheckbox.md + - docs/models/envelopegetfieldmetadate.md + - docs/models/envelopegetfieldmetadropdown.md + - docs/models/envelopegetfieldmetaemail.md + - docs/models/envelopegetfieldmetainitials.md + - docs/models/envelopegetfieldmetaname.md + - docs/models/envelopegetfieldmetanumber.md + - docs/models/envelopegetfieldmetaradio.md + - docs/models/envelopegetfieldmetasignature.md + - docs/models/envelopegetfieldmetatext.md + - docs/models/envelopegetfieldmetaunion.md + - docs/models/envelopegetfieldtype.md + - docs/models/envelopegetforbiddenerror.md + - docs/models/envelopegetforbiddenissue.md + - docs/models/envelopegetformvalues.md + - docs/models/envelopegetglobalaccessauth.md + - docs/models/envelopegetglobalactionauth.md + - docs/models/envelopegetinternalservererror.md + - docs/models/envelopegetinternalservererrorissue.md + - docs/models/envelopegetnotfounderror.md + - docs/models/envelopegetnotfoundissue.md + - docs/models/envelopegetreadstatus.md + - docs/models/envelopegetrecipient.md + - docs/models/envelopegetrecipientauthoptions.md + - docs/models/envelopegetrequest.md + - docs/models/envelopegetresponse.md + - docs/models/envelopegetrole.md + - docs/models/envelopegetsendstatus.md + - docs/models/envelopegetsigningorder.md + - docs/models/envelopegetsigningstatus.md + - docs/models/envelopegetsource.md + - docs/models/envelopegetstatus.md + - docs/models/envelopegetteam.md + - docs/models/envelopegettemplatetype.md + - docs/models/envelopegettextalign1.md + - docs/models/envelopegettextalign2.md + - docs/models/envelopegettextalign3.md + - docs/models/envelopegettextalign4.md + - docs/models/envelopegettextalign5.md + - docs/models/envelopegettextalign6.md + - docs/models/envelopegettype.md + - docs/models/envelopegettypecheckbox.md + - docs/models/envelopegettypedate.md + - docs/models/envelopegettypedropdown.md + - docs/models/envelopegettypeemail.md + - docs/models/envelopegettypeinitials.md + - docs/models/envelopegettypename.md + - docs/models/envelopegettypenumber.md + - docs/models/envelopegettyperadio.md + - docs/models/envelopegettypesignature.md + - docs/models/envelopegettypetext.md + - docs/models/envelopegetunauthorizederror.md + - docs/models/envelopegetunauthorizedissue.md + - docs/models/envelopegetuser.md + - docs/models/envelopegetvalue1.md + - docs/models/envelopegetvalue2.md + - docs/models/envelopegetvalue3.md + - docs/models/envelopegetverticalalign1.md + - docs/models/envelopegetverticalalign2.md + - docs/models/envelopegetvisibility.md + - docs/models/envelopeitemcreatemanybadrequesterror.md + - docs/models/envelopeitemcreatemanybadrequestissue.md + - docs/models/envelopeitemcreatemanydata.md + - docs/models/envelopeitemcreatemanyfile.md + - docs/models/envelopeitemcreatemanyforbiddenerror.md + - docs/models/envelopeitemcreatemanyforbiddenissue.md + - docs/models/envelopeitemcreatemanyinternalservererror.md + - docs/models/envelopeitemcreatemanyinternalservererrorissue.md + - docs/models/envelopeitemcreatemanypayload.md + - docs/models/envelopeitemcreatemanyrequest.md + - docs/models/envelopeitemcreatemanyresponse.md + - docs/models/envelopeitemcreatemanyunauthorizederror.md + - docs/models/envelopeitemcreatemanyunauthorizedissue.md + - docs/models/envelopeitemdeletebadrequesterror.md + - docs/models/envelopeitemdeletebadrequestissue.md + - docs/models/envelopeitemdeleteforbiddenerror.md + - docs/models/envelopeitemdeleteforbiddenissue.md + - docs/models/envelopeitemdeleteinternalservererror.md + - docs/models/envelopeitemdeleteinternalservererrorissue.md + - docs/models/envelopeitemdeleterequest.md + - docs/models/envelopeitemdeleteresponse.md + - docs/models/envelopeitemdeleteunauthorizederror.md + - docs/models/envelopeitemdeleteunauthorizedissue.md + - docs/models/envelopeitemdownloadbadrequesterror.md + - docs/models/envelopeitemdownloadbadrequestissue.md + - docs/models/envelopeitemdownloadforbiddenerror.md + - docs/models/envelopeitemdownloadforbiddenissue.md + - docs/models/envelopeitemdownloadinternalservererror.md + - docs/models/envelopeitemdownloadinternalservererrorissue.md + - docs/models/envelopeitemdownloadnotfounderror.md + - docs/models/envelopeitemdownloadnotfoundissue.md + - docs/models/envelopeitemdownloadrequest.md + - docs/models/envelopeitemdownloadresponse.md + - docs/models/envelopeitemdownloadunauthorizederror.md + - docs/models/envelopeitemdownloadunauthorizedissue.md + - docs/models/envelopeitemdownloadversion.md + - docs/models/envelopeitemupdatemanybadrequesterror.md + - docs/models/envelopeitemupdatemanybadrequestissue.md + - docs/models/envelopeitemupdatemanydatarequest.md + - docs/models/envelopeitemupdatemanydataresponse.md + - docs/models/envelopeitemupdatemanyforbiddenerror.md + - docs/models/envelopeitemupdatemanyforbiddenissue.md + - docs/models/envelopeitemupdatemanyinternalservererror.md + - docs/models/envelopeitemupdatemanyinternalservererrorissue.md + - docs/models/envelopeitemupdatemanyrequest.md + - docs/models/envelopeitemupdatemanyresponse.md + - docs/models/envelopeitemupdatemanyunauthorizederror.md + - docs/models/envelopeitemupdatemanyunauthorizedissue.md + - docs/models/enveloperecipientcreatemanyaccessauthrequest.md + - docs/models/enveloperecipientcreatemanyaccessauthresponse.md + - docs/models/enveloperecipientcreatemanyactionauthrequest.md + - docs/models/enveloperecipientcreatemanyactionauthresponse.md + - docs/models/enveloperecipientcreatemanyauthoptions.md + - docs/models/enveloperecipientcreatemanybadrequesterror.md + - docs/models/enveloperecipientcreatemanybadrequestissue.md + - docs/models/enveloperecipientcreatemanydatarequest.md + - docs/models/enveloperecipientcreatemanydataresponse.md + - docs/models/enveloperecipientcreatemanyforbiddenerror.md + - docs/models/enveloperecipientcreatemanyforbiddenissue.md + - docs/models/enveloperecipientcreatemanyinternalservererror.md + - docs/models/enveloperecipientcreatemanyinternalservererrorissue.md + - docs/models/enveloperecipientcreatemanyreadstatus.md + - docs/models/enveloperecipientcreatemanyrequest.md + - docs/models/enveloperecipientcreatemanyresponse.md + - docs/models/enveloperecipientcreatemanyrolerequest.md + - docs/models/enveloperecipientcreatemanyroleresponse.md + - docs/models/enveloperecipientcreatemanysendstatus.md + - docs/models/enveloperecipientcreatemanysigningstatus.md + - docs/models/enveloperecipientcreatemanyunauthorizederror.md + - docs/models/enveloperecipientcreatemanyunauthorizedissue.md + - docs/models/enveloperecipientdeletebadrequesterror.md + - docs/models/enveloperecipientdeletebadrequestissue.md + - docs/models/enveloperecipientdeleteforbiddenerror.md + - docs/models/enveloperecipientdeleteforbiddenissue.md + - docs/models/enveloperecipientdeleteinternalservererror.md + - docs/models/enveloperecipientdeleteinternalservererrorissue.md + - docs/models/enveloperecipientdeleterequest.md + - docs/models/enveloperecipientdeleteresponse.md + - docs/models/enveloperecipientdeleteunauthorizederror.md + - docs/models/enveloperecipientdeleteunauthorizedissue.md + - docs/models/enveloperecipientgetaccessauth.md + - docs/models/enveloperecipientgetactionauth.md + - docs/models/enveloperecipientgetauthoptions.md + - docs/models/enveloperecipientgetbadrequesterror.md + - docs/models/enveloperecipientgetbadrequestissue.md + - docs/models/enveloperecipientgetdirection1.md + - docs/models/enveloperecipientgetdirection2.md + - docs/models/enveloperecipientgetfield.md + - docs/models/enveloperecipientgetfieldmetacheckbox.md + - docs/models/enveloperecipientgetfieldmetadate.md + - docs/models/enveloperecipientgetfieldmetadropdown.md + - docs/models/enveloperecipientgetfieldmetaemail.md + - docs/models/enveloperecipientgetfieldmetainitials.md + - docs/models/enveloperecipientgetfieldmetaname.md + - docs/models/enveloperecipientgetfieldmetanumber.md + - docs/models/enveloperecipientgetfieldmetaradio.md + - docs/models/enveloperecipientgetfieldmetasignature.md + - docs/models/enveloperecipientgetfieldmetatext.md + - docs/models/enveloperecipientgetfieldmetaunion.md + - docs/models/enveloperecipientgetforbiddenerror.md + - docs/models/enveloperecipientgetforbiddenissue.md + - docs/models/enveloperecipientgetinternalservererror.md + - docs/models/enveloperecipientgetinternalservererrorissue.md + - docs/models/enveloperecipientgetnotfounderror.md + - docs/models/enveloperecipientgetnotfoundissue.md + - docs/models/enveloperecipientgetreadstatus.md + - docs/models/enveloperecipientgetrequest.md + - docs/models/enveloperecipientgetresponse.md + - docs/models/enveloperecipientgetrole.md + - docs/models/enveloperecipientgetsendstatus.md + - docs/models/enveloperecipientgetsigningstatus.md + - docs/models/enveloperecipientgettextalign1.md + - docs/models/enveloperecipientgettextalign2.md + - docs/models/enveloperecipientgettextalign3.md + - docs/models/enveloperecipientgettextalign4.md + - docs/models/enveloperecipientgettextalign5.md + - docs/models/enveloperecipientgettextalign6.md + - docs/models/enveloperecipientgettype.md + - docs/models/enveloperecipientgettypecheckbox.md + - docs/models/enveloperecipientgettypedate.md + - docs/models/enveloperecipientgettypedropdown.md + - docs/models/enveloperecipientgettypeemail.md + - docs/models/enveloperecipientgettypeinitials.md + - docs/models/enveloperecipientgettypename.md + - docs/models/enveloperecipientgettypenumber.md + - docs/models/enveloperecipientgettyperadio.md + - docs/models/enveloperecipientgettypesignature.md + - docs/models/enveloperecipientgettypetext.md + - docs/models/enveloperecipientgetunauthorizederror.md + - docs/models/enveloperecipientgetunauthorizedissue.md + - docs/models/enveloperecipientgetvalue1.md + - docs/models/enveloperecipientgetvalue2.md + - docs/models/enveloperecipientgetvalue3.md + - docs/models/enveloperecipientgetverticalalign1.md + - docs/models/enveloperecipientgetverticalalign2.md + - docs/models/enveloperecipientupdatemanyaccessauthrequest.md + - docs/models/enveloperecipientupdatemanyaccessauthresponse.md + - docs/models/enveloperecipientupdatemanyactionauthrequest.md + - docs/models/enveloperecipientupdatemanyactionauthresponse.md + - docs/models/enveloperecipientupdatemanyauthoptions.md + - docs/models/enveloperecipientupdatemanybadrequesterror.md + - docs/models/enveloperecipientupdatemanybadrequestissue.md + - docs/models/enveloperecipientupdatemanydatarequest.md + - docs/models/enveloperecipientupdatemanydataresponse.md + - docs/models/enveloperecipientupdatemanyforbiddenerror.md + - docs/models/enveloperecipientupdatemanyforbiddenissue.md + - docs/models/enveloperecipientupdatemanyinternalservererror.md + - docs/models/enveloperecipientupdatemanyinternalservererrorissue.md + - docs/models/enveloperecipientupdatemanyreadstatus.md + - docs/models/enveloperecipientupdatemanyrequest.md + - docs/models/enveloperecipientupdatemanyresponse.md + - docs/models/enveloperecipientupdatemanyrolerequest.md + - docs/models/enveloperecipientupdatemanyroleresponse.md + - docs/models/enveloperecipientupdatemanysendstatus.md + - docs/models/enveloperecipientupdatemanysigningstatus.md + - docs/models/enveloperecipientupdatemanyunauthorizederror.md + - docs/models/enveloperecipientupdatemanyunauthorizedissue.md + - docs/models/enveloperedistributebadrequesterror.md + - docs/models/enveloperedistributebadrequestissue.md + - docs/models/enveloperedistributeforbiddenerror.md + - docs/models/enveloperedistributeforbiddenissue.md + - docs/models/enveloperedistributeinternalservererror.md + - docs/models/enveloperedistributeinternalservererrorissue.md + - docs/models/enveloperedistributerequest.md + - docs/models/enveloperedistributeresponse.md + - docs/models/enveloperedistributeunauthorizederror.md + - docs/models/enveloperedistributeunauthorizedissue.md + - docs/models/envelopeupdateauthoptions.md + - docs/models/envelopeupdatebadrequesterror.md + - docs/models/envelopeupdatebadrequestissue.md + - docs/models/envelopeupdatedata.md + - docs/models/envelopeupdatedataglobalaccessauth.md + - docs/models/envelopeupdatedataglobalactionauth.md + - docs/models/envelopeupdatedatavisibility.md + - docs/models/envelopeupdatedateformat.md + - docs/models/envelopeupdatedistributionmethod.md + - docs/models/envelopeupdateemailsettings.md + - docs/models/envelopeupdateforbiddenerror.md + - docs/models/envelopeupdateforbiddenissue.md + - docs/models/envelopeupdateformvalues.md + - docs/models/envelopeupdateglobalaccessauthresponse.md + - docs/models/envelopeupdateglobalactionauthresponse.md + - docs/models/envelopeupdateinternalservererror.md + - docs/models/envelopeupdateinternalservererrorissue.md + - docs/models/envelopeupdatelanguage.md + - docs/models/envelopeupdatemeta.md + - docs/models/envelopeupdaterequest.md + - docs/models/envelopeupdateresponse.md + - docs/models/envelopeupdatesigningorder.md + - docs/models/envelopeupdatesource.md + - docs/models/envelopeupdatestatus.md + - docs/models/envelopeupdatetemplatetype.md + - docs/models/envelopeupdatetype.md + - docs/models/envelopeupdateunauthorizederror.md + - docs/models/envelopeupdateunauthorizedissue.md + - docs/models/envelopeupdatevisibilityresponse.md + - docs/models/envelopeuseattachment.md + - docs/models/envelopeusebadrequesterror.md + - docs/models/envelopeusebadrequestissue.md + - docs/models/envelopeusecustomdocumentdatum.md + - docs/models/envelopeusedateformat.md + - docs/models/envelopeusedistributionmethod.md + - docs/models/envelopeuseemailsettings.md + - docs/models/envelopeusefile.md + - docs/models/envelopeuseforbiddenerror.md + - docs/models/envelopeuseforbiddenissue.md + - docs/models/envelopeuseidentifier.md + - docs/models/envelopeuseinternalservererror.md + - docs/models/envelopeuseinternalservererrorissue.md + - docs/models/envelopeuselanguage.md + - docs/models/envelopeusepayload.md + - docs/models/envelopeuseprefillfieldcheckbox.md + - docs/models/envelopeuseprefillfielddate.md + - docs/models/envelopeuseprefillfielddropdown.md + - docs/models/envelopeuseprefillfieldnumber.md + - docs/models/envelopeuseprefillfieldradio.md + - docs/models/envelopeuseprefillfieldtext.md + - docs/models/envelopeuseprefillfieldunion.md + - docs/models/envelopeuserecipient.md + - docs/models/envelopeuserequest.md + - docs/models/envelopeuseresponse.md + - docs/models/envelopeusetypecheckbox.md + - docs/models/envelopeusetypedate.md + - docs/models/envelopeusetypedropdown.md + - docs/models/envelopeusetypelink.md + - docs/models/envelopeusetypenumber.md + - docs/models/envelopeusetyperadio.md + - docs/models/envelopeusetypetext.md + - docs/models/envelopeuseunauthorizederror.md + - docs/models/envelopeuseunauthorizedissue.md - docs/models/fieldcreatedocumentfieldbadrequesterror.md - docs/models/fieldcreatedocumentfieldbadrequestissue.md + - docs/models/fieldcreatedocumentfielddirectioncheckbox.md + - docs/models/fieldcreatedocumentfielddirectionradio.md + - docs/models/fieldcreatedocumentfielddirectionresponse1.md + - docs/models/fieldcreatedocumentfielddirectionresponse2.md - docs/models/fieldcreatedocumentfieldfieldcheckbox.md - docs/models/fieldcreatedocumentfieldfielddate.md - docs/models/fieldcreatedocumentfieldfielddropdown.md @@ -338,6 +1304,8 @@ generatedFiles: - docs/models/fieldcreatedocumentfieldfieldmetanumberresponse.md - docs/models/fieldcreatedocumentfieldfieldmetaradiorequest.md - docs/models/fieldcreatedocumentfieldfieldmetaradioresponse.md + - docs/models/fieldcreatedocumentfieldfieldmetasignaturerequest.md + - docs/models/fieldcreatedocumentfieldfieldmetasignatureresponse.md - docs/models/fieldcreatedocumentfieldfieldmetatextrequest.md - docs/models/fieldcreatedocumentfieldfieldmetatextresponse.md - docs/models/fieldcreatedocumentfieldfieldmetatypecheckbox.md @@ -348,6 +1316,7 @@ generatedFiles: - docs/models/fieldcreatedocumentfieldfieldmetatypename.md - docs/models/fieldcreatedocumentfieldfieldmetatypenumber.md - docs/models/fieldcreatedocumentfieldfieldmetatyperadio.md + - docs/models/fieldcreatedocumentfieldfieldmetatypesignature.md - docs/models/fieldcreatedocumentfieldfieldmetatypetext.md - docs/models/fieldcreatedocumentfieldfieldmetaunion.md - docs/models/fieldcreatedocumentfieldfieldname.md @@ -356,12 +1325,18 @@ generatedFiles: - docs/models/fieldcreatedocumentfieldfieldsignature.md - docs/models/fieldcreatedocumentfieldfieldtext.md - docs/models/fieldcreatedocumentfieldfieldunion.md + - docs/models/fieldcreatedocumentfieldforbiddenerror.md + - docs/models/fieldcreatedocumentfieldforbiddenissue.md - docs/models/fieldcreatedocumentfieldinternalservererror.md - docs/models/fieldcreatedocumentfieldinternalservererrorissue.md - docs/models/fieldcreatedocumentfieldrequest.md - docs/models/fieldcreatedocumentfieldresponse.md - docs/models/fieldcreatedocumentfieldsbadrequesterror.md - docs/models/fieldcreatedocumentfieldsbadrequestissue.md + - docs/models/fieldcreatedocumentfieldsdirectioncheckbox.md + - docs/models/fieldcreatedocumentfieldsdirectionradio.md + - docs/models/fieldcreatedocumentfieldsdirectionresponse1.md + - docs/models/fieldcreatedocumentfieldsdirectionresponse2.md - docs/models/fieldcreatedocumentfieldsfieldcheckbox.md - docs/models/fieldcreatedocumentfieldsfielddate.md - docs/models/fieldcreatedocumentfieldsfielddropdown.md @@ -384,6 +1359,8 @@ generatedFiles: - docs/models/fieldcreatedocumentfieldsfieldmetanumberresponse.md - docs/models/fieldcreatedocumentfieldsfieldmetaradiorequest.md - docs/models/fieldcreatedocumentfieldsfieldmetaradioresponse.md + - docs/models/fieldcreatedocumentfieldsfieldmetasignaturerequest.md + - docs/models/fieldcreatedocumentfieldsfieldmetasignatureresponse.md - docs/models/fieldcreatedocumentfieldsfieldmetatextrequest.md - docs/models/fieldcreatedocumentfieldsfieldmetatextresponse.md - docs/models/fieldcreatedocumentfieldsfieldmetatypecheckbox.md @@ -394,6 +1371,7 @@ generatedFiles: - docs/models/fieldcreatedocumentfieldsfieldmetatypename.md - docs/models/fieldcreatedocumentfieldsfieldmetatypenumber.md - docs/models/fieldcreatedocumentfieldsfieldmetatyperadio.md + - docs/models/fieldcreatedocumentfieldsfieldmetatypesignature.md - docs/models/fieldcreatedocumentfieldsfieldmetatypetext.md - docs/models/fieldcreatedocumentfieldsfieldmetaunion.md - docs/models/fieldcreatedocumentfieldsfieldname.md @@ -403,6 +1381,8 @@ generatedFiles: - docs/models/fieldcreatedocumentfieldsfieldsignature.md - docs/models/fieldcreatedocumentfieldsfieldtext.md - docs/models/fieldcreatedocumentfieldsfieldunion.md + - docs/models/fieldcreatedocumentfieldsforbiddenerror.md + - docs/models/fieldcreatedocumentfieldsforbiddenissue.md - docs/models/fieldcreatedocumentfieldsinternalservererror.md - docs/models/fieldcreatedocumentfieldsinternalservererrorissue.md - docs/models/fieldcreatedocumentfieldsrequest.md @@ -437,15 +1417,22 @@ generatedFiles: - docs/models/fieldcreatedocumentfieldstyperadiorequest1.md - docs/models/fieldcreatedocumentfieldstyperadiorequest2.md - docs/models/fieldcreatedocumentfieldstyperesponse.md - - docs/models/fieldcreatedocumentfieldstypesignature.md + - docs/models/fieldcreatedocumentfieldstypesignaturerequest1.md + - docs/models/fieldcreatedocumentfieldstypesignaturerequest2.md - docs/models/fieldcreatedocumentfieldstypetextrequest1.md - docs/models/fieldcreatedocumentfieldstypetextrequest2.md + - docs/models/fieldcreatedocumentfieldsunauthorizederror.md + - docs/models/fieldcreatedocumentfieldsunauthorizedissue.md - docs/models/fieldcreatedocumentfieldsvaluecheckbox.md - docs/models/fieldcreatedocumentfieldsvaluedropdown.md - docs/models/fieldcreatedocumentfieldsvalueradio.md - docs/models/fieldcreatedocumentfieldsvalueresponse1.md - docs/models/fieldcreatedocumentfieldsvalueresponse2.md - docs/models/fieldcreatedocumentfieldsvalueresponse3.md + - docs/models/fieldcreatedocumentfieldsverticalalignnumber.md + - docs/models/fieldcreatedocumentfieldsverticalalignresponse1.md + - docs/models/fieldcreatedocumentfieldsverticalalignresponse2.md + - docs/models/fieldcreatedocumentfieldsverticalaligntext.md - docs/models/fieldcreatedocumentfieldtextaligndate.md - docs/models/fieldcreatedocumentfieldtextalignemail.md - docs/models/fieldcreatedocumentfieldtextaligninitials.md @@ -476,17 +1463,28 @@ generatedFiles: - docs/models/fieldcreatedocumentfieldtyperadiorequest1.md - docs/models/fieldcreatedocumentfieldtyperadiorequest2.md - docs/models/fieldcreatedocumentfieldtyperesponse.md - - docs/models/fieldcreatedocumentfieldtypesignature.md + - docs/models/fieldcreatedocumentfieldtypesignaturerequest1.md + - docs/models/fieldcreatedocumentfieldtypesignaturerequest2.md - docs/models/fieldcreatedocumentfieldtypetextrequest1.md - docs/models/fieldcreatedocumentfieldtypetextrequest2.md + - docs/models/fieldcreatedocumentfieldunauthorizederror.md + - docs/models/fieldcreatedocumentfieldunauthorizedissue.md - docs/models/fieldcreatedocumentfieldvaluecheckbox.md - docs/models/fieldcreatedocumentfieldvaluedropdown.md - docs/models/fieldcreatedocumentfieldvalueradio.md - docs/models/fieldcreatedocumentfieldvalueresponse1.md - docs/models/fieldcreatedocumentfieldvalueresponse2.md - docs/models/fieldcreatedocumentfieldvalueresponse3.md + - docs/models/fieldcreatedocumentfieldverticalalignnumber.md + - docs/models/fieldcreatedocumentfieldverticalalignresponse1.md + - docs/models/fieldcreatedocumentfieldverticalalignresponse2.md + - docs/models/fieldcreatedocumentfieldverticalaligntext.md - docs/models/fieldcreatetemplatefieldbadrequesterror.md - docs/models/fieldcreatetemplatefieldbadrequestissue.md + - docs/models/fieldcreatetemplatefielddirectioncheckbox.md + - docs/models/fieldcreatetemplatefielddirectionradio.md + - docs/models/fieldcreatetemplatefielddirectionresponse1.md + - docs/models/fieldcreatetemplatefielddirectionresponse2.md - docs/models/fieldcreatetemplatefieldfieldcheckbox.md - docs/models/fieldcreatetemplatefieldfielddate.md - docs/models/fieldcreatetemplatefieldfielddropdown.md @@ -509,6 +1507,8 @@ generatedFiles: - docs/models/fieldcreatetemplatefieldfieldmetanumberresponse.md - docs/models/fieldcreatetemplatefieldfieldmetaradiorequest.md - docs/models/fieldcreatetemplatefieldfieldmetaradioresponse.md + - docs/models/fieldcreatetemplatefieldfieldmetasignaturerequest.md + - docs/models/fieldcreatetemplatefieldfieldmetasignatureresponse.md - docs/models/fieldcreatetemplatefieldfieldmetatextrequest.md - docs/models/fieldcreatetemplatefieldfieldmetatextresponse.md - docs/models/fieldcreatetemplatefieldfieldmetatypecheckbox.md @@ -519,6 +1519,7 @@ generatedFiles: - docs/models/fieldcreatetemplatefieldfieldmetatypename.md - docs/models/fieldcreatetemplatefieldfieldmetatypenumber.md - docs/models/fieldcreatetemplatefieldfieldmetatyperadio.md + - docs/models/fieldcreatetemplatefieldfieldmetatypesignature.md - docs/models/fieldcreatetemplatefieldfieldmetatypetext.md - docs/models/fieldcreatetemplatefieldfieldmetaunion.md - docs/models/fieldcreatetemplatefieldfieldname.md @@ -527,12 +1528,18 @@ generatedFiles: - docs/models/fieldcreatetemplatefieldfieldsignature.md - docs/models/fieldcreatetemplatefieldfieldtext.md - docs/models/fieldcreatetemplatefieldfieldunion.md + - docs/models/fieldcreatetemplatefieldforbiddenerror.md + - docs/models/fieldcreatetemplatefieldforbiddenissue.md - docs/models/fieldcreatetemplatefieldinternalservererror.md - docs/models/fieldcreatetemplatefieldinternalservererrorissue.md - docs/models/fieldcreatetemplatefieldrequest.md - docs/models/fieldcreatetemplatefieldresponse.md - docs/models/fieldcreatetemplatefieldsbadrequesterror.md - docs/models/fieldcreatetemplatefieldsbadrequestissue.md + - docs/models/fieldcreatetemplatefieldsdirectioncheckbox.md + - docs/models/fieldcreatetemplatefieldsdirectionradio.md + - docs/models/fieldcreatetemplatefieldsdirectionresponse1.md + - docs/models/fieldcreatetemplatefieldsdirectionresponse2.md - docs/models/fieldcreatetemplatefieldsfieldcheckbox.md - docs/models/fieldcreatetemplatefieldsfielddate.md - docs/models/fieldcreatetemplatefieldsfielddropdown.md @@ -555,6 +1562,8 @@ generatedFiles: - docs/models/fieldcreatetemplatefieldsfieldmetanumberresponse.md - docs/models/fieldcreatetemplatefieldsfieldmetaradiorequest.md - docs/models/fieldcreatetemplatefieldsfieldmetaradioresponse.md + - docs/models/fieldcreatetemplatefieldsfieldmetasignaturerequest.md + - docs/models/fieldcreatetemplatefieldsfieldmetasignatureresponse.md - docs/models/fieldcreatetemplatefieldsfieldmetatextrequest.md - docs/models/fieldcreatetemplatefieldsfieldmetatextresponse.md - docs/models/fieldcreatetemplatefieldsfieldmetatypecheckbox.md @@ -565,6 +1574,7 @@ generatedFiles: - docs/models/fieldcreatetemplatefieldsfieldmetatypename.md - docs/models/fieldcreatetemplatefieldsfieldmetatypenumber.md - docs/models/fieldcreatetemplatefieldsfieldmetatyperadio.md + - docs/models/fieldcreatetemplatefieldsfieldmetatypesignature.md - docs/models/fieldcreatetemplatefieldsfieldmetatypetext.md - docs/models/fieldcreatetemplatefieldsfieldmetaunion.md - docs/models/fieldcreatetemplatefieldsfieldname.md @@ -574,6 +1584,8 @@ generatedFiles: - docs/models/fieldcreatetemplatefieldsfieldsignature.md - docs/models/fieldcreatetemplatefieldsfieldtext.md - docs/models/fieldcreatetemplatefieldsfieldunion.md + - docs/models/fieldcreatetemplatefieldsforbiddenerror.md + - docs/models/fieldcreatetemplatefieldsforbiddenissue.md - docs/models/fieldcreatetemplatefieldsinternalservererror.md - docs/models/fieldcreatetemplatefieldsinternalservererrorissue.md - docs/models/fieldcreatetemplatefieldsrequest.md @@ -608,15 +1620,22 @@ generatedFiles: - docs/models/fieldcreatetemplatefieldstyperadiorequest1.md - docs/models/fieldcreatetemplatefieldstyperadiorequest2.md - docs/models/fieldcreatetemplatefieldstyperesponse.md - - docs/models/fieldcreatetemplatefieldstypesignature.md + - docs/models/fieldcreatetemplatefieldstypesignaturerequest1.md + - docs/models/fieldcreatetemplatefieldstypesignaturerequest2.md - docs/models/fieldcreatetemplatefieldstypetextrequest1.md - docs/models/fieldcreatetemplatefieldstypetextrequest2.md + - docs/models/fieldcreatetemplatefieldsunauthorizederror.md + - docs/models/fieldcreatetemplatefieldsunauthorizedissue.md - docs/models/fieldcreatetemplatefieldsvaluecheckbox.md - docs/models/fieldcreatetemplatefieldsvaluedropdown.md - docs/models/fieldcreatetemplatefieldsvalueradio.md - docs/models/fieldcreatetemplatefieldsvalueresponse1.md - docs/models/fieldcreatetemplatefieldsvalueresponse2.md - docs/models/fieldcreatetemplatefieldsvalueresponse3.md + - docs/models/fieldcreatetemplatefieldsverticalalignnumber.md + - docs/models/fieldcreatetemplatefieldsverticalalignresponse1.md + - docs/models/fieldcreatetemplatefieldsverticalalignresponse2.md + - docs/models/fieldcreatetemplatefieldsverticalaligntext.md - docs/models/fieldcreatetemplatefieldtextaligndate.md - docs/models/fieldcreatetemplatefieldtextalignemail.md - docs/models/fieldcreatetemplatefieldtextaligninitials.md @@ -647,29 +1666,46 @@ generatedFiles: - docs/models/fieldcreatetemplatefieldtyperadiorequest1.md - docs/models/fieldcreatetemplatefieldtyperadiorequest2.md - docs/models/fieldcreatetemplatefieldtyperesponse.md - - docs/models/fieldcreatetemplatefieldtypesignature.md + - docs/models/fieldcreatetemplatefieldtypesignaturerequest1.md + - docs/models/fieldcreatetemplatefieldtypesignaturerequest2.md - docs/models/fieldcreatetemplatefieldtypetextrequest1.md - docs/models/fieldcreatetemplatefieldtypetextrequest2.md + - docs/models/fieldcreatetemplatefieldunauthorizederror.md + - docs/models/fieldcreatetemplatefieldunauthorizedissue.md - docs/models/fieldcreatetemplatefieldvaluecheckbox.md - docs/models/fieldcreatetemplatefieldvaluedropdown.md - docs/models/fieldcreatetemplatefieldvalueradio.md - docs/models/fieldcreatetemplatefieldvalueresponse1.md - docs/models/fieldcreatetemplatefieldvalueresponse2.md - docs/models/fieldcreatetemplatefieldvalueresponse3.md + - docs/models/fieldcreatetemplatefieldverticalalignnumber.md + - docs/models/fieldcreatetemplatefieldverticalalignresponse1.md + - docs/models/fieldcreatetemplatefieldverticalalignresponse2.md + - docs/models/fieldcreatetemplatefieldverticalaligntext.md - docs/models/fielddeletedocumentfieldbadrequesterror.md - docs/models/fielddeletedocumentfieldbadrequestissue.md + - docs/models/fielddeletedocumentfieldforbiddenerror.md + - docs/models/fielddeletedocumentfieldforbiddenissue.md - docs/models/fielddeletedocumentfieldinternalservererror.md - docs/models/fielddeletedocumentfieldinternalservererrorissue.md - docs/models/fielddeletedocumentfieldrequest.md - docs/models/fielddeletedocumentfieldresponse.md + - docs/models/fielddeletedocumentfieldunauthorizederror.md + - docs/models/fielddeletedocumentfieldunauthorizedissue.md - docs/models/fielddeletetemplatefieldbadrequesterror.md - docs/models/fielddeletetemplatefieldbadrequestissue.md + - docs/models/fielddeletetemplatefieldforbiddenerror.md + - docs/models/fielddeletetemplatefieldforbiddenissue.md - docs/models/fielddeletetemplatefieldinternalservererror.md - docs/models/fielddeletetemplatefieldinternalservererrorissue.md - docs/models/fielddeletetemplatefieldrequest.md - docs/models/fielddeletetemplatefieldresponse.md + - docs/models/fielddeletetemplatefieldunauthorizederror.md + - docs/models/fielddeletetemplatefieldunauthorizedissue.md - docs/models/fieldgetdocumentfieldbadrequesterror.md - docs/models/fieldgetdocumentfieldbadrequestissue.md + - docs/models/fieldgetdocumentfielddirection1.md + - docs/models/fieldgetdocumentfielddirection2.md - docs/models/fieldgetdocumentfieldfieldmetacheckbox.md - docs/models/fieldgetdocumentfieldfieldmetadate.md - docs/models/fieldgetdocumentfieldfieldmetadropdown.md @@ -678,8 +1714,11 @@ generatedFiles: - docs/models/fieldgetdocumentfieldfieldmetaname.md - docs/models/fieldgetdocumentfieldfieldmetanumber.md - docs/models/fieldgetdocumentfieldfieldmetaradio.md + - docs/models/fieldgetdocumentfieldfieldmetasignature.md - docs/models/fieldgetdocumentfieldfieldmetatext.md - docs/models/fieldgetdocumentfieldfieldmetaunion.md + - docs/models/fieldgetdocumentfieldforbiddenerror.md + - docs/models/fieldgetdocumentfieldforbiddenissue.md - docs/models/fieldgetdocumentfieldinternalservererror.md - docs/models/fieldgetdocumentfieldinternalservererrorissue.md - docs/models/fieldgetdocumentfieldnotfounderror.md @@ -701,12 +1740,19 @@ generatedFiles: - docs/models/fieldgetdocumentfieldtypename.md - docs/models/fieldgetdocumentfieldtypenumber.md - docs/models/fieldgetdocumentfieldtyperadio.md + - docs/models/fieldgetdocumentfieldtypesignature.md - docs/models/fieldgetdocumentfieldtypetext.md + - docs/models/fieldgetdocumentfieldunauthorizederror.md + - docs/models/fieldgetdocumentfieldunauthorizedissue.md - docs/models/fieldgetdocumentfieldvalue1.md - docs/models/fieldgetdocumentfieldvalue2.md - docs/models/fieldgetdocumentfieldvalue3.md + - docs/models/fieldgetdocumentfieldverticalalign1.md + - docs/models/fieldgetdocumentfieldverticalalign2.md - docs/models/fieldgettemplatefieldbadrequesterror.md - docs/models/fieldgettemplatefieldbadrequestissue.md + - docs/models/fieldgettemplatefielddirection1.md + - docs/models/fieldgettemplatefielddirection2.md - docs/models/fieldgettemplatefieldfieldmetacheckbox.md - docs/models/fieldgettemplatefieldfieldmetadate.md - docs/models/fieldgettemplatefieldfieldmetadropdown.md @@ -715,8 +1761,11 @@ generatedFiles: - docs/models/fieldgettemplatefieldfieldmetaname.md - docs/models/fieldgettemplatefieldfieldmetanumber.md - docs/models/fieldgettemplatefieldfieldmetaradio.md + - docs/models/fieldgettemplatefieldfieldmetasignature.md - docs/models/fieldgettemplatefieldfieldmetatext.md - docs/models/fieldgettemplatefieldfieldmetaunion.md + - docs/models/fieldgettemplatefieldforbiddenerror.md + - docs/models/fieldgettemplatefieldforbiddenissue.md - docs/models/fieldgettemplatefieldinternalservererror.md - docs/models/fieldgettemplatefieldinternalservererrorissue.md - docs/models/fieldgettemplatefieldnotfounderror.md @@ -738,10 +1787,15 @@ generatedFiles: - docs/models/fieldgettemplatefieldtypename.md - docs/models/fieldgettemplatefieldtypenumber.md - docs/models/fieldgettemplatefieldtyperadio.md + - docs/models/fieldgettemplatefieldtypesignature.md - docs/models/fieldgettemplatefieldtypetext.md + - docs/models/fieldgettemplatefieldunauthorizederror.md + - docs/models/fieldgettemplatefieldunauthorizedissue.md - docs/models/fieldgettemplatefieldvalue1.md - docs/models/fieldgettemplatefieldvalue2.md - docs/models/fieldgettemplatefieldvalue3.md + - docs/models/fieldgettemplatefieldverticalalign1.md + - docs/models/fieldgettemplatefieldverticalalign2.md - docs/models/fieldmetadocumentcheckbox.md - docs/models/fieldmetadocumentdate.md - docs/models/fieldmetadocumentdropdown.md @@ -750,9 +1804,14 @@ generatedFiles: - docs/models/fieldmetadocumentname.md - docs/models/fieldmetadocumentnumber.md - docs/models/fieldmetadocumentradio.md + - docs/models/fieldmetadocumentsignature.md - docs/models/fieldmetadocumenttext.md - docs/models/fieldupdatedocumentfieldbadrequesterror.md - docs/models/fieldupdatedocumentfieldbadrequestissue.md + - docs/models/fieldupdatedocumentfielddirectioncheckbox.md + - docs/models/fieldupdatedocumentfielddirectionradio.md + - docs/models/fieldupdatedocumentfielddirectionresponse1.md + - docs/models/fieldupdatedocumentfielddirectionresponse2.md - docs/models/fieldupdatedocumentfieldfieldcheckbox.md - docs/models/fieldupdatedocumentfieldfielddate.md - docs/models/fieldupdatedocumentfieldfielddropdown.md @@ -775,6 +1834,8 @@ generatedFiles: - docs/models/fieldupdatedocumentfieldfieldmetanumberresponse.md - docs/models/fieldupdatedocumentfieldfieldmetaradiorequest.md - docs/models/fieldupdatedocumentfieldfieldmetaradioresponse.md + - docs/models/fieldupdatedocumentfieldfieldmetasignaturerequest.md + - docs/models/fieldupdatedocumentfieldfieldmetasignatureresponse.md - docs/models/fieldupdatedocumentfieldfieldmetatextrequest.md - docs/models/fieldupdatedocumentfieldfieldmetatextresponse.md - docs/models/fieldupdatedocumentfieldfieldmetatypecheckbox.md @@ -785,6 +1846,7 @@ generatedFiles: - docs/models/fieldupdatedocumentfieldfieldmetatypename.md - docs/models/fieldupdatedocumentfieldfieldmetatypenumber.md - docs/models/fieldupdatedocumentfieldfieldmetatyperadio.md + - docs/models/fieldupdatedocumentfieldfieldmetatypesignature.md - docs/models/fieldupdatedocumentfieldfieldmetatypetext.md - docs/models/fieldupdatedocumentfieldfieldmetaunion.md - docs/models/fieldupdatedocumentfieldfieldname.md @@ -793,12 +1855,18 @@ generatedFiles: - docs/models/fieldupdatedocumentfieldfieldsignature.md - docs/models/fieldupdatedocumentfieldfieldtext.md - docs/models/fieldupdatedocumentfieldfieldunion.md + - docs/models/fieldupdatedocumentfieldforbiddenerror.md + - docs/models/fieldupdatedocumentfieldforbiddenissue.md - docs/models/fieldupdatedocumentfieldinternalservererror.md - docs/models/fieldupdatedocumentfieldinternalservererrorissue.md - docs/models/fieldupdatedocumentfieldrequest.md - docs/models/fieldupdatedocumentfieldresponse.md - docs/models/fieldupdatedocumentfieldsbadrequesterror.md - docs/models/fieldupdatedocumentfieldsbadrequestissue.md + - docs/models/fieldupdatedocumentfieldsdirectioncheckbox.md + - docs/models/fieldupdatedocumentfieldsdirectionradio.md + - docs/models/fieldupdatedocumentfieldsdirectionresponse1.md + - docs/models/fieldupdatedocumentfieldsdirectionresponse2.md - docs/models/fieldupdatedocumentfieldsfieldcheckbox.md - docs/models/fieldupdatedocumentfieldsfielddate.md - docs/models/fieldupdatedocumentfieldsfielddropdown.md @@ -821,6 +1889,8 @@ generatedFiles: - docs/models/fieldupdatedocumentfieldsfieldmetanumberresponse.md - docs/models/fieldupdatedocumentfieldsfieldmetaradiorequest.md - docs/models/fieldupdatedocumentfieldsfieldmetaradioresponse.md + - docs/models/fieldupdatedocumentfieldsfieldmetasignaturerequest.md + - docs/models/fieldupdatedocumentfieldsfieldmetasignatureresponse.md - docs/models/fieldupdatedocumentfieldsfieldmetatextrequest.md - docs/models/fieldupdatedocumentfieldsfieldmetatextresponse.md - docs/models/fieldupdatedocumentfieldsfieldmetatypecheckbox.md @@ -831,6 +1901,7 @@ generatedFiles: - docs/models/fieldupdatedocumentfieldsfieldmetatypename.md - docs/models/fieldupdatedocumentfieldsfieldmetatypenumber.md - docs/models/fieldupdatedocumentfieldsfieldmetatyperadio.md + - docs/models/fieldupdatedocumentfieldsfieldmetatypesignature.md - docs/models/fieldupdatedocumentfieldsfieldmetatypetext.md - docs/models/fieldupdatedocumentfieldsfieldmetaunion.md - docs/models/fieldupdatedocumentfieldsfieldname.md @@ -840,6 +1911,8 @@ generatedFiles: - docs/models/fieldupdatedocumentfieldsfieldsignature.md - docs/models/fieldupdatedocumentfieldsfieldtext.md - docs/models/fieldupdatedocumentfieldsfieldunion.md + - docs/models/fieldupdatedocumentfieldsforbiddenerror.md + - docs/models/fieldupdatedocumentfieldsforbiddenissue.md - docs/models/fieldupdatedocumentfieldsinternalservererror.md - docs/models/fieldupdatedocumentfieldsinternalservererrorissue.md - docs/models/fieldupdatedocumentfieldsrequest.md @@ -874,15 +1947,22 @@ generatedFiles: - docs/models/fieldupdatedocumentfieldstyperadiorequest1.md - docs/models/fieldupdatedocumentfieldstyperadiorequest2.md - docs/models/fieldupdatedocumentfieldstyperesponse.md - - docs/models/fieldupdatedocumentfieldstypesignature.md + - docs/models/fieldupdatedocumentfieldstypesignaturerequest1.md + - docs/models/fieldupdatedocumentfieldstypesignaturerequest2.md - docs/models/fieldupdatedocumentfieldstypetextrequest1.md - docs/models/fieldupdatedocumentfieldstypetextrequest2.md + - docs/models/fieldupdatedocumentfieldsunauthorizederror.md + - docs/models/fieldupdatedocumentfieldsunauthorizedissue.md - docs/models/fieldupdatedocumentfieldsvaluecheckbox.md - docs/models/fieldupdatedocumentfieldsvaluedropdown.md - docs/models/fieldupdatedocumentfieldsvalueradio.md - docs/models/fieldupdatedocumentfieldsvalueresponse1.md - docs/models/fieldupdatedocumentfieldsvalueresponse2.md - docs/models/fieldupdatedocumentfieldsvalueresponse3.md + - docs/models/fieldupdatedocumentfieldsverticalalignnumber.md + - docs/models/fieldupdatedocumentfieldsverticalalignresponse1.md + - docs/models/fieldupdatedocumentfieldsverticalalignresponse2.md + - docs/models/fieldupdatedocumentfieldsverticalaligntext.md - docs/models/fieldupdatedocumentfieldtextaligndate.md - docs/models/fieldupdatedocumentfieldtextalignemail.md - docs/models/fieldupdatedocumentfieldtextaligninitials.md @@ -913,17 +1993,28 @@ generatedFiles: - docs/models/fieldupdatedocumentfieldtyperadiorequest1.md - docs/models/fieldupdatedocumentfieldtyperadiorequest2.md - docs/models/fieldupdatedocumentfieldtyperesponse.md - - docs/models/fieldupdatedocumentfieldtypesignature.md + - docs/models/fieldupdatedocumentfieldtypesignaturerequest1.md + - docs/models/fieldupdatedocumentfieldtypesignaturerequest2.md - docs/models/fieldupdatedocumentfieldtypetextrequest1.md - docs/models/fieldupdatedocumentfieldtypetextrequest2.md + - docs/models/fieldupdatedocumentfieldunauthorizederror.md + - docs/models/fieldupdatedocumentfieldunauthorizedissue.md - docs/models/fieldupdatedocumentfieldvaluecheckbox.md - docs/models/fieldupdatedocumentfieldvaluedropdown.md - docs/models/fieldupdatedocumentfieldvalueradio.md - docs/models/fieldupdatedocumentfieldvalueresponse1.md - docs/models/fieldupdatedocumentfieldvalueresponse2.md - docs/models/fieldupdatedocumentfieldvalueresponse3.md + - docs/models/fieldupdatedocumentfieldverticalalignnumber.md + - docs/models/fieldupdatedocumentfieldverticalalignresponse1.md + - docs/models/fieldupdatedocumentfieldverticalalignresponse2.md + - docs/models/fieldupdatedocumentfieldverticalaligntext.md - docs/models/fieldupdatetemplatefieldbadrequesterror.md - docs/models/fieldupdatetemplatefieldbadrequestissue.md + - docs/models/fieldupdatetemplatefielddirectioncheckbox.md + - docs/models/fieldupdatetemplatefielddirectionradio.md + - docs/models/fieldupdatetemplatefielddirectionresponse1.md + - docs/models/fieldupdatetemplatefielddirectionresponse2.md - docs/models/fieldupdatetemplatefieldfieldcheckbox.md - docs/models/fieldupdatetemplatefieldfielddate.md - docs/models/fieldupdatetemplatefieldfielddropdown.md @@ -946,6 +2037,8 @@ generatedFiles: - docs/models/fieldupdatetemplatefieldfieldmetanumberresponse.md - docs/models/fieldupdatetemplatefieldfieldmetaradiorequest.md - docs/models/fieldupdatetemplatefieldfieldmetaradioresponse.md + - docs/models/fieldupdatetemplatefieldfieldmetasignaturerequest.md + - docs/models/fieldupdatetemplatefieldfieldmetasignatureresponse.md - docs/models/fieldupdatetemplatefieldfieldmetatextrequest.md - docs/models/fieldupdatetemplatefieldfieldmetatextresponse.md - docs/models/fieldupdatetemplatefieldfieldmetatypecheckbox.md @@ -956,6 +2049,7 @@ generatedFiles: - docs/models/fieldupdatetemplatefieldfieldmetatypename.md - docs/models/fieldupdatetemplatefieldfieldmetatypenumber.md - docs/models/fieldupdatetemplatefieldfieldmetatyperadio.md + - docs/models/fieldupdatetemplatefieldfieldmetatypesignature.md - docs/models/fieldupdatetemplatefieldfieldmetatypetext.md - docs/models/fieldupdatetemplatefieldfieldmetaunion.md - docs/models/fieldupdatetemplatefieldfieldname.md @@ -964,12 +2058,18 @@ generatedFiles: - docs/models/fieldupdatetemplatefieldfieldsignature.md - docs/models/fieldupdatetemplatefieldfieldtext.md - docs/models/fieldupdatetemplatefieldfieldunion.md + - docs/models/fieldupdatetemplatefieldforbiddenerror.md + - docs/models/fieldupdatetemplatefieldforbiddenissue.md - docs/models/fieldupdatetemplatefieldinternalservererror.md - docs/models/fieldupdatetemplatefieldinternalservererrorissue.md - docs/models/fieldupdatetemplatefieldrequest.md - docs/models/fieldupdatetemplatefieldresponse.md - docs/models/fieldupdatetemplatefieldsbadrequesterror.md - docs/models/fieldupdatetemplatefieldsbadrequestissue.md + - docs/models/fieldupdatetemplatefieldsdirectioncheckbox.md + - docs/models/fieldupdatetemplatefieldsdirectionradio.md + - docs/models/fieldupdatetemplatefieldsdirectionresponse1.md + - docs/models/fieldupdatetemplatefieldsdirectionresponse2.md - docs/models/fieldupdatetemplatefieldsfieldcheckbox.md - docs/models/fieldupdatetemplatefieldsfielddate.md - docs/models/fieldupdatetemplatefieldsfielddropdown.md @@ -992,6 +2092,8 @@ generatedFiles: - docs/models/fieldupdatetemplatefieldsfieldmetanumberresponse.md - docs/models/fieldupdatetemplatefieldsfieldmetaradiorequest.md - docs/models/fieldupdatetemplatefieldsfieldmetaradioresponse.md + - docs/models/fieldupdatetemplatefieldsfieldmetasignaturerequest.md + - docs/models/fieldupdatetemplatefieldsfieldmetasignatureresponse.md - docs/models/fieldupdatetemplatefieldsfieldmetatextrequest.md - docs/models/fieldupdatetemplatefieldsfieldmetatextresponse.md - docs/models/fieldupdatetemplatefieldsfieldmetatypecheckbox.md @@ -1002,6 +2104,7 @@ generatedFiles: - docs/models/fieldupdatetemplatefieldsfieldmetatypename.md - docs/models/fieldupdatetemplatefieldsfieldmetatypenumber.md - docs/models/fieldupdatetemplatefieldsfieldmetatyperadio.md + - docs/models/fieldupdatetemplatefieldsfieldmetatypesignature.md - docs/models/fieldupdatetemplatefieldsfieldmetatypetext.md - docs/models/fieldupdatetemplatefieldsfieldmetaunion.md - docs/models/fieldupdatetemplatefieldsfieldname.md @@ -1011,6 +2114,8 @@ generatedFiles: - docs/models/fieldupdatetemplatefieldsfieldsignature.md - docs/models/fieldupdatetemplatefieldsfieldtext.md - docs/models/fieldupdatetemplatefieldsfieldunion.md + - docs/models/fieldupdatetemplatefieldsforbiddenerror.md + - docs/models/fieldupdatetemplatefieldsforbiddenissue.md - docs/models/fieldupdatetemplatefieldsinternalservererror.md - docs/models/fieldupdatetemplatefieldsinternalservererrorissue.md - docs/models/fieldupdatetemplatefieldsrequest.md @@ -1045,15 +2150,22 @@ generatedFiles: - docs/models/fieldupdatetemplatefieldstyperadiorequest1.md - docs/models/fieldupdatetemplatefieldstyperadiorequest2.md - docs/models/fieldupdatetemplatefieldstyperesponse.md - - docs/models/fieldupdatetemplatefieldstypesignature.md + - docs/models/fieldupdatetemplatefieldstypesignaturerequest1.md + - docs/models/fieldupdatetemplatefieldstypesignaturerequest2.md - docs/models/fieldupdatetemplatefieldstypetextrequest1.md - docs/models/fieldupdatetemplatefieldstypetextrequest2.md + - docs/models/fieldupdatetemplatefieldsunauthorizederror.md + - docs/models/fieldupdatetemplatefieldsunauthorizedissue.md - docs/models/fieldupdatetemplatefieldsvaluecheckbox.md - docs/models/fieldupdatetemplatefieldsvaluedropdown.md - docs/models/fieldupdatetemplatefieldsvalueradio.md - docs/models/fieldupdatetemplatefieldsvalueresponse1.md - docs/models/fieldupdatetemplatefieldsvalueresponse2.md - docs/models/fieldupdatetemplatefieldsvalueresponse3.md + - docs/models/fieldupdatetemplatefieldsverticalalignnumber.md + - docs/models/fieldupdatetemplatefieldsverticalalignresponse1.md + - docs/models/fieldupdatetemplatefieldsverticalalignresponse2.md + - docs/models/fieldupdatetemplatefieldsverticalaligntext.md - docs/models/fieldupdatetemplatefieldtextaligndate.md - docs/models/fieldupdatetemplatefieldtextalignemail.md - docs/models/fieldupdatetemplatefieldtextaligninitials.md @@ -1084,34 +2196,80 @@ generatedFiles: - docs/models/fieldupdatetemplatefieldtyperadiorequest1.md - docs/models/fieldupdatetemplatefieldtyperadiorequest2.md - docs/models/fieldupdatetemplatefieldtyperesponse.md - - docs/models/fieldupdatetemplatefieldtypesignature.md + - docs/models/fieldupdatetemplatefieldtypesignaturerequest1.md + - docs/models/fieldupdatetemplatefieldtypesignaturerequest2.md - docs/models/fieldupdatetemplatefieldtypetextrequest1.md - docs/models/fieldupdatetemplatefieldtypetextrequest2.md + - docs/models/fieldupdatetemplatefieldunauthorizederror.md + - docs/models/fieldupdatetemplatefieldunauthorizedissue.md - docs/models/fieldupdatetemplatefieldvaluecheckbox.md - docs/models/fieldupdatetemplatefieldvaluedropdown.md - docs/models/fieldupdatetemplatefieldvalueradio.md - docs/models/fieldupdatetemplatefieldvalueresponse1.md - docs/models/fieldupdatetemplatefieldvalueresponse2.md - docs/models/fieldupdatetemplatefieldvalueresponse3.md - - docs/models/formvaluesrequest.md + - docs/models/fieldupdatetemplatefieldverticalalignnumber.md + - docs/models/fieldupdatetemplatefieldverticalalignresponse1.md + - docs/models/fieldupdatetemplatefieldverticalalignresponse2.md + - docs/models/fieldupdatetemplatefieldverticalaligntext.md + - docs/models/foldercreatefolderbadrequesterror.md + - docs/models/foldercreatefolderbadrequestissue.md + - docs/models/foldercreatefolderforbiddenerror.md + - docs/models/foldercreatefolderforbiddenissue.md + - docs/models/foldercreatefolderinternalservererror.md + - docs/models/foldercreatefolderinternalservererrorissue.md + - docs/models/foldercreatefolderrequest.md + - docs/models/foldercreatefolderresponse.md + - docs/models/foldercreatefoldertyperequest.md + - docs/models/foldercreatefoldertyperesponse.md + - docs/models/foldercreatefolderunauthorizederror.md + - docs/models/foldercreatefolderunauthorizedissue.md + - docs/models/foldercreatefoldervisibility.md + - docs/models/folderdeletefolderbadrequesterror.md + - docs/models/folderdeletefolderbadrequestissue.md + - docs/models/folderdeletefolderforbiddenerror.md + - docs/models/folderdeletefolderforbiddenissue.md + - docs/models/folderdeletefolderinternalservererror.md + - docs/models/folderdeletefolderinternalservererrorissue.md + - docs/models/folderdeletefolderrequest.md + - docs/models/folderdeletefolderresponse.md + - docs/models/folderdeletefolderunauthorizederror.md + - docs/models/folderdeletefolderunauthorizedissue.md + - docs/models/folderfindfoldersbadrequesterror.md + - docs/models/folderfindfoldersbadrequestissue.md + - docs/models/folderfindfoldersdata.md + - docs/models/folderfindfoldersdatatype.md + - docs/models/folderfindfoldersforbiddenerror.md + - docs/models/folderfindfoldersforbiddenissue.md + - docs/models/folderfindfoldersinternalservererror.md + - docs/models/folderfindfoldersinternalservererrorissue.md + - docs/models/folderfindfoldersnotfounderror.md + - docs/models/folderfindfoldersnotfoundissue.md + - docs/models/folderfindfoldersqueryparamtype.md + - docs/models/folderfindfoldersrequest.md + - docs/models/folderfindfoldersresponse.md + - docs/models/folderfindfoldersunauthorizederror.md + - docs/models/folderfindfoldersunauthorizedissue.md + - docs/models/folderfindfoldersvisibility.md + - docs/models/folderupdatefolderbadrequesterror.md + - docs/models/folderupdatefolderbadrequestissue.md + - docs/models/folderupdatefolderdata.md + - docs/models/folderupdatefolderdatavisibility.md + - docs/models/folderupdatefolderforbiddenerror.md + - docs/models/folderupdatefolderforbiddenissue.md + - docs/models/folderupdatefolderinternalservererror.md + - docs/models/folderupdatefolderinternalservererrorissue.md + - docs/models/folderupdatefolderrequest.md + - docs/models/folderupdatefolderresponse.md + - docs/models/folderupdatefoldertype.md + - docs/models/folderupdatefolderunauthorizederror.md + - docs/models/folderupdatefolderunauthorizedissue.md + - docs/models/folderupdatefoldervisibilityresponse.md - docs/models/orderbycolumn.md - docs/models/orderbydirection.md - - docs/models/prefillfield.md - - docs/models/prefillfieldcheckbox.md - - docs/models/prefillfielddate.md - - docs/models/prefillfielddropdown.md - - docs/models/prefillfieldnumber.md - - docs/models/prefillfieldradio.md - - docs/models/prefillfieldtext.md - - docs/models/prefillfieldtypecheckbox.md - - docs/models/prefillfieldtypedate.md - - docs/models/prefillfieldtypedropdown.md - - docs/models/prefillfieldtypenumber.md - - docs/models/prefillfieldtyperadio.md - - docs/models/prefillfieldtypetext.md + - docs/models/override.md - docs/models/queryparamsource.md - docs/models/queryparamstatus.md - - docs/models/queryparamtype.md - docs/models/recipientcreatedocumentrecipientaccessauthrequest.md - docs/models/recipientcreatedocumentrecipientaccessauthresponse.md - docs/models/recipientcreatedocumentrecipientactionauthrequest.md @@ -1119,6 +2277,8 @@ generatedFiles: - docs/models/recipientcreatedocumentrecipientauthoptions.md - docs/models/recipientcreatedocumentrecipientbadrequesterror.md - docs/models/recipientcreatedocumentrecipientbadrequestissue.md + - docs/models/recipientcreatedocumentrecipientforbiddenerror.md + - docs/models/recipientcreatedocumentrecipientforbiddenissue.md - docs/models/recipientcreatedocumentrecipientinternalservererror.md - docs/models/recipientcreatedocumentrecipientinternalservererrorissue.md - docs/models/recipientcreatedocumentrecipientreadstatus.md @@ -1135,6 +2295,8 @@ generatedFiles: - docs/models/recipientcreatedocumentrecipientsbadrequesterror.md - docs/models/recipientcreatedocumentrecipientsbadrequestissue.md - docs/models/recipientcreatedocumentrecipientsendstatus.md + - docs/models/recipientcreatedocumentrecipientsforbiddenerror.md + - docs/models/recipientcreatedocumentrecipientsforbiddenissue.md - docs/models/recipientcreatedocumentrecipientsigningstatus.md - docs/models/recipientcreatedocumentrecipientsinternalservererror.md - docs/models/recipientcreatedocumentrecipientsinternalservererrorissue.md @@ -1147,6 +2309,10 @@ generatedFiles: - docs/models/recipientcreatedocumentrecipientsroleresponse.md - docs/models/recipientcreatedocumentrecipientssendstatus.md - docs/models/recipientcreatedocumentrecipientssigningstatus.md + - docs/models/recipientcreatedocumentrecipientsunauthorizederror.md + - docs/models/recipientcreatedocumentrecipientsunauthorizedissue.md + - docs/models/recipientcreatedocumentrecipientunauthorizederror.md + - docs/models/recipientcreatedocumentrecipientunauthorizedissue.md - docs/models/recipientcreatetemplaterecipientaccessauthrequest.md - docs/models/recipientcreatetemplaterecipientaccessauthresponse.md - docs/models/recipientcreatetemplaterecipientactionauthrequest.md @@ -1154,6 +2320,8 @@ generatedFiles: - docs/models/recipientcreatetemplaterecipientauthoptions.md - docs/models/recipientcreatetemplaterecipientbadrequesterror.md - docs/models/recipientcreatetemplaterecipientbadrequestissue.md + - docs/models/recipientcreatetemplaterecipientforbiddenerror.md + - docs/models/recipientcreatetemplaterecipientforbiddenissue.md - docs/models/recipientcreatetemplaterecipientinternalservererror.md - docs/models/recipientcreatetemplaterecipientinternalservererrorissue.md - docs/models/recipientcreatetemplaterecipientreadstatus.md @@ -1170,6 +2338,8 @@ generatedFiles: - docs/models/recipientcreatetemplaterecipientsbadrequesterror.md - docs/models/recipientcreatetemplaterecipientsbadrequestissue.md - docs/models/recipientcreatetemplaterecipientsendstatus.md + - docs/models/recipientcreatetemplaterecipientsforbiddenerror.md + - docs/models/recipientcreatetemplaterecipientsforbiddenissue.md - docs/models/recipientcreatetemplaterecipientsigningstatus.md - docs/models/recipientcreatetemplaterecipientsinternalservererror.md - docs/models/recipientcreatetemplaterecipientsinternalservererrorissue.md @@ -1182,23 +2352,37 @@ generatedFiles: - docs/models/recipientcreatetemplaterecipientsroleresponse.md - docs/models/recipientcreatetemplaterecipientssendstatus.md - docs/models/recipientcreatetemplaterecipientssigningstatus.md + - docs/models/recipientcreatetemplaterecipientsunauthorizederror.md + - docs/models/recipientcreatetemplaterecipientsunauthorizedissue.md + - docs/models/recipientcreatetemplaterecipientunauthorizederror.md + - docs/models/recipientcreatetemplaterecipientunauthorizedissue.md - docs/models/recipientdeletedocumentrecipientbadrequesterror.md - docs/models/recipientdeletedocumentrecipientbadrequestissue.md + - docs/models/recipientdeletedocumentrecipientforbiddenerror.md + - docs/models/recipientdeletedocumentrecipientforbiddenissue.md - docs/models/recipientdeletedocumentrecipientinternalservererror.md - docs/models/recipientdeletedocumentrecipientinternalservererrorissue.md - docs/models/recipientdeletedocumentrecipientrequest.md - docs/models/recipientdeletedocumentrecipientresponse.md + - docs/models/recipientdeletedocumentrecipientunauthorizederror.md + - docs/models/recipientdeletedocumentrecipientunauthorizedissue.md - docs/models/recipientdeletetemplaterecipientbadrequesterror.md - docs/models/recipientdeletetemplaterecipientbadrequestissue.md + - docs/models/recipientdeletetemplaterecipientforbiddenerror.md + - docs/models/recipientdeletetemplaterecipientforbiddenissue.md - docs/models/recipientdeletetemplaterecipientinternalservererror.md - docs/models/recipientdeletetemplaterecipientinternalservererrorissue.md - docs/models/recipientdeletetemplaterecipientrequest.md - docs/models/recipientdeletetemplaterecipientresponse.md + - docs/models/recipientdeletetemplaterecipientunauthorizederror.md + - docs/models/recipientdeletetemplaterecipientunauthorizedissue.md - docs/models/recipientgetdocumentrecipientaccessauth.md - docs/models/recipientgetdocumentrecipientactionauth.md - docs/models/recipientgetdocumentrecipientauthoptions.md - docs/models/recipientgetdocumentrecipientbadrequesterror.md - docs/models/recipientgetdocumentrecipientbadrequestissue.md + - docs/models/recipientgetdocumentrecipientdirection1.md + - docs/models/recipientgetdocumentrecipientdirection2.md - docs/models/recipientgetdocumentrecipientfield.md - docs/models/recipientgetdocumentrecipientfieldmetacheckbox.md - docs/models/recipientgetdocumentrecipientfieldmetadate.md @@ -1208,8 +2392,11 @@ generatedFiles: - docs/models/recipientgetdocumentrecipientfieldmetaname.md - docs/models/recipientgetdocumentrecipientfieldmetanumber.md - docs/models/recipientgetdocumentrecipientfieldmetaradio.md + - docs/models/recipientgetdocumentrecipientfieldmetasignature.md - docs/models/recipientgetdocumentrecipientfieldmetatext.md - docs/models/recipientgetdocumentrecipientfieldmetaunion.md + - docs/models/recipientgetdocumentrecipientforbiddenerror.md + - docs/models/recipientgetdocumentrecipientforbiddenissue.md - docs/models/recipientgetdocumentrecipientinternalservererror.md - docs/models/recipientgetdocumentrecipientinternalservererrorissue.md - docs/models/recipientgetdocumentrecipientnotfounderror.md @@ -1235,15 +2422,22 @@ generatedFiles: - docs/models/recipientgetdocumentrecipienttypename.md - docs/models/recipientgetdocumentrecipienttypenumber.md - docs/models/recipientgetdocumentrecipienttyperadio.md + - docs/models/recipientgetdocumentrecipienttypesignature.md - docs/models/recipientgetdocumentrecipienttypetext.md + - docs/models/recipientgetdocumentrecipientunauthorizederror.md + - docs/models/recipientgetdocumentrecipientunauthorizedissue.md - docs/models/recipientgetdocumentrecipientvalue1.md - docs/models/recipientgetdocumentrecipientvalue2.md - docs/models/recipientgetdocumentrecipientvalue3.md + - docs/models/recipientgetdocumentrecipientverticalalign1.md + - docs/models/recipientgetdocumentrecipientverticalalign2.md - docs/models/recipientgettemplaterecipientaccessauth.md - docs/models/recipientgettemplaterecipientactionauth.md - docs/models/recipientgettemplaterecipientauthoptions.md - docs/models/recipientgettemplaterecipientbadrequesterror.md - docs/models/recipientgettemplaterecipientbadrequestissue.md + - docs/models/recipientgettemplaterecipientdirection1.md + - docs/models/recipientgettemplaterecipientdirection2.md - docs/models/recipientgettemplaterecipientfield.md - docs/models/recipientgettemplaterecipientfieldmetacheckbox.md - docs/models/recipientgettemplaterecipientfieldmetadate.md @@ -1253,8 +2447,11 @@ generatedFiles: - docs/models/recipientgettemplaterecipientfieldmetaname.md - docs/models/recipientgettemplaterecipientfieldmetanumber.md - docs/models/recipientgettemplaterecipientfieldmetaradio.md + - docs/models/recipientgettemplaterecipientfieldmetasignature.md - docs/models/recipientgettemplaterecipientfieldmetatext.md - docs/models/recipientgettemplaterecipientfieldmetaunion.md + - docs/models/recipientgettemplaterecipientforbiddenerror.md + - docs/models/recipientgettemplaterecipientforbiddenissue.md - docs/models/recipientgettemplaterecipientinternalservererror.md - docs/models/recipientgettemplaterecipientinternalservererrorissue.md - docs/models/recipientgettemplaterecipientnotfounderror.md @@ -1280,10 +2477,15 @@ generatedFiles: - docs/models/recipientgettemplaterecipienttypename.md - docs/models/recipientgettemplaterecipienttypenumber.md - docs/models/recipientgettemplaterecipienttyperadio.md + - docs/models/recipientgettemplaterecipienttypesignature.md - docs/models/recipientgettemplaterecipienttypetext.md + - docs/models/recipientgettemplaterecipientunauthorizederror.md + - docs/models/recipientgettemplaterecipientunauthorizedissue.md - docs/models/recipientgettemplaterecipientvalue1.md - docs/models/recipientgettemplaterecipientvalue2.md - docs/models/recipientgettemplaterecipientvalue3.md + - docs/models/recipientgettemplaterecipientverticalalign1.md + - docs/models/recipientgettemplaterecipientverticalalign2.md - docs/models/recipientupdatedocumentrecipientaccessauthrequest.md - docs/models/recipientupdatedocumentrecipientaccessauthresponse.md - docs/models/recipientupdatedocumentrecipientactionauthrequest.md @@ -1291,6 +2493,8 @@ generatedFiles: - docs/models/recipientupdatedocumentrecipientauthoptions.md - docs/models/recipientupdatedocumentrecipientbadrequesterror.md - docs/models/recipientupdatedocumentrecipientbadrequestissue.md + - docs/models/recipientupdatedocumentrecipientdirection1.md + - docs/models/recipientupdatedocumentrecipientdirection2.md - docs/models/recipientupdatedocumentrecipientfield.md - docs/models/recipientupdatedocumentrecipientfieldmetacheckbox.md - docs/models/recipientupdatedocumentrecipientfieldmetadate.md @@ -1300,8 +2504,11 @@ generatedFiles: - docs/models/recipientupdatedocumentrecipientfieldmetaname.md - docs/models/recipientupdatedocumentrecipientfieldmetanumber.md - docs/models/recipientupdatedocumentrecipientfieldmetaradio.md + - docs/models/recipientupdatedocumentrecipientfieldmetasignature.md - docs/models/recipientupdatedocumentrecipientfieldmetatext.md - docs/models/recipientupdatedocumentrecipientfieldmetaunion.md + - docs/models/recipientupdatedocumentrecipientforbiddenerror.md + - docs/models/recipientupdatedocumentrecipientforbiddenissue.md - docs/models/recipientupdatedocumentrecipientinternalservererror.md - docs/models/recipientupdatedocumentrecipientinternalservererrorissue.md - docs/models/recipientupdatedocumentrecipientreadstatus.md @@ -1317,6 +2524,8 @@ generatedFiles: - docs/models/recipientupdatedocumentrecipientsauthoptions.md - docs/models/recipientupdatedocumentrecipientsbadrequesterror.md - docs/models/recipientupdatedocumentrecipientsbadrequestissue.md + - docs/models/recipientupdatedocumentrecipientsdirection1.md + - docs/models/recipientupdatedocumentrecipientsdirection2.md - docs/models/recipientupdatedocumentrecipientsendstatus.md - docs/models/recipientupdatedocumentrecipientsfield.md - docs/models/recipientupdatedocumentrecipientsfieldmetacheckbox.md @@ -1327,8 +2536,11 @@ generatedFiles: - docs/models/recipientupdatedocumentrecipientsfieldmetaname.md - docs/models/recipientupdatedocumentrecipientsfieldmetanumber.md - docs/models/recipientupdatedocumentrecipientsfieldmetaradio.md + - docs/models/recipientupdatedocumentrecipientsfieldmetasignature.md - docs/models/recipientupdatedocumentrecipientsfieldmetatext.md - docs/models/recipientupdatedocumentrecipientsfieldmetaunion.md + - docs/models/recipientupdatedocumentrecipientsforbiddenerror.md + - docs/models/recipientupdatedocumentrecipientsforbiddenissue.md - docs/models/recipientupdatedocumentrecipientsigningstatus.md - docs/models/recipientupdatedocumentrecipientsinternalservererror.md - docs/models/recipientupdatedocumentrecipientsinternalservererrorissue.md @@ -1356,10 +2568,15 @@ generatedFiles: - docs/models/recipientupdatedocumentrecipientstypename.md - docs/models/recipientupdatedocumentrecipientstypenumber.md - docs/models/recipientupdatedocumentrecipientstyperadio.md + - docs/models/recipientupdatedocumentrecipientstypesignature.md - docs/models/recipientupdatedocumentrecipientstypetext.md + - docs/models/recipientupdatedocumentrecipientsunauthorizederror.md + - docs/models/recipientupdatedocumentrecipientsunauthorizedissue.md - docs/models/recipientupdatedocumentrecipientsvalue1.md - docs/models/recipientupdatedocumentrecipientsvalue2.md - docs/models/recipientupdatedocumentrecipientsvalue3.md + - docs/models/recipientupdatedocumentrecipientsverticalalign1.md + - docs/models/recipientupdatedocumentrecipientsverticalalign2.md - docs/models/recipientupdatedocumentrecipienttextalign1.md - docs/models/recipientupdatedocumentrecipienttextalign2.md - docs/models/recipientupdatedocumentrecipienttextalign3.md @@ -1375,10 +2592,15 @@ generatedFiles: - docs/models/recipientupdatedocumentrecipienttypename.md - docs/models/recipientupdatedocumentrecipienttypenumber.md - docs/models/recipientupdatedocumentrecipienttyperadio.md + - docs/models/recipientupdatedocumentrecipienttypesignature.md - docs/models/recipientupdatedocumentrecipienttypetext.md + - docs/models/recipientupdatedocumentrecipientunauthorizederror.md + - docs/models/recipientupdatedocumentrecipientunauthorizedissue.md - docs/models/recipientupdatedocumentrecipientvalue1.md - docs/models/recipientupdatedocumentrecipientvalue2.md - docs/models/recipientupdatedocumentrecipientvalue3.md + - docs/models/recipientupdatedocumentrecipientverticalalign1.md + - docs/models/recipientupdatedocumentrecipientverticalalign2.md - docs/models/recipientupdatetemplaterecipientaccessauthrequest.md - docs/models/recipientupdatetemplaterecipientaccessauthresponse.md - docs/models/recipientupdatetemplaterecipientactionauthrequest.md @@ -1386,6 +2608,8 @@ generatedFiles: - docs/models/recipientupdatetemplaterecipientauthoptions.md - docs/models/recipientupdatetemplaterecipientbadrequesterror.md - docs/models/recipientupdatetemplaterecipientbadrequestissue.md + - docs/models/recipientupdatetemplaterecipientdirection1.md + - docs/models/recipientupdatetemplaterecipientdirection2.md - docs/models/recipientupdatetemplaterecipientfield.md - docs/models/recipientupdatetemplaterecipientfieldmetacheckbox.md - docs/models/recipientupdatetemplaterecipientfieldmetadate.md @@ -1395,8 +2619,11 @@ generatedFiles: - docs/models/recipientupdatetemplaterecipientfieldmetaname.md - docs/models/recipientupdatetemplaterecipientfieldmetanumber.md - docs/models/recipientupdatetemplaterecipientfieldmetaradio.md + - docs/models/recipientupdatetemplaterecipientfieldmetasignature.md - docs/models/recipientupdatetemplaterecipientfieldmetatext.md - docs/models/recipientupdatetemplaterecipientfieldmetaunion.md + - docs/models/recipientupdatetemplaterecipientforbiddenerror.md + - docs/models/recipientupdatetemplaterecipientforbiddenissue.md - docs/models/recipientupdatetemplaterecipientinternalservererror.md - docs/models/recipientupdatetemplaterecipientinternalservererrorissue.md - docs/models/recipientupdatetemplaterecipientreadstatus.md @@ -1412,6 +2639,8 @@ generatedFiles: - docs/models/recipientupdatetemplaterecipientsauthoptions.md - docs/models/recipientupdatetemplaterecipientsbadrequesterror.md - docs/models/recipientupdatetemplaterecipientsbadrequestissue.md + - docs/models/recipientupdatetemplaterecipientsdirection1.md + - docs/models/recipientupdatetemplaterecipientsdirection2.md - docs/models/recipientupdatetemplaterecipientsendstatus.md - docs/models/recipientupdatetemplaterecipientsfield.md - docs/models/recipientupdatetemplaterecipientsfieldmetacheckbox.md @@ -1422,8 +2651,11 @@ generatedFiles: - docs/models/recipientupdatetemplaterecipientsfieldmetaname.md - docs/models/recipientupdatetemplaterecipientsfieldmetanumber.md - docs/models/recipientupdatetemplaterecipientsfieldmetaradio.md + - docs/models/recipientupdatetemplaterecipientsfieldmetasignature.md - docs/models/recipientupdatetemplaterecipientsfieldmetatext.md - docs/models/recipientupdatetemplaterecipientsfieldmetaunion.md + - docs/models/recipientupdatetemplaterecipientsforbiddenerror.md + - docs/models/recipientupdatetemplaterecipientsforbiddenissue.md - docs/models/recipientupdatetemplaterecipientsigningstatus.md - docs/models/recipientupdatetemplaterecipientsinternalservererror.md - docs/models/recipientupdatetemplaterecipientsinternalservererrorissue.md @@ -1451,10 +2683,15 @@ generatedFiles: - docs/models/recipientupdatetemplaterecipientstypename.md - docs/models/recipientupdatetemplaterecipientstypenumber.md - docs/models/recipientupdatetemplaterecipientstyperadio.md + - docs/models/recipientupdatetemplaterecipientstypesignature.md - docs/models/recipientupdatetemplaterecipientstypetext.md + - docs/models/recipientupdatetemplaterecipientsunauthorizederror.md + - docs/models/recipientupdatetemplaterecipientsunauthorizedissue.md - docs/models/recipientupdatetemplaterecipientsvalue1.md - docs/models/recipientupdatetemplaterecipientsvalue2.md - docs/models/recipientupdatetemplaterecipientsvalue3.md + - docs/models/recipientupdatetemplaterecipientsverticalalign1.md + - docs/models/recipientupdatetemplaterecipientsverticalalign2.md - docs/models/recipientupdatetemplaterecipienttextalign1.md - docs/models/recipientupdatetemplaterecipienttextalign2.md - docs/models/recipientupdatetemplaterecipienttextalign3.md @@ -1470,21 +2707,30 @@ generatedFiles: - docs/models/recipientupdatetemplaterecipienttypename.md - docs/models/recipientupdatetemplaterecipienttypenumber.md - docs/models/recipientupdatetemplaterecipienttyperadio.md + - docs/models/recipientupdatetemplaterecipienttypesignature.md - docs/models/recipientupdatetemplaterecipienttypetext.md + - docs/models/recipientupdatetemplaterecipientunauthorizederror.md + - docs/models/recipientupdatetemplaterecipientunauthorizedissue.md - docs/models/recipientupdatetemplaterecipientvalue1.md - docs/models/recipientupdatetemplaterecipientvalue2.md - docs/models/recipientupdatetemplaterecipientvalue3.md + - docs/models/recipientupdatetemplaterecipientverticalalign1.md + - docs/models/recipientupdatetemplaterecipientverticalalign2.md - docs/models/security.md - docs/models/templatecreatedocumentfromtemplateaccessauth.md - docs/models/templatecreatedocumentfromtemplateactionauth.md - docs/models/templatecreatedocumentfromtemplateauthoptions.md - docs/models/templatecreatedocumentfromtemplatebadrequesterror.md - docs/models/templatecreatedocumentfromtemplatebadrequestissue.md + - docs/models/templatecreatedocumentfromtemplatecustomdocumentdatum.md + - docs/models/templatecreatedocumentfromtemplatedirection1.md + - docs/models/templatecreatedocumentfromtemplatedirection2.md - docs/models/templatecreatedocumentfromtemplatedistributionmethod.md - docs/models/templatecreatedocumentfromtemplatedocumentdata.md - docs/models/templatecreatedocumentfromtemplatedocumentdatatype.md - docs/models/templatecreatedocumentfromtemplatedocumentmeta.md - docs/models/templatecreatedocumentfromtemplateemailsettings.md + - docs/models/templatecreatedocumentfromtemplateenvelopeitem.md - docs/models/templatecreatedocumentfromtemplatefield.md - docs/models/templatecreatedocumentfromtemplatefieldmetacheckbox.md - docs/models/templatecreatedocumentfromtemplatefieldmetadate.md @@ -1494,6 +2740,7 @@ generatedFiles: - docs/models/templatecreatedocumentfromtemplatefieldmetaname.md - docs/models/templatecreatedocumentfromtemplatefieldmetanumber.md - docs/models/templatecreatedocumentfromtemplatefieldmetaradio.md + - docs/models/templatecreatedocumentfromtemplatefieldmetasignature.md - docs/models/templatecreatedocumentfromtemplatefieldmetatext.md - docs/models/templatecreatedocumentfromtemplatefieldmetatypecheckbox.md - docs/models/templatecreatedocumentfromtemplatefieldmetatypedate.md @@ -1506,11 +2753,26 @@ generatedFiles: - docs/models/templatecreatedocumentfromtemplatefolder.md - docs/models/templatecreatedocumentfromtemplatefoldertype.md - docs/models/templatecreatedocumentfromtemplatefoldervisibility.md + - docs/models/templatecreatedocumentfromtemplateforbiddenerror.md + - docs/models/templatecreatedocumentfromtemplateforbiddenissue.md - docs/models/templatecreatedocumentfromtemplateformvalues.md - docs/models/templatecreatedocumentfromtemplateglobalaccessauth.md - docs/models/templatecreatedocumentfromtemplateglobalactionauth.md - docs/models/templatecreatedocumentfromtemplateinternalservererror.md - docs/models/templatecreatedocumentfromtemplateinternalservererrorissue.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldcheckbox.md + - docs/models/templatecreatedocumentfromtemplateprefillfielddate.md + - docs/models/templatecreatedocumentfromtemplateprefillfielddropdown.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldnumber.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldradio.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldtext.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldtypecheckbox.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldtypedate.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldtypedropdown.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldtypenumber.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldtyperadio.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldtypetext.md + - docs/models/templatecreatedocumentfromtemplateprefillfieldunion.md - docs/models/templatecreatedocumentfromtemplatereadstatus.md - docs/models/templatecreatedocumentfromtemplaterecipientauthoptions.md - docs/models/templatecreatedocumentfromtemplaterecipientrequest.md @@ -1532,33 +2794,158 @@ generatedFiles: - docs/models/templatecreatedocumentfromtemplatetypeemail.md - docs/models/templatecreatedocumentfromtemplatetypeinitials.md - docs/models/templatecreatedocumentfromtemplatetypename.md + - docs/models/templatecreatedocumentfromtemplatetypesignature.md + - docs/models/templatecreatedocumentfromtemplateunauthorizederror.md + - docs/models/templatecreatedocumentfromtemplateunauthorizedissue.md - docs/models/templatecreatedocumentfromtemplatevalue1.md - docs/models/templatecreatedocumentfromtemplatevalue2.md - docs/models/templatecreatedocumentfromtemplatevalue3.md + - docs/models/templatecreatedocumentfromtemplateverticalalign1.md + - docs/models/templatecreatedocumentfromtemplateverticalalign2.md - docs/models/templatecreatedocumentfromtemplatevisibility.md + - docs/models/templatecreatetemplateattachment.md + - docs/models/templatecreatetemplatebadrequesterror.md + - docs/models/templatecreatetemplatebadrequestissue.md + - docs/models/templatecreatetemplatedateformat.md - docs/models/templatecreatetemplatedirectlinkbadrequesterror.md - docs/models/templatecreatetemplatedirectlinkbadrequestissue.md + - docs/models/templatecreatetemplatedirectlinkforbiddenerror.md + - docs/models/templatecreatetemplatedirectlinkforbiddenissue.md - docs/models/templatecreatetemplatedirectlinkinternalservererror.md - docs/models/templatecreatetemplatedirectlinkinternalservererrorissue.md - docs/models/templatecreatetemplatedirectlinkrequest.md - docs/models/templatecreatetemplatedirectlinkresponse.md + - docs/models/templatecreatetemplatedirectlinkunauthorizederror.md + - docs/models/templatecreatetemplatedirectlinkunauthorizedissue.md + - docs/models/templatecreatetemplatedistributionmethod.md + - docs/models/templatecreatetemplateemailsettings.md + - docs/models/templatecreatetemplatefile.md + - docs/models/templatecreatetemplateforbiddenerror.md + - docs/models/templatecreatetemplateforbiddenissue.md + - docs/models/templatecreatetemplateglobalaccessauth.md + - docs/models/templatecreatetemplateglobalactionauth.md + - docs/models/templatecreatetemplateinternalservererror.md + - docs/models/templatecreatetemplateinternalservererrorissue.md + - docs/models/templatecreatetemplatelanguage.md + - docs/models/templatecreatetemplatemeta.md + - docs/models/templatecreatetemplatepayload.md + - docs/models/templatecreatetemplaterequest.md + - docs/models/templatecreatetemplateresponse.md + - docs/models/templatecreatetemplatesigningorder.md + - docs/models/templatecreatetemplatetemporaryaccessauth.md + - docs/models/templatecreatetemplatetemporaryactionauth.md + - docs/models/templatecreatetemplatetemporaryattachment.md + - docs/models/templatecreatetemplatetemporaryauthoptions.md + - docs/models/templatecreatetemplatetemporarybadrequesterror.md + - docs/models/templatecreatetemplatetemporarybadrequestissue.md + - docs/models/templatecreatetemplatetemporarydateformat.md + - docs/models/templatecreatetemplatetemporarydirection1.md + - docs/models/templatecreatetemplatetemporarydirection2.md + - docs/models/templatecreatetemplatetemporarydirectlink.md + - docs/models/templatecreatetemplatetemporaryenvelopeitem.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/templatecreatetemplatetemporaryfieldmetasignature.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/templatecreatetemplatetemporaryforbiddenerror.md + - docs/models/templatecreatetemplatetemporaryforbiddenissue.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/templatecreatetemplatetemporarymetadistributionmethod.md + - docs/models/templatecreatetemplatetemporarymetaemailsettings.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/templatecreatetemplatetemporarytypelink.md + - docs/models/templatecreatetemplatetemporarytypename.md + - docs/models/templatecreatetemplatetemporarytypenumber.md + - docs/models/templatecreatetemplatetemporarytyperadio.md + - docs/models/templatecreatetemplatetemporarytyperequest.md + - docs/models/templatecreatetemplatetemporarytyperesponse.md + - docs/models/templatecreatetemplatetemporarytypesignature.md + - docs/models/templatecreatetemplatetemporarytypetext.md + - docs/models/templatecreatetemplatetemporaryunauthorizederror.md + - docs/models/templatecreatetemplatetemporaryunauthorizedissue.md + - docs/models/templatecreatetemplatetemporaryuser.md + - docs/models/templatecreatetemplatetemporaryvalue1.md + - docs/models/templatecreatetemplatetemporaryvalue2.md + - docs/models/templatecreatetemplatetemporaryvalue3.md + - docs/models/templatecreatetemplatetemporaryverticalalign1.md + - docs/models/templatecreatetemplatetemporaryverticalalign2.md + - docs/models/templatecreatetemplatetemporaryvisibilityrequest.md + - docs/models/templatecreatetemplatetemporaryvisibilityresponse.md + - docs/models/templatecreatetemplatetype.md + - docs/models/templatecreatetemplatetypelink.md + - docs/models/templatecreatetemplateunauthorizederror.md + - docs/models/templatecreatetemplateunauthorizedissue.md + - docs/models/templatecreatetemplatevisibility.md - docs/models/templatedeletetemplatebadrequesterror.md - docs/models/templatedeletetemplatebadrequestissue.md - docs/models/templatedeletetemplatedirectlinkbadrequesterror.md - docs/models/templatedeletetemplatedirectlinkbadrequestissue.md + - docs/models/templatedeletetemplatedirectlinkforbiddenerror.md + - docs/models/templatedeletetemplatedirectlinkforbiddenissue.md - docs/models/templatedeletetemplatedirectlinkinternalservererror.md - docs/models/templatedeletetemplatedirectlinkinternalservererrorissue.md - docs/models/templatedeletetemplatedirectlinkrequest.md - docs/models/templatedeletetemplatedirectlinkresponse.md + - docs/models/templatedeletetemplatedirectlinkunauthorizederror.md + - docs/models/templatedeletetemplatedirectlinkunauthorizedissue.md + - docs/models/templatedeletetemplateforbiddenerror.md + - docs/models/templatedeletetemplateforbiddenissue.md - docs/models/templatedeletetemplateinternalservererror.md - docs/models/templatedeletetemplateinternalservererrorissue.md - docs/models/templatedeletetemplaterequest.md - docs/models/templatedeletetemplateresponse.md - - docs/models/templatedocumentdata.md - - docs/models/templatedocumentdatatype.md + - docs/models/templatedeletetemplateunauthorizederror.md + - docs/models/templatedeletetemplateunauthorizedissue.md - docs/models/templateduplicatetemplateauthoptions.md - docs/models/templateduplicatetemplatebadrequesterror.md - docs/models/templateduplicatetemplatebadrequestissue.md + - docs/models/templateduplicatetemplateforbiddenerror.md + - docs/models/templateduplicatetemplateforbiddenissue.md - docs/models/templateduplicatetemplateglobalaccessauth.md - docs/models/templateduplicatetemplateglobalactionauth.md - docs/models/templateduplicatetemplateinternalservererror.md @@ -1566,6 +2953,8 @@ generatedFiles: - docs/models/templateduplicatetemplaterequest.md - docs/models/templateduplicatetemplateresponse.md - docs/models/templateduplicatetemplatetype.md + - docs/models/templateduplicatetemplateunauthorizederror.md + - docs/models/templateduplicatetemplateunauthorizedissue.md - docs/models/templateduplicatetemplatevisibility.md - docs/models/templatefindtemplatesaccessauth.md - docs/models/templatefindtemplatesactionauth.md @@ -1574,6 +2963,8 @@ generatedFiles: - docs/models/templatefindtemplatesbadrequestissue.md - docs/models/templatefindtemplatesdata.md - docs/models/templatefindtemplatesdatatype.md + - docs/models/templatefindtemplatesdirection1.md + - docs/models/templatefindtemplatesdirection2.md - docs/models/templatefindtemplatesdirectlink.md - docs/models/templatefindtemplatesdistributionmethod.md - docs/models/templatefindtemplatesfield.md @@ -1585,15 +2976,19 @@ generatedFiles: - docs/models/templatefindtemplatesfieldmetaname.md - docs/models/templatefindtemplatesfieldmetanumber.md - docs/models/templatefindtemplatesfieldmetaradio.md + - docs/models/templatefindtemplatesfieldmetasignature.md - docs/models/templatefindtemplatesfieldmetatext.md - docs/models/templatefindtemplatesfieldmetaunion.md - docs/models/templatefindtemplatesfieldtype.md + - docs/models/templatefindtemplatesforbiddenerror.md + - docs/models/templatefindtemplatesforbiddenissue.md - docs/models/templatefindtemplatesglobalaccessauth.md - docs/models/templatefindtemplatesglobalactionauth.md - docs/models/templatefindtemplatesinternalservererror.md - docs/models/templatefindtemplatesinternalservererrorissue.md - docs/models/templatefindtemplatesnotfounderror.md - docs/models/templatefindtemplatesnotfoundissue.md + - docs/models/templatefindtemplatesqueryparamtype.md - docs/models/templatefindtemplatesreadstatus.md - docs/models/templatefindtemplatesrecipient.md - docs/models/templatefindtemplatesrecipientauthoptions.md @@ -1619,19 +3014,27 @@ generatedFiles: - docs/models/templatefindtemplatestypename.md - docs/models/templatefindtemplatestypenumber.md - docs/models/templatefindtemplatestyperadio.md + - docs/models/templatefindtemplatestypesignature.md - docs/models/templatefindtemplatestypetext.md + - docs/models/templatefindtemplatesunauthorizederror.md + - docs/models/templatefindtemplatesunauthorizedissue.md - docs/models/templatefindtemplatesvalue1.md - docs/models/templatefindtemplatesvalue2.md - docs/models/templatefindtemplatesvalue3.md + - docs/models/templatefindtemplatesverticalalign1.md + - docs/models/templatefindtemplatesverticalalign2.md - docs/models/templatefindtemplatesvisibility.md - docs/models/templategettemplatebyidaccessauth.md - docs/models/templategettemplatebyidactionauth.md - docs/models/templategettemplatebyidauthoptions.md - docs/models/templategettemplatebyidbadrequesterror.md - docs/models/templategettemplatebyidbadrequestissue.md + - docs/models/templategettemplatebyiddirection1.md + - docs/models/templategettemplatebyiddirection2.md - docs/models/templategettemplatebyiddirectlink.md - docs/models/templategettemplatebyiddistributionmethod.md - docs/models/templategettemplatebyidemailsettings.md + - docs/models/templategettemplatebyidenvelopeitem.md - docs/models/templategettemplatebyidfield.md - docs/models/templategettemplatebyidfieldmetacheckbox.md - docs/models/templategettemplatebyidfieldmetadate.md @@ -1641,12 +3044,15 @@ generatedFiles: - docs/models/templategettemplatebyidfieldmetaname.md - docs/models/templategettemplatebyidfieldmetanumber.md - docs/models/templategettemplatebyidfieldmetaradio.md + - docs/models/templategettemplatebyidfieldmetasignature.md - docs/models/templategettemplatebyidfieldmetatext.md - docs/models/templategettemplatebyidfieldmetaunion.md - docs/models/templategettemplatebyidfieldtype.md - docs/models/templategettemplatebyidfolder.md - docs/models/templategettemplatebyidfoldertype.md - docs/models/templategettemplatebyidfoldervisibility.md + - docs/models/templategettemplatebyidforbiddenerror.md + - docs/models/templategettemplatebyidforbiddenissue.md - docs/models/templategettemplatebyidglobalaccessauth.md - docs/models/templategettemplatebyidglobalactionauth.md - docs/models/templategettemplatebyidinternalservererror.md @@ -1662,6 +3068,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 @@ -1678,29 +3086,41 @@ generatedFiles: - docs/models/templategettemplatebyidtypename.md - docs/models/templategettemplatebyidtypenumber.md - docs/models/templategettemplatebyidtyperadio.md + - docs/models/templategettemplatebyidtypesignature.md - docs/models/templategettemplatebyidtypetext.md + - docs/models/templategettemplatebyidunauthorizederror.md + - docs/models/templategettemplatebyidunauthorizedissue.md - docs/models/templategettemplatebyiduser.md - docs/models/templategettemplatebyidvalue1.md - docs/models/templategettemplatebyidvalue2.md - docs/models/templategettemplatebyidvalue3.md + - docs/models/templategettemplatebyidverticalalign1.md + - docs/models/templategettemplatebyidverticalalign2.md - docs/models/templategettemplatebyidvisibility.md - docs/models/templatetoggletemplatedirectlinkbadrequesterror.md - docs/models/templatetoggletemplatedirectlinkbadrequestissue.md + - docs/models/templatetoggletemplatedirectlinkforbiddenerror.md + - docs/models/templatetoggletemplatedirectlinkforbiddenissue.md - docs/models/templatetoggletemplatedirectlinkinternalservererror.md - docs/models/templatetoggletemplatedirectlinkinternalservererrorissue.md - docs/models/templatetoggletemplatedirectlinkrequest.md - docs/models/templatetoggletemplatedirectlinkresponse.md + - docs/models/templatetoggletemplatedirectlinkunauthorizederror.md + - docs/models/templatetoggletemplatedirectlinkunauthorizedissue.md - docs/models/templateupdatetemplateauthoptions.md - docs/models/templateupdatetemplatebadrequesterror.md - docs/models/templateupdatetemplatebadrequestissue.md - docs/models/templateupdatetemplatedata.md + - docs/models/templateupdatetemplatedataglobalaccessauth.md + - docs/models/templateupdatetemplatedataglobalactionauth.md - docs/models/templateupdatetemplatedatatype.md + - docs/models/templateupdatetemplatedatavisibility.md - docs/models/templateupdatetemplatedateformat.md - docs/models/templateupdatetemplatedistributionmethod.md - docs/models/templateupdatetemplateemailsettings.md - - docs/models/templateupdatetemplateglobalaccessauthrequest.md + - docs/models/templateupdatetemplateforbiddenerror.md + - docs/models/templateupdatetemplateforbiddenissue.md - docs/models/templateupdatetemplateglobalaccessauthresponse.md - - docs/models/templateupdatetemplateglobalactionauthrequest.md - docs/models/templateupdatetemplateglobalactionauthresponse.md - docs/models/templateupdatetemplateinternalservererror.md - docs/models/templateupdatetemplateinternalservererrorissue.md @@ -1710,16 +3130,25 @@ generatedFiles: - docs/models/templateupdatetemplateresponse.md - docs/models/templateupdatetemplatesigningorder.md - docs/models/templateupdatetemplatetyperesponse.md - - docs/models/templateupdatetemplatevisibilityrequest.md + - docs/models/templateupdatetemplateunauthorizederror.md + - docs/models/templateupdatetemplateunauthorizedissue.md - docs/models/templateupdatetemplatevisibilityresponse.md - docs/models/utils/retryconfig.md - docs/sdks/directlinksdk/README.md - - docs/sdks/documenso/README.md - docs/sdks/documents/README.md + - docs/sdks/documentsattachments/README.md + - docs/sdks/documentsdk/README.md - docs/sdks/documentsfields/README.md - docs/sdks/documentsrecipients/README.md - docs/sdks/embedding/README.md + - docs/sdks/envelopes/README.md + - docs/sdks/envelopesattachments/README.md + - docs/sdks/envelopesfields/README.md + - docs/sdks/envelopesrecipients/README.md + - docs/sdks/folders/README.md + - docs/sdks/items/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,24 +3164,63 @@ 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_attachments.py - src/documenso_sdk/documents_fields.py - src/documenso_sdk/documents_recipients.py - src/documenso_sdk/embedding.py + - src/documenso_sdk/envelopes.py + - src/documenso_sdk/envelopes_attachments.py + - src/documenso_sdk/envelopes_fields.py + - src/documenso_sdk/envelopes_recipients.py + - src/documenso_sdk/folders.py - src/documenso_sdk/httpclient.py + - src/documenso_sdk/items.py - src/documenso_sdk/models/__init__.py - src/documenso_sdk/models/apierror.py - src/documenso_sdk/models/documensoerror.py + - src/documenso_sdk/models/document_attachment_createop.py + - src/documenso_sdk/models/document_attachment_deleteop.py + - src/documenso_sdk/models/document_attachment_findop.py + - src/documenso_sdk/models/document_attachment_updateop.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_createop.py + - src/documenso_sdk/models/document_deleteop.py + - src/documenso_sdk/models/document_distributeop.py + - src/documenso_sdk/models/document_downloadbetaop.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/envelope_attachment_createop.py + - src/documenso_sdk/models/envelope_attachment_deleteop.py + - src/documenso_sdk/models/envelope_attachment_findop.py + - src/documenso_sdk/models/envelope_attachment_updateop.py + - src/documenso_sdk/models/envelope_createop.py + - src/documenso_sdk/models/envelope_deleteop.py + - src/documenso_sdk/models/envelope_distributeop.py + - src/documenso_sdk/models/envelope_duplicateop.py + - src/documenso_sdk/models/envelope_field_createmanyop.py + - src/documenso_sdk/models/envelope_field_deleteop.py + - src/documenso_sdk/models/envelope_field_getop.py + - src/documenso_sdk/models/envelope_field_updatemanyop.py + - src/documenso_sdk/models/envelope_getop.py + - src/documenso_sdk/models/envelope_item_createmanyop.py + - src/documenso_sdk/models/envelope_item_deleteop.py + - src/documenso_sdk/models/envelope_item_downloadop.py + - src/documenso_sdk/models/envelope_item_updatemanyop.py + - src/documenso_sdk/models/envelope_recipient_createmanyop.py + - src/documenso_sdk/models/envelope_recipient_deleteop.py + - src/documenso_sdk/models/envelope_recipient_getop.py + - src/documenso_sdk/models/envelope_recipient_updatemanyop.py + - src/documenso_sdk/models/envelope_redistributeop.py + - src/documenso_sdk/models/envelope_updateop.py + - src/documenso_sdk/models/envelope_useop.py - src/documenso_sdk/models/field_createdocumentfieldop.py - src/documenso_sdk/models/field_createdocumentfieldsop.py - src/documenso_sdk/models/field_createtemplatefieldop.py @@ -1765,6 +3233,10 @@ generatedFiles: - src/documenso_sdk/models/field_updatedocumentfieldsop.py - src/documenso_sdk/models/field_updatetemplatefieldop.py - src/documenso_sdk/models/field_updatetemplatefieldsop.py + - src/documenso_sdk/models/folder_createfolderop.py + - src/documenso_sdk/models/folder_deletefolderop.py + - src/documenso_sdk/models/folder_findfoldersop.py + - src/documenso_sdk/models/folder_updatefolderop.py - src/documenso_sdk/models/no_response_error.py - src/documenso_sdk/models/recipient_createdocumentrecipientop.py - src/documenso_sdk/models/recipient_createdocumentrecipientsop.py @@ -1782,6 +3254,8 @@ 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_createtemplateop.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 +3266,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,11 +3324,15 @@ 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": "", "internalVersion": 3401.82, "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": null, "emailReplyTo": "", "password": null, "documentId": -1}, "envelopeItems": [{"id": "", "envelopeId": ""}], "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": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} document-updateDocument: speakeasy-default-document-update-document: requestBody: @@ -1927,24 +3406,32 @@ 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": true, "fieldMeta": {"fontSize": 12, "type": "radio", "direction": "vertical"}} "400": application/json: {"message": "", "code": ""} "404": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} field-createDocumentField: speakeasy-default-field-create-document-field: requestBody: 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": false, "fieldMeta": null} "400": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} field-createDocumentFields: speakeasy-default-field-create-document-fields: requestBody: @@ -1956,17 +3443,25 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} field-updateDocumentField: speakeasy-default-field-update-document-field: requestBody: 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": true, "fieldMeta": {"fontSize": 12, "type": "initials"}} "400": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} field-updateDocumentFields: speakeasy-default-field-update-document-fields: requestBody: @@ -1978,6 +3473,10 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} field-deleteDocumentField: speakeasy-default-field-delete-document-field: requestBody: @@ -1989,6 +3488,10 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-getDocumentRecipient: speakeasy-default-recipient-get-document-recipient: parameters: @@ -1996,24 +3499,32 @@ 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": true, "fieldMeta": {"fontSize": 12, "type": "checkbox", "direction": "vertical"}, "documentId": null, "templateId": null}]} "400": application/json: {"message": "", "code": ""} "404": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-createDocumentRecipient: speakeasy-default-recipient-create-document-recipient: requestBody: 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": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-createDocumentRecipients: speakeasy-default-recipient-create-document-recipients: requestBody: @@ -2025,28 +3536,40 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-updateDocumentRecipient: speakeasy-default-recipient-update-document-recipient: requestBody: 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": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-updateDocumentRecipients: speakeasy-default-recipient-update-document-recipients: requestBody: 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": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-deleteDocumentRecipient: speakeasy-default-recipient-delete-document-recipient: requestBody: @@ -2058,17 +3581,25 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} template-findTemplates: 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": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} template-getTemplateById: speakeasy-default-template-get-template-by-id: parameters: @@ -2076,35 +3607,47 @@ 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": false, "fieldMeta": {"fontSize": 12, "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"}, "envelopeItems": [{"id": "", "envelopeId": ""}]} "400": application/json: {"message": "", "code": ""} "404": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} template-updateTemplate: speakeasy-default-template-update-template: requestBody: 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": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} template-duplicateTemplate: speakeasy-default-template-duplicate-template: requestBody: 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": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} template-deleteTemplate: speakeasy-default-template-delete-template: requestBody: @@ -2116,17 +3659,25 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} template-createDocumentFromTemplate: speakeasy-default-template-create-document-from-template: requestBody: 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": "", "internalVersion": 7392.96, "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}, "envelopeItems": [], "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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": true, "fieldMeta": {"fontSize": 12, "type": "radio", "direction": "vertical"}, "documentId": 518.53, "templateId": 9453.15}]} "400": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} template-moveTemplateToTeam: speakeasy-default-template-move-template-to-team: requestBody: @@ -2144,11 +3695,15 @@ 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": false, "fieldMeta": {"fontSize": 12, "type": "checkbox", "direction": "vertical"}} "400": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} field-getTemplateField: speakeasy-default-field-get-template-field: parameters: @@ -2156,46 +3711,62 @@ 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": false, "fieldMeta": {"fontSize": 12, "type": "number"}} "400": application/json: {"message": "", "code": ""} "404": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} field-createTemplateFields: speakeasy-default-field-create-template-fields: requestBody: 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": true, "fieldMeta": {"fontSize": 12, "type": "name"}, "documentId": 6981.63, "templateId": 9898.46}]} "400": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} field-updateTemplateField: speakeasy-default-field-update-template-field: requestBody: 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": false, "fieldMeta": {"fontSize": 12, "type": "number"}} "400": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} field-updateTemplateFields: speakeasy-default-field-update-template-fields: requestBody: 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": true, "fieldMeta": {"fontSize": 12, "type": "initials"}, "documentId": 3141.26, "templateId": 6919.19}]} "400": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} field-deleteTemplateField: speakeasy-default-field-delete-template-field: requestBody: @@ -2207,6 +3778,10 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-getTemplateRecipient: speakeasy-default-recipient-get-template-recipient: parameters: @@ -2214,24 +3789,32 @@ 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": false, "fieldMeta": {"fontSize": 12, "type": "radio", "direction": "vertical"}, "documentId": 3041.54, "templateId": 8898.39}]} "400": application/json: {"message": "", "code": ""} "404": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-createTemplateRecipient: speakeasy-default-recipient-create-template-recipient: requestBody: 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": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-createTemplateRecipients: speakeasy-default-recipient-create-template-recipients: requestBody: @@ -2243,28 +3826,40 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-updateTemplateRecipient: speakeasy-default-recipient-update-template-recipient: requestBody: 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": false, "fieldMeta": {"fontSize": 12, "type": "radio", "direction": "vertical"}, "documentId": null, "templateId": null}]} "400": application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-updateTemplateRecipients: speakeasy-default-recipient-update-template-recipients: requestBody: 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": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} recipient-deleteTemplateRecipient: speakeasy-default-recipient-delete-template-recipient: requestBody: @@ -2276,17 +3871,25 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} template-createTemplateDirectLink: speakeasy-default-template-create-template-direct-link: requestBody: 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": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} template-deleteTemplateDirectLink: speakeasy-default-template-delete-template-direct-link: requestBody: @@ -2298,17 +3901,25 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} template-toggleTemplateDirectLink: speakeasy-default-template-toggle-template-direct-link: requestBody: 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": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} embeddingPresign-createEmbeddingPresignToken: speakeasy-default-embedding-presign-create-embedding-presign-token: requestBody: @@ -2320,6 +3931,10 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} embeddingPresign-verifyEmbeddingPresignToken: speakeasy-default-embedding-presign-verify-embedding-presign-token: requestBody: @@ -2331,6 +3946,706 @@ examples: application/json: {"message": "", "code": ""} "500": application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + envelope-get: + speakeasy-default-envelope-get: + parameters: + path: + envelopeId: "" + responses: + "200": + application/json: {"internalVersion": 4280.57, "type": "TEMPLATE", "status": "DRAFT", "source": "TEMPLATE", "visibility": "EVERYONE", "templateType": "PRIVATE", "id": "", "secondaryId": "", "externalId": "", "createdAt": "1706851905687", "updatedAt": "1735647137363", "completedAt": null, "deletedAt": "", "title": "", "authOptions": {"globalAccessAuth": ["TWO_FACTOR_AUTH"], "globalActionAuth": ["PASSKEY"]}, "formValues": {}, "publicTitle": "", "publicDescription": "", "userId": 8798.23, "teamId": 3874.83, "folderId": "", "templateId": 5656.37, "documentMeta": {"signingOrder": "SEQUENTIAL", "distributionMethod": "EMAIL", "id": "", "subject": "", "message": null, "timezone": "Africa/Ouagadougou", "dateFormat": "", "redirectUrl": "https://stunning-fibre.net", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": true, "allowDictateNextSigner": true, "language": "", "emailSettings": {"recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true}, "emailId": "", "emailReplyTo": ""}, "recipients": [{"envelopeId": "", "role": "VIEWER", "readStatus": "OPENED", "signingStatus": "NOT_SIGNED", "sendStatus": "SENT", "id": 3145.18, "email": "Mattie38@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": ["ACCOUNT"], "actionAuth": ["PASSKEY"]}, "signingOrder": 6651.45, "rejectionReason": ""}], "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "INITIALS", "id": 7874.96, "secondaryId": "", "recipientId": 8559.75, "page": 5218.36, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": true, "fieldMeta": {"fontSize": 12, "type": "date"}}], "envelopeItems": [], "directLink": {"directTemplateRecipientId": 3794.07, "enabled": false, "id": "", "token": ""}, "team": {"id": 6419.41, "url": "https://worthless-diagram.biz"}, "user": {"id": 4064.32, "name": "", "email": "Magnus.Mayer@gmail.com"}} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-create: + speakeasy-default-envelope-create: + requestBody: + multipart/form-data: {"payload": {"title": "", "type": "TEMPLATE"}} + responses: + "200": + application/json: {"id": ""} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-use: + speakeasy-default-envelope-use: + requestBody: + multipart/form-data: {"payload": {"envelopeId": "", "recipients": []}} + responses: + "200": + application/json: {"id": ""} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-update: + speakeasy-default-envelope-update: + requestBody: + application/json: {"envelopeId": ""} + responses: + "200": + application/json: {"internalVersion": 707.44, "type": "TEMPLATE", "status": "DRAFT", "source": "DOCUMENT", "visibility": "EVERYONE", "templateType": "PUBLIC", "id": "", "secondaryId": "", "externalId": "", "createdAt": "1726672856184", "updatedAt": "1735623270144", "completedAt": "", "deletedAt": "", "title": "", "authOptions": {"globalAccessAuth": [], "globalActionAuth": []}, "formValues": {}, "publicTitle": "", "publicDescription": "", "userId": 744.99, "teamId": 9970.97, "folderId": ""} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-delete: + speakeasy-default-envelope-delete: + requestBody: + application/json: {"envelopeId": ""} + responses: + "200": + application/json: {"success": true} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-duplicate: + speakeasy-default-envelope-duplicate: + requestBody: + application/json: {"envelopeId": ""} + responses: + "200": + application/json: {"id": ""} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-distribute: + speakeasy-default-envelope-distribute: + requestBody: + application/json: {"envelopeId": ""} + responses: + "200": + application/json: {"success": false} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-redistribute: + speakeasy-default-envelope-redistribute: + requestBody: + application/json: {"envelopeId": "", "recipients": []} + responses: + "200": + application/json: {"success": false} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-attachment-find: + speakeasy-default-envelope-attachment-find: + parameters: + query: + envelopeId: "" + responses: + "200": + application/json: {"data": [{"id": "", "type": "link", "label": "", "data": ""}]} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-attachment-create: + speakeasy-default-envelope-attachment-create: + requestBody: + application/json: {"envelopeId": "", "data": {"label": "", "data": "https://lustrous-skeleton.info"}} + responses: + "200": + application/json: {"id": ""} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-attachment-update: + speakeasy-default-envelope-attachment-update: + requestBody: + application/json: {"id": "", "data": {"label": "", "data": "https://tough-premier.biz"}} + responses: + "200": + application/json: {"success": true} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-attachment-delete: + speakeasy-default-envelope-attachment-delete: + requestBody: + application/json: {"id": ""} + responses: + "200": + application/json: {"success": false} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-item-createMany: + speakeasy-default-envelope-item-create-many: + requestBody: + multipart/form-data: {"payload": {"envelopeId": ""}} + responses: + "200": + application/json: {"data": [{"id": "", "title": "", "envelopeId": "", "order": 195.81}]} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-item-updateMany: + speakeasy-default-envelope-item-update-many: + requestBody: + application/json: {"envelopeId": "", "data": []} + responses: + "200": + application/json: {"data": []} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-item-delete: + speakeasy-default-envelope-item-delete: + requestBody: + application/json: {"envelopeId": "", "envelopeItemId": ""} + responses: + "200": + application/json: {"success": true} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-item-download: + speakeasy-default-envelope-item-download: + parameters: + path: + envelopeItemId: "" + query: + version: "signed" + responses: + "200": + application/json: "" + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-recipient-get: + speakeasy-default-envelope-recipient-get: + parameters: + path: + recipientId: 8771.72 + responses: + "200": + application/json: {"envelopeId": "", "role": "CC", "readStatus": "OPENED", "signingStatus": "SIGNED", "sendStatus": "SENT", "id": 5309.5, "email": "Julius_Weber@hotmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": [], "actionAuth": []}, "signingOrder": 4006.64, "rejectionReason": "", "fields": []} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-recipient-createMany: + speakeasy-default-envelope-recipient-create-many: + requestBody: + application/json: {"envelopeId": "", "data": [{"email": "Ed16@yahoo.com", "name": "", "role": "SIGNER"}]} + responses: + "200": + application/json: {"data": []} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-recipient-updateMany: + speakeasy-default-envelope-recipient-update-many: + requestBody: + application/json: {"envelopeId": "", "data": [{"id": 8894.57}]} + responses: + "200": + application/json: {"data": []} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-recipient-delete: + speakeasy-default-envelope-recipient-delete: + requestBody: + application/json: {"recipientId": 4834.93} + responses: + "200": + application/json: {"success": false} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-field-get: + speakeasy-default-envelope-field-get: + parameters: + path: + fieldId: 6981.76 + responses: + "200": + application/json: {"envelopeId": "", "envelopeItemId": "", "type": "EMAIL", "id": 8352.27, "secondaryId": "", "recipientId": 7648.45, "page": 1986.1, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": true, "fieldMeta": {"fontSize": 12, "type": "text"}} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-field-createMany: + speakeasy-default-envelope-field-create-many: + requestBody: + application/json: {"envelopeId": "", "data": []} + responses: + "200": + application/json: {"data": [{"envelopeId": "", "envelopeItemId": "", "type": "DATE", "id": 7462.76, "secondaryId": "", "recipientId": 2239.25, "page": 9989.17, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": false, "fieldMeta": {"fontSize": 12, "type": "dropdown"}}]} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-field-updateMany: + speakeasy-default-envelope-field-update-many: + requestBody: + application/json: {"envelopeId": "", "data": []} + responses: + "200": + application/json: {"data": [{"envelopeId": "", "envelopeItemId": "", "type": "INITIALS", "id": 7807.4, "secondaryId": "", "recipientId": 3744.17, "page": 4715.21, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": false, "fieldMeta": {"fontSize": 12, "type": "signature"}}]} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + envelope-field-delete: + speakeasy-default-envelope-field-delete: + requestBody: + application/json: {"fieldId": 2481.37} + responses: + "200": + application/json: {"success": false} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + 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": "", "internalVersion": 4732.99, "documentDataId": "", "documentData": {"type": "S3_PATH", "id": "", "data": "", "initialData": "", "envelopeItemId": ""}, "documentMeta": {"signingOrder": "SEQUENTIAL", "distributionMethod": "NONE", "id": "", "subject": "", "message": "", "timezone": "America/St_Vincent", "dateFormat": "", "redirectUrl": "https://celebrated-tail.net", "typedSignatureEnabled": false, "uploadSignatureEnabled": false, "drawSignatureEnabled": false, "allowDictateNextSigner": true, "language": "", "emailSettings": null, "emailId": "", "emailReplyTo": "", "password": null, "documentId": -1}, "envelopeItems": [], "folder": {"id": "", "name": "", "type": "TEMPLATE", "visibility": "ADMIN", "userId": 8803.39, "teamId": 343.36, "pinned": true, "parentId": "", "createdAt": "1715771199304", "updatedAt": "1735651498506"}, "recipients": [{"envelopeId": "", "role": "VIEWER", "readStatus": "OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 7995.91, "email": "Kylee14@yahoo.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": "", "authOptions": {"accessAuth": [], "actionAuth": ["EXPLICIT_NONE"]}, "signingOrder": 3251.85, "rejectionReason": ""}], "fields": [{"envelopeId": "", "envelopeItemId": "", "type": "INITIALS", "id": 1397.92, "secondaryId": "", "recipientId": 6415.84, "page": 2975.02, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": true, "fieldMeta": {"fontSize": 12, "type": "text"}}]} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + 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": "", "internalVersion": 5236.27, "documentDataId": "", "user": {"id": 7830.37, "name": "", "email": "Andre80@yahoo.com"}, "recipients": [{"envelopeId": "", "role": "ASSISTANT", "readStatus": "NOT_OPENED", "signingStatus": "REJECTED", "sendStatus": "SENT", "id": 4374.98, "email": "Addie39@gmail.com", "name": "", "token": "", "documentDeletedAt": "", "expired": "", "signedAt": null, "authOptions": {"accessAuth": ["TWO_FACTOR_AUTH"], "actionAuth": []}, "signingOrder": 4500.35, "rejectionReason": ""}], "team": {"id": 2361.04, "url": "https://appropriate-castanet.org/"}}], "count": 6162.13, "currentPage": 1918.85, "perPage": 5292.54, "totalPages": 6035.56} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-create: + speakeasy-default-document-create: + requestBody: + multipart/form-data: {"payload": {"title": ""}, "file": "x-file: example.file"} + responses: + "200": + application/json: {"envelopeId": "", "id": 1247.59} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + 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": "", "internalVersion": 3233.33, "documentDataId": ""} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + 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": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + 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": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + 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": "", "internalVersion": 1291, "documentDataId": ""} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + 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": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + 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: "" + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-attachment-create: + speakeasy-default-document-attachment-create: + requestBody: + application/json: {"documentId": 7014.36, "data": {"label": "", "data": "https://cheerful-bourgeoisie.org/"}} + responses: + "200": + application/json: {"id": ""} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-attachment-update: + speakeasy-default-document-attachment-update: + requestBody: + application/json: {"id": "", "data": {"label": "", "data": "https://tinted-ceramics.biz"}} + responses: + "200": + application/json: {"success": true} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-attachment-delete: + speakeasy-default-document-attachment-delete: + requestBody: + application/json: {"id": ""} + responses: + "200": + application/json: {"success": false} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-attachment-find: + speakeasy-default-document-attachment-find: + parameters: + query: + documentId: 965.17 + responses: + "200": + application/json: {"data": []} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + document-downloadBeta: + speakeasy-default-document-download-beta: + parameters: + path: + documentId: 9550.11 + query: + version: "signed" + responses: + "200": + application/json: {"downloadUrl": "https://strident-contrail.net", "filename": "example.file", "contentType": ""} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + template-createTemplate: + speakeasy-default-template-create-template: + requestBody: + multipart/form-data: {"payload": {"title": ""}, "file": "x-file: example.file"} + responses: + "200": + application/json: {"envelopeId": "", "id": 9353.74} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + folder-findFolders: + speakeasy-default-folder-find-folders: + responses: + "200": + application/json: {"data": [{"id": "", "name": "", "userId": 4046.76, "teamId": 6905.08, "parentId": "", "pinned": true, "createdAt": "1715546444342", "updatedAt": "1735623630892", "visibility": "EVERYONE", "type": "TEMPLATE"}], "count": 5869.92, "currentPage": 3949.24, "perPage": 9820.55, "totalPages": 6586.83} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "404": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + folder-createFolder: + speakeasy-default-folder-create-folder: + requestBody: + application/json: {"name": ""} + responses: + "200": + application/json: {"id": "", "name": "", "userId": 8739.23, "teamId": 1311.57, "parentId": "", "pinned": false, "createdAt": "1717527332082", "updatedAt": "1735686418947", "visibility": "ADMIN", "type": "DOCUMENT"} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + folder-updateFolder: + speakeasy-default-folder-update-folder: + requestBody: + application/json: {"folderId": "", "data": {}} + responses: + "200": + application/json: {"id": "", "name": "", "userId": 3066.76, "teamId": 8570.02, "parentId": null, "pinned": false, "createdAt": "1705673377446", "updatedAt": "1735664987955", "visibility": "EVERYONE", "type": "TEMPLATE"} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + application/json: {"message": "", "code": ""} + "500": + application/json: {"message": "", "code": ""} + folder-deleteFolder: + speakeasy-default-folder-delete-folder: + requestBody: + application/json: {"folderId": ""} + responses: + "200": + application/json: {"success": false} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + 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, "positionX": "", "positionY": "", "width": "", "height": "", "customText": "", "inserted": true, "fieldMeta": null}], "folder": null, "envelopeItems": []}, "uploadUrl": "https://hungry-dulcimer.info/"} + "400": + application/json: {"message": "", "code": ""} + "401": + application/json: {"message": "", "code": ""} + "403": + 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.get()`: \n * `request.folder_id` **Removed** **Breaking** :warning:\n * `response` **Changed** **Breaking** :warning:\n * `error` **Changed**\n* `documenso.templates.use()`: \n * `request` **Changed**\n * `response` **Changed** **Breaking** :warning:\n * `error` **Changed**\n* `documenso.templates.get()`: \n * `response` **Changed** **Breaking** :warning:\n * `error` **Changed**\n* `documenso.templates.find()`: \n * `response.data.[]` **Changed** **Breaking** :warning:\n * `error` **Changed**\n* `documenso.documents.create_v0()`: \n * `request` **Changed**\n * `response.document` **Changed** **Breaking** :warning:\n * `error` **Changed**\n* `documenso.envelopes.fields.get()`: **Added**\n* `documenso.documents.redistribute()`: `error` **Changed**\n* `documenso.envelopes.redistribute()`: **Added**\n* `documenso.envelopes.attachments.find()`: **Added**\n* `documenso.envelopes.attachments.create()`: **Added**\n* `documenso.envelopes.attachments.update()`: **Added**\n* `documenso.envelopes.attachments.delete()`: **Added**\n* `documenso.envelopes.items.create_many()`: **Added**\n* `documenso.envelopes.items.update_many()`: **Added**\n* `documenso.envelopes.items.delete()`: **Added**\n* `documenso.envelopes.items.download()`: **Added**\n* `documenso.envelopes.recipients.get()`: **Added**\n* `documenso.envelopes.recipients.create_many()`: **Added**\n* `documenso.envelopes.recipients.update_many()`: **Added**\n* `documenso.envelopes.recipients.delete()`: **Added**\n* `documenso.envelopes.get()`: **Added**\n* `documenso.envelopes.fields.create_many()`: **Added**\n* `documenso.envelopes.fields.update_many()`: **Added**\n* `documenso.envelopes.fields.delete()`: **Added**\n* `documenso.documents.create()`: **Added**\n* `documenso.documents.download()`: **Added**\n* `documenso.documents.attachments.create()`: **Added**\n* `documenso.documents.attachments.update()`: **Added**\n* `documenso.documents.attachments.delete()`: **Added**\n* `documenso.documents.attachments.find()`: **Added**\n* `documenso.document.document_download()`: **Added**\n* `documenso.templates.create()`: **Added**\n* `documenso.documents.distribute()`: \n * `request.meta` **Changed**\n * `response` **Changed**\n * `error` **Changed**\n* `documenso.folders.create()`: **Added**\n* `documenso.folders.update()`: **Added**\n* `documenso.folders.delete()`: **Added**\n* `documenso.template.template-create_template_temporary()`: **Added**\n* `documenso.documents.update()`: \n * `request` **Changed**\n * `response` **Changed**\n * `error` **Changed**\n* `documenso.documents.find()`: \n * `response.data.[]` **Changed**\n * `error` **Changed**\n* `documenso.envelopes.duplicate()`: **Added**\n* `documenso.envelopes.delete()`: **Added**\n* `documenso.envelopes.distribute()`: **Added**\n* `documenso.documents.delete()`: `error` **Changed**\n* `documenso.folders.find()`: **Added**\n* `documenso.documents.duplicate()`: \n * `response.id` **Added**\n * `error` **Changed**\n* `documenso.documents.fields.get()`: \n * `response` **Changed**\n * `error` **Changed**\n* `documenso.documents.fields.create()`: \n * `request.field.[class].field_meta` **Changed**\n * `response` **Changed**\n * `error` **Changed**\n* `documenso.documents.fields.create_many()`: \n * `request.fields.[].[class].field_meta` **Changed**\n * `response.fields.[]` **Changed**\n * `error` **Changed**\n* `documenso.documents.fields.update()`: \n * `request.field.[class].field_meta` **Changed**\n * `response` **Changed**\n * `error` **Changed**\n* `documenso.documents.fields.update_many()`: \n * `request.fields.[].[class].field_meta` **Changed**\n * `response.fields.[]` **Changed**\n * `error` **Changed**\n* `documenso.documents.fields.delete()`: `error` **Changed**\n* `documenso.documents.recipients.get()`: \n * `response` **Changed**\n * `error` **Changed**\n* `documenso.documents.recipients.create()`: \n * `response` **Changed**\n * `error` **Changed**\n* `documenso.documents.recipients.create_many()`: \n * `response.recipients.[]` **Changed**\n * `error` **Changed**\n* `documenso.documents.recipients.update()`: \n * `response` **Changed**\n * `error` **Changed**\n* `documenso.documents.recipients.update_many()`: \n * `response.recipients.[]` **Changed**\n * `error` **Changed**\n* `documenso.documents.recipients.delete()`: `error` **Changed**\n* `documenso.envelopes.update()`: **Added**\n* `documenso.envelopes.use()`: **Added**\n* `documenso.templates.update()`: \n * `request` **Changed**\n * `response` **Changed**\n * `error` **Changed**\n* `documenso.templates.duplicate()`: \n * `response` **Changed**\n * `error` **Changed**\n* `documenso.templates.delete()`: `error` **Changed**\n* `documenso.envelopes.create()`: **Added**\n* `documenso.templates.fields.create()`: \n * `request.field.[class].field_meta` **Changed**\n * `response` **Changed**\n * `error` **Changed**\n* `documenso.templates.fields.get()`: \n * `response` **Changed**\n * `error` **Changed**\n* `documenso.templates.fields.create_many()`: \n * `request.fields.[].[class].field_meta` **Changed**\n * `response.fields.[]` **Changed**\n * `error` **Changed**\n* `documenso.templates.fields.update()`: \n * `request.field.[class].field_meta` **Changed**\n * `response` **Changed**\n * `error` **Changed**\n* `documenso.templates.fields.update_many()`: \n * `request.fields.[].[class].field_meta` **Changed**\n * `response.fields.[]` **Changed**\n * `error` **Changed**\n* `documenso.templates.fields.delete()`: `error` **Changed**\n* `documenso.templates.recipients.get()`: \n * `response` **Changed**\n * `error` **Changed**\n* `documenso.templates.recipients.create()`: \n * `response` **Changed**\n * `error` **Changed**\n* `documenso.templates.recipients.create_many()`: \n * `response.recipients.[]` **Changed**\n * `error` **Changed**\n* `documenso.templates.recipients.update()`: \n * `response` **Changed**\n * `error` **Changed**\n* `documenso.templates.recipients.update_many()`: \n * `response.recipients.[]` **Changed**\n * `error` **Changed**\n* `documenso.templates.recipients.delete()`: `error` **Changed**\n* `documenso.templates.direct_link.create()`: \n * `response.envelope_id` **Added**\n * `error` **Changed**\n* `documenso.templates.direct_link.delete()`: `error` **Changed**\n* `documenso.templates.direct_link.toggle()`: \n * `response.envelope_id` **Added**\n * `error` **Changed**\n* `documenso.embedding.embedding_presign-create_embedding_presign_token()`: `error` **Changed**\n* `documenso.embedding.embedding_presign-verify_embedding_presign_token()`: `error` **Changed**\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..e8cad56 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,20 +1,20 @@ -speakeasyVersion: 1.606.10 +speakeasyVersion: 1.654.0 sources: documenso-OAS: sourceNamespace: documenso-v-2-beta-api - sourceRevisionDigest: sha256:edad9cc20eb56ca39753b7a96c8c75f876e716df520da392bd8aab9dac31f0f9 - sourceBlobDigest: sha256:03b086614aed59a736a1a84f96e719f587b3fe7c599647320f711b19c6e7a586 + sourceRevisionDigest: sha256:a1aff63b3508ca901e6fb813d3c6e33f105e2bbe7e8f861864c3ea0614d16db8 + sourceBlobDigest: sha256:74cf4e37b5f6518d424d3d6023016935fa0bdbfd71e0bad8453dba473f30b75d 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:a1aff63b3508ca901e6fb813d3c6e33f105e2bbe7e8f861864c3ea0614d16db8 + sourceBlobDigest: sha256:74cf4e37b5f6518d424d3d6023016935fa0bdbfd71e0bad8453dba473f30b75d codeSamplesNamespace: documenso-oas-python-code-samples - codeSamplesRevisionDigest: sha256:db0a037286d8310ff53552a5aae4c5f7b9cd7a833eac6b4a19c3fd9c4cb4de26 + codeSamplesRevisionDigest: sha256:5d3cc785dbce7dfa881e7042efb9ddf3a61d4876618f623d6e650fac427021d8 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README-PYPI.md b/README-PYPI.md index 6afead6..58474bf 100644 --- a/README-PYPI.md +++ b/README-PYPI.md @@ -245,17 +245,29 @@ 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 +* [create](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#create) - Create document +* [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 +* [download](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#download) - Download document +* [create_v0](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documents/README.md#create_v0) - Create document + +#### [documents.attachments](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documentsattachments/README.md) + +* [create](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documentsattachments/README.md#create) - Create attachment +* [update](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documentsattachments/README.md#update) - Update attachment +* [delete](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documentsattachments/README.md#delete) - Delete attachment +* [find](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documentsattachments/README.md#find) - Find attachments #### [documents.fields](https://github.com/documenso/sdk-python/blob/master/docs/sdks/documentsfields/README.md) @@ -280,10 +292,61 @@ 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 +### [envelopes](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopes/README.md) + +* [get](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopes/README.md#get) - Get envelope +* [create](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopes/README.md#create) - Create envelope +* [use](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopes/README.md#use) - Use envelope +* [update](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopes/README.md#update) - Update envelope +* [delete](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopes/README.md#delete) - Delete envelope +* [duplicate](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopes/README.md#duplicate) - Duplicate envelope +* [distribute](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopes/README.md#distribute) - Distribute envelope +* [redistribute](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopes/README.md#redistribute) - Redistribute envelope + +#### [envelopes.attachments](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesattachments/README.md) + +* [find](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesattachments/README.md#find) - Find attachments +* [create](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesattachments/README.md#create) - Create attachment +* [update](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesattachments/README.md#update) - Update attachment +* [delete](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesattachments/README.md#delete) - Delete attachment + +#### [envelopes.fields](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesfields/README.md) + +* [get](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesfields/README.md#get) - Get envelope field +* [create_many](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesfields/README.md#create_many) - Create envelope fields +* [update_many](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesfields/README.md#update_many) - Update envelope fields +* [delete](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesfields/README.md#delete) - Delete envelope field + +#### [envelopes.items](https://github.com/documenso/sdk-python/blob/master/docs/sdks/items/README.md) + +* [create_many](https://github.com/documenso/sdk-python/blob/master/docs/sdks/items/README.md#create_many) - Create envelope items +* [update_many](https://github.com/documenso/sdk-python/blob/master/docs/sdks/items/README.md#update_many) - Update envelope items +* [delete](https://github.com/documenso/sdk-python/blob/master/docs/sdks/items/README.md#delete) - Delete envelope item +* [download](https://github.com/documenso/sdk-python/blob/master/docs/sdks/items/README.md#download) - Download an envelope item + +#### [envelopes.recipients](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesrecipients/README.md) + +* [get](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesrecipients/README.md#get) - Get envelope recipient +* [create_many](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesrecipients/README.md#create_many) - Create envelope recipients +* [update_many](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesrecipients/README.md#update_many) - Update envelope recipients +* [delete](https://github.com/documenso/sdk-python/blob/master/docs/sdks/envelopesrecipients/README.md#delete) - Delete envelope recipient + +### [folders](https://github.com/documenso/sdk-python/blob/master/docs/sdks/folders/README.md) + +* [find](https://github.com/documenso/sdk-python/blob/master/docs/sdks/folders/README.md#find) - Find folders +* [create](https://github.com/documenso/sdk-python/blob/master/docs/sdks/folders/README.md#create) - Create new folder +* [update](https://github.com/documenso/sdk-python/blob/master/docs/sdks/folders/README.md#update) - Update folder +* [delete](https://github.com/documenso/sdk-python/blob/master/docs/sdks/folders/README.md#delete) - Delete folder + +### [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 * [get](https://github.com/documenso/sdk-python/blob/master/docs/sdks/templates/README.md#get) - Get template +* [create](https://github.com/documenso/sdk-python/blob/master/docs/sdks/templates/README.md#create) - Create template * [update](https://github.com/documenso/sdk-python/blob/master/docs/sdks/templates/README.md#update) - Update template * [duplicate](https://github.com/documenso/sdk-python/blob/master/docs/sdks/templates/README.md#duplicate) - Duplicate template * [delete](https://github.com/documenso/sdk-python/blob/master/docs/sdks/templates/README.md#delete) - Delete template @@ -316,6 +379,37 @@ if __name__ == "__main__":
+ +## File uploads + +Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request. + +> [!TIP] +> +> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files. +> + +```python +import documenso_sdk +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.create(payload={ + "title": "", + "type": documenso_sdk.EnvelopeCreateType.TEMPLATE, + }) + + # Handle response + print(res) + +``` + + ## Retries @@ -332,7 +426,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92, + res = documenso.envelopes.get(envelope_id="", RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False)) # Handle response @@ -352,7 +446,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92) + res = documenso.envelopes.get(envelope_id="") # Handle response print(res) @@ -387,7 +481,7 @@ with Documenso( res = None try: - res = documenso.documents.update(document_id=9701.92) + res = documenso.envelopes.get(envelope_id="") # Handle response print(res) @@ -402,17 +496,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.EnvelopeGetBadRequestError): 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.EnvelopeGetBadRequestIssue]] ``` ### 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 (342)
@@ -423,100 +517,343 @@ 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.* +* [`EnvelopeGetBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopegetbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeCreateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopecreatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeUseBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeusebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeUpdateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeupdatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeDeleteBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopedeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeDuplicateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeduplicatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeDistributeBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopedistributebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeRedistributeBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperedistributebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 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 80 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 80 methods.* +* [`DocumentCreateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentcreatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 methods.* +* [`DocumentDownloadBetaBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdownloadbetabadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 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 80 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 80 methods.* +* [`TemplateCreateTemplateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 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 80 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 80 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 80 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 80 methods.* +* [`FolderFindFoldersBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderfindfoldersbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FolderCreateFolderBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/foldercreatefolderbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FolderUpdateFolderBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderupdatefolderbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FolderDeleteFolderBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderdeletefolderbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 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 80 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 80 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 80 methods.* +* [`EnvelopeAttachmentFindBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentfindbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentCreateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentcreatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentUpdateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentupdatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentDeleteBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemCreateManyBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemcreatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemUpdateManyBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemupdatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDeleteBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDownloadBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemdownloadbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientGetBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientgetbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientCreateManyBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientcreatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientUpdateManyBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientupdatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientDeleteBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldGetBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldgetbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldCreateManyBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldcreatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldUpdateManyBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldupdatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldDeleteBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefielddeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentCreateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentcreatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentUpdateBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentupdatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentDeleteBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentFindBadRequestError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentfindbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 methods.* +* [`EnvelopeGetUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopegetunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeCreateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopecreateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeUseUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeuseunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeUpdateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeupdateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeDeleteUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopedeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeDuplicateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeduplicateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeDistributeUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopedistributeunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeRedistributeUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperedistributeunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentGetUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentgetunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentFindUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentfindunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentCreateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentcreateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentUpdateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentupdateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentDeleteUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentDuplicateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentduplicateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentDistributeUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdistributeunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentRedistributeUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentredistributeunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdownloadunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentCreateDocumentTemporaryUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentcreatedocumenttemporaryunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadBetaUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdownloadbetaunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateFindTemplatesUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatefindtemplatesunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateGetTemplateByIDUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templategettemplatebyidunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateUpdateTemplateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateupdatetemplateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateDuplicateTemplateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateduplicatetemplateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateCreateDocumentFromTemplateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatedocumentfromtemplateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FolderFindFoldersUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderfindfoldersunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FolderCreateFolderUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/foldercreatefolderunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FolderUpdateFolderUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderupdatefolderunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FolderDeleteFolderUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderdeletefolderunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateTemporaryUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatetemporaryunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokenunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokenunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentFindUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentfindunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentCreateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentcreateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentUpdateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentupdateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentDeleteUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentdeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemCreateManyUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemcreatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemUpdateManyUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemupdatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDeleteUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemdeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDownloadUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemdownloadunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientGetUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientgetunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientCreateManyUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientcreatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientUpdateManyUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientupdatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientDeleteUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientdeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldGetUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldgetunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldCreateManyUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldcreatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldUpdateManyUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldupdatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldDeleteUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefielddeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentCreateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentcreateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentUpdateUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentupdateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentDeleteUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentdeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentFindUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentfindunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldGetDocumentFieldUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgetdocumentfieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldsUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldsUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldDeleteDocumentFieldUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletedocumentfieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientGetDocumentRecipientUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgetdocumentrecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientsUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientsUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteDocumentRecipientUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletedocumentrecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldGetTemplateFieldUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgettemplatefieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldsUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldsUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldDeleteTemplateFieldUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletetemplatefieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientGetTemplateRecipientUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgettemplaterecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientsUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientsUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteTemplateRecipientUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletetemplaterecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateDirectLinkUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatedirectlinkunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateDirectLinkUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplatedirectlinkunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateToggleTemplateDirectLinkUnauthorizedError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatetoggletemplatedirectlinkunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeGetForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopegetforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeCreateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopecreateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeUseForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeuseforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeUpdateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeupdateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeDeleteForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopedeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeDuplicateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeduplicateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeDistributeForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopedistributeforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeRedistributeForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperedistributeforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentGetForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentgetforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentFindForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentfindforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentCreateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentcreateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentUpdateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentupdateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentDeleteForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentDuplicateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentduplicateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentDistributeForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdistributeforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentRedistributeForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentredistributeforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdownloadforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentCreateDocumentTemporaryForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentcreatedocumenttemporaryforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadBetaForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdownloadbetaforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateFindTemplatesForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatefindtemplatesforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateGetTemplateByIDForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templategettemplatebyidforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateUpdateTemplateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateupdatetemplateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateDuplicateTemplateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templateduplicatetemplateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateCreateDocumentFromTemplateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatedocumentfromtemplateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FolderFindFoldersForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderfindfoldersforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FolderCreateFolderForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/foldercreatefolderforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FolderUpdateFolderForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderupdatefolderforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FolderDeleteFolderForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderdeletefolderforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateTemporaryForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatetemporaryforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokenforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokenforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentFindForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentfindforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentCreateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentcreateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentUpdateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentupdateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentDeleteForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentdeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemCreateManyForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemcreatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemUpdateManyForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemupdatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDeleteForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemdeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDownloadForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemdownloadforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientGetForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientgetforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientCreateManyForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientcreatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientUpdateManyForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientupdatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientDeleteForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientdeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldGetForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldgetforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldCreateManyForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldcreatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldUpdateManyForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldupdatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldDeleteForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefielddeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentCreateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentcreateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentUpdateForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentupdateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentDeleteForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentdeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentFindForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentfindforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldGetDocumentFieldForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgetdocumentfieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldsForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatedocumentfieldsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldsForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatedocumentfieldsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldDeleteDocumentFieldForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletedocumentfieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientGetDocumentRecipientForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgetdocumentrecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientsForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatedocumentrecipientsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientsForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatedocumentrecipientsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteDocumentRecipientForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletedocumentrecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldGetTemplateFieldForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldgettemplatefieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldsForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldcreatetemplatefieldsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldsForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fieldupdatetemplatefieldsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldDeleteTemplateFieldForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/fielddeletetemplatefieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientGetTemplateRecipientForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientgettemplaterecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientsForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientcreatetemplaterecipientsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientsForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientupdatetemplaterecipientsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteTemplateRecipientForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/recipientdeletetemplaterecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateDirectLinkForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplatedirectlinkforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateDirectLinkForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatedeletetemplatedirectlinkforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateToggleTemplateDirectLinkForbiddenError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatetoggletemplatedirectlinkforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeGetNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopegetnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 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 80 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 80 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 80 methods.* +* [`DocumentDownloadBetaNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdownloadbetanotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 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 80 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 80 methods.* +* [`FolderFindFoldersNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderfindfoldersnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentFindNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentfindnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDownloadNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemdownloadnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientGetNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientgetnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldGetNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldgetnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentFindNotFoundError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentfindnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 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 80 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 80 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 80 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 80 methods.* +* [`EnvelopeGetInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopegetinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeCreateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopecreateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeUseInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeuseinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeUpdateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeupdateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeDeleteInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopedeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeDuplicateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeduplicateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeDistributeInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopedistributeinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeRedistributeInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperedistributeinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 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 80 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 80 methods.* +* [`DocumentCreateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentcreateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 methods.* +* [`DocumentDownloadBetaInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentdownloadbetainternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 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 80 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 80 methods.* +* [`TemplateCreateTemplateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/templatecreatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 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 80 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 80 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 80 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 80 methods.* +* [`FolderFindFoldersInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderfindfoldersinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FolderCreateFolderInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/foldercreatefolderinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FolderUpdateFolderInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderupdatefolderinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FolderDeleteFolderInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/folderdeletefolderinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 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 80 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 80 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 80 methods.* +* [`EnvelopeAttachmentFindInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentfindinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentCreateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentcreateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentUpdateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentupdateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentDeleteInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeattachmentdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemCreateManyInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemcreatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemUpdateManyInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemupdatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDeleteInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDownloadInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopeitemdownloadinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientGetInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientgetinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientCreateManyInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientcreatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientUpdateManyInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientupdatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientDeleteInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/enveloperecipientdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldGetInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldgetinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldCreateManyInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldcreatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldUpdateManyInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefieldupdatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldDeleteInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/envelopefielddeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentCreateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentcreateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentUpdateInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentupdateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentDeleteInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentFindInternalServerError`](https://github.com/documenso/sdk-python/blob/master/./src/documenso_sdk/models/documentattachmentfindinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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 80 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.
@@ -536,11 +873,11 @@ import os with Documenso( - server_url="https://app.documenso.com/api/v2-beta", + server_url="https://app.documenso.com/api/v2", api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92) + res = documenso.envelopes.get(envelope_id="") # Handle response print(res) diff --git a/README.md b/README.md index 15d171d..b607a3a 100644 --- a/README.md +++ b/README.md @@ -245,17 +245,29 @@ 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 +* [create](docs/sdks/documents/README.md#create) - Create document +* [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 +* [download](docs/sdks/documents/README.md#download) - Download document +* [create_v0](docs/sdks/documents/README.md#create_v0) - Create document + +#### [documents.attachments](docs/sdks/documentsattachments/README.md) + +* [create](docs/sdks/documentsattachments/README.md#create) - Create attachment +* [update](docs/sdks/documentsattachments/README.md#update) - Update attachment +* [delete](docs/sdks/documentsattachments/README.md#delete) - Delete attachment +* [find](docs/sdks/documentsattachments/README.md#find) - Find attachments #### [documents.fields](docs/sdks/documentsfields/README.md) @@ -280,10 +292,61 @@ 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 +### [envelopes](docs/sdks/envelopes/README.md) + +* [get](docs/sdks/envelopes/README.md#get) - Get envelope +* [create](docs/sdks/envelopes/README.md#create) - Create envelope +* [use](docs/sdks/envelopes/README.md#use) - Use envelope +* [update](docs/sdks/envelopes/README.md#update) - Update envelope +* [delete](docs/sdks/envelopes/README.md#delete) - Delete envelope +* [duplicate](docs/sdks/envelopes/README.md#duplicate) - Duplicate envelope +* [distribute](docs/sdks/envelopes/README.md#distribute) - Distribute envelope +* [redistribute](docs/sdks/envelopes/README.md#redistribute) - Redistribute envelope + +#### [envelopes.attachments](docs/sdks/envelopesattachments/README.md) + +* [find](docs/sdks/envelopesattachments/README.md#find) - Find attachments +* [create](docs/sdks/envelopesattachments/README.md#create) - Create attachment +* [update](docs/sdks/envelopesattachments/README.md#update) - Update attachment +* [delete](docs/sdks/envelopesattachments/README.md#delete) - Delete attachment + +#### [envelopes.fields](docs/sdks/envelopesfields/README.md) + +* [get](docs/sdks/envelopesfields/README.md#get) - Get envelope field +* [create_many](docs/sdks/envelopesfields/README.md#create_many) - Create envelope fields +* [update_many](docs/sdks/envelopesfields/README.md#update_many) - Update envelope fields +* [delete](docs/sdks/envelopesfields/README.md#delete) - Delete envelope field + +#### [envelopes.items](docs/sdks/items/README.md) + +* [create_many](docs/sdks/items/README.md#create_many) - Create envelope items +* [update_many](docs/sdks/items/README.md#update_many) - Update envelope items +* [delete](docs/sdks/items/README.md#delete) - Delete envelope item +* [download](docs/sdks/items/README.md#download) - Download an envelope item + +#### [envelopes.recipients](docs/sdks/envelopesrecipients/README.md) + +* [get](docs/sdks/envelopesrecipients/README.md#get) - Get envelope recipient +* [create_many](docs/sdks/envelopesrecipients/README.md#create_many) - Create envelope recipients +* [update_many](docs/sdks/envelopesrecipients/README.md#update_many) - Update envelope recipients +* [delete](docs/sdks/envelopesrecipients/README.md#delete) - Delete envelope recipient + +### [folders](docs/sdks/folders/README.md) + +* [find](docs/sdks/folders/README.md#find) - Find folders +* [create](docs/sdks/folders/README.md#create) - Create new folder +* [update](docs/sdks/folders/README.md#update) - Update folder +* [delete](docs/sdks/folders/README.md#delete) - Delete folder + +### [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 * [get](docs/sdks/templates/README.md#get) - Get template +* [create](docs/sdks/templates/README.md#create) - Create template * [update](docs/sdks/templates/README.md#update) - Update template * [duplicate](docs/sdks/templates/README.md#duplicate) - Duplicate template * [delete](docs/sdks/templates/README.md#delete) - Delete template @@ -316,6 +379,37 @@ if __name__ == "__main__":
+ +## File uploads + +Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request. + +> [!TIP] +> +> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files. +> + +```python +import documenso_sdk +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.create(payload={ + "title": "", + "type": documenso_sdk.EnvelopeCreateType.TEMPLATE, + }) + + # Handle response + print(res) + +``` + + ## Retries @@ -332,7 +426,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92, + res = documenso.envelopes.get(envelope_id="", RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False)) # Handle response @@ -352,7 +446,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92) + res = documenso.envelopes.get(envelope_id="") # Handle response print(res) @@ -387,7 +481,7 @@ with Documenso( res = None try: - res = documenso.documents.update(document_id=9701.92) + res = documenso.envelopes.get(envelope_id="") # Handle response print(res) @@ -402,17 +496,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.EnvelopeGetBadRequestError): 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.EnvelopeGetBadRequestIssue]] ``` ### 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 (342)
@@ -423,100 +517,343 @@ 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.* +* [`EnvelopeGetBadRequestError`](./src/documenso_sdk/models/envelopegetbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeCreateBadRequestError`](./src/documenso_sdk/models/envelopecreatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeUseBadRequestError`](./src/documenso_sdk/models/envelopeusebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeUpdateBadRequestError`](./src/documenso_sdk/models/envelopeupdatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeDeleteBadRequestError`](./src/documenso_sdk/models/envelopedeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeDuplicateBadRequestError`](./src/documenso_sdk/models/envelopeduplicatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeDistributeBadRequestError`](./src/documenso_sdk/models/envelopedistributebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeRedistributeBadRequestError`](./src/documenso_sdk/models/enveloperedistributebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentGetBadRequestError`](./src/documenso_sdk/models/documentgetbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentFindBadRequestError`](./src/documenso_sdk/models/documentfindbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentCreateBadRequestError`](./src/documenso_sdk/models/documentcreatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentUpdateBadRequestError`](./src/documenso_sdk/models/documentupdatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentDeleteBadRequestError`](./src/documenso_sdk/models/documentdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentDuplicateBadRequestError`](./src/documenso_sdk/models/documentduplicatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentDistributeBadRequestError`](./src/documenso_sdk/models/documentdistributebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentRedistributeBadRequestError`](./src/documenso_sdk/models/documentredistributebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadBadRequestError`](./src/documenso_sdk/models/documentdownloadbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentCreateDocumentTemporaryBadRequestError`](./src/documenso_sdk/models/documentcreatedocumenttemporarybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadBetaBadRequestError`](./src/documenso_sdk/models/documentdownloadbetabadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateFindTemplatesBadRequestError`](./src/documenso_sdk/models/templatefindtemplatesbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateGetTemplateByIDBadRequestError`](./src/documenso_sdk/models/templategettemplatebyidbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateBadRequestError`](./src/documenso_sdk/models/templatecreatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateUpdateTemplateBadRequestError`](./src/documenso_sdk/models/templateupdatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateDuplicateTemplateBadRequestError`](./src/documenso_sdk/models/templateduplicatetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateBadRequestError`](./src/documenso_sdk/models/templatedeletetemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateCreateDocumentFromTemplateBadRequestError`](./src/documenso_sdk/models/templatecreatedocumentfromtemplatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FolderFindFoldersBadRequestError`](./src/documenso_sdk/models/folderfindfoldersbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FolderCreateFolderBadRequestError`](./src/documenso_sdk/models/foldercreatefolderbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FolderUpdateFolderBadRequestError`](./src/documenso_sdk/models/folderupdatefolderbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FolderDeleteFolderBadRequestError`](./src/documenso_sdk/models/folderdeletefolderbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateTemporaryBadRequestError`](./src/documenso_sdk/models/templatecreatetemplatetemporarybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError`](./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokenbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError`](./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokenbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentFindBadRequestError`](./src/documenso_sdk/models/envelopeattachmentfindbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentCreateBadRequestError`](./src/documenso_sdk/models/envelopeattachmentcreatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentUpdateBadRequestError`](./src/documenso_sdk/models/envelopeattachmentupdatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentDeleteBadRequestError`](./src/documenso_sdk/models/envelopeattachmentdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemCreateManyBadRequestError`](./src/documenso_sdk/models/envelopeitemcreatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemUpdateManyBadRequestError`](./src/documenso_sdk/models/envelopeitemupdatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDeleteBadRequestError`](./src/documenso_sdk/models/envelopeitemdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDownloadBadRequestError`](./src/documenso_sdk/models/envelopeitemdownloadbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientGetBadRequestError`](./src/documenso_sdk/models/enveloperecipientgetbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientCreateManyBadRequestError`](./src/documenso_sdk/models/enveloperecipientcreatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientUpdateManyBadRequestError`](./src/documenso_sdk/models/enveloperecipientupdatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientDeleteBadRequestError`](./src/documenso_sdk/models/enveloperecipientdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldGetBadRequestError`](./src/documenso_sdk/models/envelopefieldgetbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldCreateManyBadRequestError`](./src/documenso_sdk/models/envelopefieldcreatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldUpdateManyBadRequestError`](./src/documenso_sdk/models/envelopefieldupdatemanybadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldDeleteBadRequestError`](./src/documenso_sdk/models/envelopefielddeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentCreateBadRequestError`](./src/documenso_sdk/models/documentattachmentcreatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentUpdateBadRequestError`](./src/documenso_sdk/models/documentattachmentupdatebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentDeleteBadRequestError`](./src/documenso_sdk/models/documentattachmentdeletebadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentFindBadRequestError`](./src/documenso_sdk/models/documentattachmentfindbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldGetDocumentFieldBadRequestError`](./src/documenso_sdk/models/fieldgetdocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldBadRequestError`](./src/documenso_sdk/models/fieldcreatedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldsBadRequestError`](./src/documenso_sdk/models/fieldcreatedocumentfieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldBadRequestError`](./src/documenso_sdk/models/fieldupdatedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldsBadRequestError`](./src/documenso_sdk/models/fieldupdatedocumentfieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldDeleteDocumentFieldBadRequestError`](./src/documenso_sdk/models/fielddeletedocumentfieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientGetDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientgetdocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientsBadRequestError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientsBadRequestError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteDocumentRecipientBadRequestError`](./src/documenso_sdk/models/recipientdeletedocumentrecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldBadRequestError`](./src/documenso_sdk/models/fieldcreatetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldGetTemplateFieldBadRequestError`](./src/documenso_sdk/models/fieldgettemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldsBadRequestError`](./src/documenso_sdk/models/fieldcreatetemplatefieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldBadRequestError`](./src/documenso_sdk/models/fieldupdatetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldsBadRequestError`](./src/documenso_sdk/models/fieldupdatetemplatefieldsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`FieldDeleteTemplateFieldBadRequestError`](./src/documenso_sdk/models/fielddeletetemplatefieldbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientGetTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientgettemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientsBadRequestError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientsBadRequestError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientsbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteTemplateRecipientBadRequestError`](./src/documenso_sdk/models/recipientdeletetemplaterecipientbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateDirectLinkBadRequestError`](./src/documenso_sdk/models/templatecreatetemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateDirectLinkBadRequestError`](./src/documenso_sdk/models/templatedeletetemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`TemplateToggleTemplateDirectLinkBadRequestError`](./src/documenso_sdk/models/templatetoggletemplatedirectlinkbadrequesterror.py): Invalid input data. Status code `400`. Applicable to 1 of 80 methods.* +* [`EnvelopeGetUnauthorizedError`](./src/documenso_sdk/models/envelopegetunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeCreateUnauthorizedError`](./src/documenso_sdk/models/envelopecreateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeUseUnauthorizedError`](./src/documenso_sdk/models/envelopeuseunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeUpdateUnauthorizedError`](./src/documenso_sdk/models/envelopeupdateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeDeleteUnauthorizedError`](./src/documenso_sdk/models/envelopedeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeDuplicateUnauthorizedError`](./src/documenso_sdk/models/envelopeduplicateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeDistributeUnauthorizedError`](./src/documenso_sdk/models/envelopedistributeunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeRedistributeUnauthorizedError`](./src/documenso_sdk/models/enveloperedistributeunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentGetUnauthorizedError`](./src/documenso_sdk/models/documentgetunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentFindUnauthorizedError`](./src/documenso_sdk/models/documentfindunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentCreateUnauthorizedError`](./src/documenso_sdk/models/documentcreateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentUpdateUnauthorizedError`](./src/documenso_sdk/models/documentupdateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentDeleteUnauthorizedError`](./src/documenso_sdk/models/documentdeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentDuplicateUnauthorizedError`](./src/documenso_sdk/models/documentduplicateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentDistributeUnauthorizedError`](./src/documenso_sdk/models/documentdistributeunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentRedistributeUnauthorizedError`](./src/documenso_sdk/models/documentredistributeunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadUnauthorizedError`](./src/documenso_sdk/models/documentdownloadunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentCreateDocumentTemporaryUnauthorizedError`](./src/documenso_sdk/models/documentcreatedocumenttemporaryunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadBetaUnauthorizedError`](./src/documenso_sdk/models/documentdownloadbetaunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateFindTemplatesUnauthorizedError`](./src/documenso_sdk/models/templatefindtemplatesunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateGetTemplateByIDUnauthorizedError`](./src/documenso_sdk/models/templategettemplatebyidunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateUnauthorizedError`](./src/documenso_sdk/models/templatecreatetemplateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateUpdateTemplateUnauthorizedError`](./src/documenso_sdk/models/templateupdatetemplateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateDuplicateTemplateUnauthorizedError`](./src/documenso_sdk/models/templateduplicatetemplateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateUnauthorizedError`](./src/documenso_sdk/models/templatedeletetemplateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateCreateDocumentFromTemplateUnauthorizedError`](./src/documenso_sdk/models/templatecreatedocumentfromtemplateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FolderFindFoldersUnauthorizedError`](./src/documenso_sdk/models/folderfindfoldersunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FolderCreateFolderUnauthorizedError`](./src/documenso_sdk/models/foldercreatefolderunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FolderUpdateFolderUnauthorizedError`](./src/documenso_sdk/models/folderupdatefolderunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FolderDeleteFolderUnauthorizedError`](./src/documenso_sdk/models/folderdeletefolderunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateTemporaryUnauthorizedError`](./src/documenso_sdk/models/templatecreatetemplatetemporaryunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError`](./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokenunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError`](./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokenunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentFindUnauthorizedError`](./src/documenso_sdk/models/envelopeattachmentfindunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentCreateUnauthorizedError`](./src/documenso_sdk/models/envelopeattachmentcreateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentUpdateUnauthorizedError`](./src/documenso_sdk/models/envelopeattachmentupdateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentDeleteUnauthorizedError`](./src/documenso_sdk/models/envelopeattachmentdeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemCreateManyUnauthorizedError`](./src/documenso_sdk/models/envelopeitemcreatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemUpdateManyUnauthorizedError`](./src/documenso_sdk/models/envelopeitemupdatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDeleteUnauthorizedError`](./src/documenso_sdk/models/envelopeitemdeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDownloadUnauthorizedError`](./src/documenso_sdk/models/envelopeitemdownloadunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientGetUnauthorizedError`](./src/documenso_sdk/models/enveloperecipientgetunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientCreateManyUnauthorizedError`](./src/documenso_sdk/models/enveloperecipientcreatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientUpdateManyUnauthorizedError`](./src/documenso_sdk/models/enveloperecipientupdatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientDeleteUnauthorizedError`](./src/documenso_sdk/models/enveloperecipientdeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldGetUnauthorizedError`](./src/documenso_sdk/models/envelopefieldgetunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldCreateManyUnauthorizedError`](./src/documenso_sdk/models/envelopefieldcreatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldUpdateManyUnauthorizedError`](./src/documenso_sdk/models/envelopefieldupdatemanyunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldDeleteUnauthorizedError`](./src/documenso_sdk/models/envelopefielddeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentCreateUnauthorizedError`](./src/documenso_sdk/models/documentattachmentcreateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentUpdateUnauthorizedError`](./src/documenso_sdk/models/documentattachmentupdateunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentDeleteUnauthorizedError`](./src/documenso_sdk/models/documentattachmentdeleteunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentFindUnauthorizedError`](./src/documenso_sdk/models/documentattachmentfindunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldGetDocumentFieldUnauthorizedError`](./src/documenso_sdk/models/fieldgetdocumentfieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldUnauthorizedError`](./src/documenso_sdk/models/fieldcreatedocumentfieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldsUnauthorizedError`](./src/documenso_sdk/models/fieldcreatedocumentfieldsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldUnauthorizedError`](./src/documenso_sdk/models/fieldupdatedocumentfieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldsUnauthorizedError`](./src/documenso_sdk/models/fieldupdatedocumentfieldsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldDeleteDocumentFieldUnauthorizedError`](./src/documenso_sdk/models/fielddeletedocumentfieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientGetDocumentRecipientUnauthorizedError`](./src/documenso_sdk/models/recipientgetdocumentrecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientUnauthorizedError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientsUnauthorizedError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientUnauthorizedError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientsUnauthorizedError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteDocumentRecipientUnauthorizedError`](./src/documenso_sdk/models/recipientdeletedocumentrecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldUnauthorizedError`](./src/documenso_sdk/models/fieldcreatetemplatefieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldGetTemplateFieldUnauthorizedError`](./src/documenso_sdk/models/fieldgettemplatefieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldsUnauthorizedError`](./src/documenso_sdk/models/fieldcreatetemplatefieldsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldUnauthorizedError`](./src/documenso_sdk/models/fieldupdatetemplatefieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldsUnauthorizedError`](./src/documenso_sdk/models/fieldupdatetemplatefieldsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`FieldDeleteTemplateFieldUnauthorizedError`](./src/documenso_sdk/models/fielddeletetemplatefieldunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientGetTemplateRecipientUnauthorizedError`](./src/documenso_sdk/models/recipientgettemplaterecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientUnauthorizedError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientsUnauthorizedError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientUnauthorizedError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientsUnauthorizedError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientsunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteTemplateRecipientUnauthorizedError`](./src/documenso_sdk/models/recipientdeletetemplaterecipientunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateDirectLinkUnauthorizedError`](./src/documenso_sdk/models/templatecreatetemplatedirectlinkunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateDirectLinkUnauthorizedError`](./src/documenso_sdk/models/templatedeletetemplatedirectlinkunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`TemplateToggleTemplateDirectLinkUnauthorizedError`](./src/documenso_sdk/models/templatetoggletemplatedirectlinkunauthorizederror.py): Authorization not provided. Status code `401`. Applicable to 1 of 80 methods.* +* [`EnvelopeGetForbiddenError`](./src/documenso_sdk/models/envelopegetforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeCreateForbiddenError`](./src/documenso_sdk/models/envelopecreateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeUseForbiddenError`](./src/documenso_sdk/models/envelopeuseforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeUpdateForbiddenError`](./src/documenso_sdk/models/envelopeupdateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeDeleteForbiddenError`](./src/documenso_sdk/models/envelopedeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeDuplicateForbiddenError`](./src/documenso_sdk/models/envelopeduplicateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeDistributeForbiddenError`](./src/documenso_sdk/models/envelopedistributeforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeRedistributeForbiddenError`](./src/documenso_sdk/models/enveloperedistributeforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentGetForbiddenError`](./src/documenso_sdk/models/documentgetforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentFindForbiddenError`](./src/documenso_sdk/models/documentfindforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentCreateForbiddenError`](./src/documenso_sdk/models/documentcreateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentUpdateForbiddenError`](./src/documenso_sdk/models/documentupdateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentDeleteForbiddenError`](./src/documenso_sdk/models/documentdeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentDuplicateForbiddenError`](./src/documenso_sdk/models/documentduplicateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentDistributeForbiddenError`](./src/documenso_sdk/models/documentdistributeforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentRedistributeForbiddenError`](./src/documenso_sdk/models/documentredistributeforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadForbiddenError`](./src/documenso_sdk/models/documentdownloadforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentCreateDocumentTemporaryForbiddenError`](./src/documenso_sdk/models/documentcreatedocumenttemporaryforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadBetaForbiddenError`](./src/documenso_sdk/models/documentdownloadbetaforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateFindTemplatesForbiddenError`](./src/documenso_sdk/models/templatefindtemplatesforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateGetTemplateByIDForbiddenError`](./src/documenso_sdk/models/templategettemplatebyidforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateForbiddenError`](./src/documenso_sdk/models/templatecreatetemplateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateUpdateTemplateForbiddenError`](./src/documenso_sdk/models/templateupdatetemplateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateDuplicateTemplateForbiddenError`](./src/documenso_sdk/models/templateduplicatetemplateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateForbiddenError`](./src/documenso_sdk/models/templatedeletetemplateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateCreateDocumentFromTemplateForbiddenError`](./src/documenso_sdk/models/templatecreatedocumentfromtemplateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FolderFindFoldersForbiddenError`](./src/documenso_sdk/models/folderfindfoldersforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FolderCreateFolderForbiddenError`](./src/documenso_sdk/models/foldercreatefolderforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FolderUpdateFolderForbiddenError`](./src/documenso_sdk/models/folderupdatefolderforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FolderDeleteFolderForbiddenError`](./src/documenso_sdk/models/folderdeletefolderforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateTemporaryForbiddenError`](./src/documenso_sdk/models/templatecreatetemplatetemporaryforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError`](./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokenforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError`](./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokenforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentFindForbiddenError`](./src/documenso_sdk/models/envelopeattachmentfindforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentCreateForbiddenError`](./src/documenso_sdk/models/envelopeattachmentcreateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentUpdateForbiddenError`](./src/documenso_sdk/models/envelopeattachmentupdateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentDeleteForbiddenError`](./src/documenso_sdk/models/envelopeattachmentdeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemCreateManyForbiddenError`](./src/documenso_sdk/models/envelopeitemcreatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemUpdateManyForbiddenError`](./src/documenso_sdk/models/envelopeitemupdatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDeleteForbiddenError`](./src/documenso_sdk/models/envelopeitemdeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDownloadForbiddenError`](./src/documenso_sdk/models/envelopeitemdownloadforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientGetForbiddenError`](./src/documenso_sdk/models/enveloperecipientgetforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientCreateManyForbiddenError`](./src/documenso_sdk/models/enveloperecipientcreatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientUpdateManyForbiddenError`](./src/documenso_sdk/models/enveloperecipientupdatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientDeleteForbiddenError`](./src/documenso_sdk/models/enveloperecipientdeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldGetForbiddenError`](./src/documenso_sdk/models/envelopefieldgetforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldCreateManyForbiddenError`](./src/documenso_sdk/models/envelopefieldcreatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldUpdateManyForbiddenError`](./src/documenso_sdk/models/envelopefieldupdatemanyforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldDeleteForbiddenError`](./src/documenso_sdk/models/envelopefielddeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentCreateForbiddenError`](./src/documenso_sdk/models/documentattachmentcreateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentUpdateForbiddenError`](./src/documenso_sdk/models/documentattachmentupdateforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentDeleteForbiddenError`](./src/documenso_sdk/models/documentattachmentdeleteforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentFindForbiddenError`](./src/documenso_sdk/models/documentattachmentfindforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldGetDocumentFieldForbiddenError`](./src/documenso_sdk/models/fieldgetdocumentfieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldForbiddenError`](./src/documenso_sdk/models/fieldcreatedocumentfieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldsForbiddenError`](./src/documenso_sdk/models/fieldcreatedocumentfieldsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldForbiddenError`](./src/documenso_sdk/models/fieldupdatedocumentfieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldsForbiddenError`](./src/documenso_sdk/models/fieldupdatedocumentfieldsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldDeleteDocumentFieldForbiddenError`](./src/documenso_sdk/models/fielddeletedocumentfieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientGetDocumentRecipientForbiddenError`](./src/documenso_sdk/models/recipientgetdocumentrecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientForbiddenError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientsForbiddenError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientForbiddenError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientsForbiddenError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteDocumentRecipientForbiddenError`](./src/documenso_sdk/models/recipientdeletedocumentrecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldForbiddenError`](./src/documenso_sdk/models/fieldcreatetemplatefieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldGetTemplateFieldForbiddenError`](./src/documenso_sdk/models/fieldgettemplatefieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldsForbiddenError`](./src/documenso_sdk/models/fieldcreatetemplatefieldsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldForbiddenError`](./src/documenso_sdk/models/fieldupdatetemplatefieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldsForbiddenError`](./src/documenso_sdk/models/fieldupdatetemplatefieldsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`FieldDeleteTemplateFieldForbiddenError`](./src/documenso_sdk/models/fielddeletetemplatefieldforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientGetTemplateRecipientForbiddenError`](./src/documenso_sdk/models/recipientgettemplaterecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientForbiddenError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientsForbiddenError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientForbiddenError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientsForbiddenError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientsforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteTemplateRecipientForbiddenError`](./src/documenso_sdk/models/recipientdeletetemplaterecipientforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateDirectLinkForbiddenError`](./src/documenso_sdk/models/templatecreatetemplatedirectlinkforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateDirectLinkForbiddenError`](./src/documenso_sdk/models/templatedeletetemplatedirectlinkforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`TemplateToggleTemplateDirectLinkForbiddenError`](./src/documenso_sdk/models/templatetoggletemplatedirectlinkforbiddenerror.py): Insufficient access. Status code `403`. Applicable to 1 of 80 methods.* +* [`EnvelopeGetNotFoundError`](./src/documenso_sdk/models/envelopegetnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`DocumentGetNotFoundError`](./src/documenso_sdk/models/documentgetnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`DocumentFindNotFoundError`](./src/documenso_sdk/models/documentfindnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadNotFoundError`](./src/documenso_sdk/models/documentdownloadnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadBetaNotFoundError`](./src/documenso_sdk/models/documentdownloadbetanotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`TemplateFindTemplatesNotFoundError`](./src/documenso_sdk/models/templatefindtemplatesnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`TemplateGetTemplateByIDNotFoundError`](./src/documenso_sdk/models/templategettemplatebyidnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`FolderFindFoldersNotFoundError`](./src/documenso_sdk/models/folderfindfoldersnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentFindNotFoundError`](./src/documenso_sdk/models/envelopeattachmentfindnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDownloadNotFoundError`](./src/documenso_sdk/models/envelopeitemdownloadnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientGetNotFoundError`](./src/documenso_sdk/models/enveloperecipientgetnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldGetNotFoundError`](./src/documenso_sdk/models/envelopefieldgetnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentFindNotFoundError`](./src/documenso_sdk/models/documentattachmentfindnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`FieldGetDocumentFieldNotFoundError`](./src/documenso_sdk/models/fieldgetdocumentfieldnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`RecipientGetDocumentRecipientNotFoundError`](./src/documenso_sdk/models/recipientgetdocumentrecipientnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`FieldGetTemplateFieldNotFoundError`](./src/documenso_sdk/models/fieldgettemplatefieldnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`RecipientGetTemplateRecipientNotFoundError`](./src/documenso_sdk/models/recipientgettemplaterecipientnotfounderror.py): Not found. Status code `404`. Applicable to 1 of 80 methods.* +* [`EnvelopeGetInternalServerError`](./src/documenso_sdk/models/envelopegetinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeCreateInternalServerError`](./src/documenso_sdk/models/envelopecreateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeUseInternalServerError`](./src/documenso_sdk/models/envelopeuseinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeUpdateInternalServerError`](./src/documenso_sdk/models/envelopeupdateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeDeleteInternalServerError`](./src/documenso_sdk/models/envelopedeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeDuplicateInternalServerError`](./src/documenso_sdk/models/envelopeduplicateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeDistributeInternalServerError`](./src/documenso_sdk/models/envelopedistributeinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeRedistributeInternalServerError`](./src/documenso_sdk/models/enveloperedistributeinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentGetInternalServerError`](./src/documenso_sdk/models/documentgetinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentFindInternalServerError`](./src/documenso_sdk/models/documentfindinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentCreateInternalServerError`](./src/documenso_sdk/models/documentcreateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentUpdateInternalServerError`](./src/documenso_sdk/models/documentupdateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentDeleteInternalServerError`](./src/documenso_sdk/models/documentdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentDuplicateInternalServerError`](./src/documenso_sdk/models/documentduplicateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentDistributeInternalServerError`](./src/documenso_sdk/models/documentdistributeinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentRedistributeInternalServerError`](./src/documenso_sdk/models/documentredistributeinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadInternalServerError`](./src/documenso_sdk/models/documentdownloadinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentCreateDocumentTemporaryInternalServerError`](./src/documenso_sdk/models/documentcreatedocumenttemporaryinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentDownloadBetaInternalServerError`](./src/documenso_sdk/models/documentdownloadbetainternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateFindTemplatesInternalServerError`](./src/documenso_sdk/models/templatefindtemplatesinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateGetTemplateByIDInternalServerError`](./src/documenso_sdk/models/templategettemplatebyidinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateInternalServerError`](./src/documenso_sdk/models/templatecreatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateUpdateTemplateInternalServerError`](./src/documenso_sdk/models/templateupdatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateDuplicateTemplateInternalServerError`](./src/documenso_sdk/models/templateduplicatetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateInternalServerError`](./src/documenso_sdk/models/templatedeletetemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateCreateDocumentFromTemplateInternalServerError`](./src/documenso_sdk/models/templatecreatedocumentfromtemplateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FolderFindFoldersInternalServerError`](./src/documenso_sdk/models/folderfindfoldersinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FolderCreateFolderInternalServerError`](./src/documenso_sdk/models/foldercreatefolderinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FolderUpdateFolderInternalServerError`](./src/documenso_sdk/models/folderupdatefolderinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FolderDeleteFolderInternalServerError`](./src/documenso_sdk/models/folderdeletefolderinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateTemporaryInternalServerError`](./src/documenso_sdk/models/templatecreatetemplatetemporaryinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError`](./src/documenso_sdk/models/embeddingpresigncreateembeddingpresigntokeninternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError`](./src/documenso_sdk/models/embeddingpresignverifyembeddingpresigntokeninternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentFindInternalServerError`](./src/documenso_sdk/models/envelopeattachmentfindinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentCreateInternalServerError`](./src/documenso_sdk/models/envelopeattachmentcreateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentUpdateInternalServerError`](./src/documenso_sdk/models/envelopeattachmentupdateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeAttachmentDeleteInternalServerError`](./src/documenso_sdk/models/envelopeattachmentdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemCreateManyInternalServerError`](./src/documenso_sdk/models/envelopeitemcreatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemUpdateManyInternalServerError`](./src/documenso_sdk/models/envelopeitemupdatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDeleteInternalServerError`](./src/documenso_sdk/models/envelopeitemdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeItemDownloadInternalServerError`](./src/documenso_sdk/models/envelopeitemdownloadinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientGetInternalServerError`](./src/documenso_sdk/models/enveloperecipientgetinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientCreateManyInternalServerError`](./src/documenso_sdk/models/enveloperecipientcreatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientUpdateManyInternalServerError`](./src/documenso_sdk/models/enveloperecipientupdatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeRecipientDeleteInternalServerError`](./src/documenso_sdk/models/enveloperecipientdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldGetInternalServerError`](./src/documenso_sdk/models/envelopefieldgetinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldCreateManyInternalServerError`](./src/documenso_sdk/models/envelopefieldcreatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldUpdateManyInternalServerError`](./src/documenso_sdk/models/envelopefieldupdatemanyinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`EnvelopeFieldDeleteInternalServerError`](./src/documenso_sdk/models/envelopefielddeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentCreateInternalServerError`](./src/documenso_sdk/models/documentattachmentcreateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentUpdateInternalServerError`](./src/documenso_sdk/models/documentattachmentupdateinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentDeleteInternalServerError`](./src/documenso_sdk/models/documentattachmentdeleteinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`DocumentAttachmentFindInternalServerError`](./src/documenso_sdk/models/documentattachmentfindinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldGetDocumentFieldInternalServerError`](./src/documenso_sdk/models/fieldgetdocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldInternalServerError`](./src/documenso_sdk/models/fieldcreatedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldCreateDocumentFieldsInternalServerError`](./src/documenso_sdk/models/fieldcreatedocumentfieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldInternalServerError`](./src/documenso_sdk/models/fieldupdatedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldUpdateDocumentFieldsInternalServerError`](./src/documenso_sdk/models/fieldupdatedocumentfieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldDeleteDocumentFieldInternalServerError`](./src/documenso_sdk/models/fielddeletedocumentfieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientGetDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientgetdocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientCreateDocumentRecipientsInternalServerError`](./src/documenso_sdk/models/recipientcreatedocumentrecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateDocumentRecipientsInternalServerError`](./src/documenso_sdk/models/recipientupdatedocumentrecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteDocumentRecipientInternalServerError`](./src/documenso_sdk/models/recipientdeletedocumentrecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldInternalServerError`](./src/documenso_sdk/models/fieldcreatetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldGetTemplateFieldInternalServerError`](./src/documenso_sdk/models/fieldgettemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldCreateTemplateFieldsInternalServerError`](./src/documenso_sdk/models/fieldcreatetemplatefieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldInternalServerError`](./src/documenso_sdk/models/fieldupdatetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldUpdateTemplateFieldsInternalServerError`](./src/documenso_sdk/models/fieldupdatetemplatefieldsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`FieldDeleteTemplateFieldInternalServerError`](./src/documenso_sdk/models/fielddeletetemplatefieldinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientGetTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientgettemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientCreateTemplateRecipientsInternalServerError`](./src/documenso_sdk/models/recipientcreatetemplaterecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientUpdateTemplateRecipientsInternalServerError`](./src/documenso_sdk/models/recipientupdatetemplaterecipientsinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`RecipientDeleteTemplateRecipientInternalServerError`](./src/documenso_sdk/models/recipientdeletetemplaterecipientinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateCreateTemplateDirectLinkInternalServerError`](./src/documenso_sdk/models/templatecreatetemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateDeleteTemplateDirectLinkInternalServerError`](./src/documenso_sdk/models/templatedeletetemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 methods.* +* [`TemplateToggleTemplateDirectLinkInternalServerError`](./src/documenso_sdk/models/templatetoggletemplatedirectlinkinternalservererror.py): Internal server error. Status code `500`. Applicable to 1 of 80 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.
@@ -536,11 +873,11 @@ import os with Documenso( - server_url="https://app.documenso.com/api/v2-beta", + server_url="https://app.documenso.com/api/v2", api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.update(document_id=9701.92) + res = documenso.envelopes.get(envelope_id="") # Handle response print(res) diff --git a/RELEASES.md b/RELEASES.md index c5023aa..bdb76a0 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-12 08:54:36 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.654.0 (2.750.0) 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..993df1a 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.envelopes.get(envelope_id="") # 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.envelopes.get_async(envelope_id="") # Handle response print(res) 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..8775d2e 100644 --- a/docs/models/documentaccessauth.md +++ b/docs/models/documentaccessauth.md @@ -1,10 +1,9 @@ # DocumentAccessAuth -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/documentactionauth.md b/docs/models/documentactionauth.md index 43d9cf2..247788d 100644 --- a/docs/models/documentactionauth.md +++ b/docs/models/documentactionauth.md @@ -1,7 +1,5 @@ # DocumentActionAuth -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/documentattachmentcreatebadrequesterror.md b/docs/models/documentattachmentcreatebadrequesterror.md new file mode 100644 index 0000000..2260e90 --- /dev/null +++ b/docs/models/documentattachmentcreatebadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentCreateBadRequestError + +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.DocumentAttachmentCreateBadRequestIssue](../models/documentattachmentcreatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentcreatebadrequestissue.md b/docs/models/documentattachmentcreatebadrequestissue.md new file mode 100644 index 0000000..7f93e02 --- /dev/null +++ b/docs/models/documentattachmentcreatebadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentCreateBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentcreatedata.md b/docs/models/documentattachmentcreatedata.md new file mode 100644 index 0000000..20e54fc --- /dev/null +++ b/docs/models/documentattachmentcreatedata.md @@ -0,0 +1,9 @@ +# DocumentAttachmentCreateData + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentcreateforbiddenerror.md b/docs/models/documentattachmentcreateforbiddenerror.md new file mode 100644 index 0000000..488893a --- /dev/null +++ b/docs/models/documentattachmentcreateforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentCreateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentAttachmentCreateForbiddenIssue](../models/documentattachmentcreateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentcreateforbiddenissue.md b/docs/models/documentattachmentcreateforbiddenissue.md new file mode 100644 index 0000000..9df606a --- /dev/null +++ b/docs/models/documentattachmentcreateforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentCreateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentcreateinternalservererror.md b/docs/models/documentattachmentcreateinternalservererror.md new file mode 100644 index 0000000..693e617 --- /dev/null +++ b/docs/models/documentattachmentcreateinternalservererror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentCreateInternalServerError + +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.DocumentAttachmentCreateInternalServerErrorIssue](../models/documentattachmentcreateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentcreateinternalservererrorissue.md b/docs/models/documentattachmentcreateinternalservererrorissue.md new file mode 100644 index 0000000..73e411f --- /dev/null +++ b/docs/models/documentattachmentcreateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentCreateInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentcreaterequest.md b/docs/models/documentattachmentcreaterequest.md new file mode 100644 index 0000000..2e1dc17 --- /dev/null +++ b/docs/models/documentattachmentcreaterequest.md @@ -0,0 +1,9 @@ +# DocumentAttachmentCreateRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | N/A | +| `data` | [models.DocumentAttachmentCreateData](../models/documentattachmentcreatedata.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentcreateresponse.md b/docs/models/documentattachmentcreateresponse.md new file mode 100644 index 0000000..19e5b45 --- /dev/null +++ b/docs/models/documentattachmentcreateresponse.md @@ -0,0 +1,10 @@ +# DocumentAttachmentCreateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentcreateunauthorizederror.md b/docs/models/documentattachmentcreateunauthorizederror.md new file mode 100644 index 0000000..efa4f8a --- /dev/null +++ b/docs/models/documentattachmentcreateunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentCreateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentAttachmentCreateUnauthorizedIssue](../models/documentattachmentcreateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentcreateunauthorizedissue.md b/docs/models/documentattachmentcreateunauthorizedissue.md new file mode 100644 index 0000000..c8fbeae --- /dev/null +++ b/docs/models/documentattachmentcreateunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentCreateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentdeletebadrequesterror.md b/docs/models/documentattachmentdeletebadrequesterror.md new file mode 100644 index 0000000..71c49f0 --- /dev/null +++ b/docs/models/documentattachmentdeletebadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentDeleteBadRequestError + +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.DocumentAttachmentDeleteBadRequestIssue](../models/documentattachmentdeletebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentdeletebadrequestissue.md b/docs/models/documentattachmentdeletebadrequestissue.md new file mode 100644 index 0000000..17081aa --- /dev/null +++ b/docs/models/documentattachmentdeletebadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentDeleteBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentdeleteforbiddenerror.md b/docs/models/documentattachmentdeleteforbiddenerror.md new file mode 100644 index 0000000..0b3a3cf --- /dev/null +++ b/docs/models/documentattachmentdeleteforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentDeleteForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentAttachmentDeleteForbiddenIssue](../models/documentattachmentdeleteforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentdeleteforbiddenissue.md b/docs/models/documentattachmentdeleteforbiddenissue.md new file mode 100644 index 0000000..9790312 --- /dev/null +++ b/docs/models/documentattachmentdeleteforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentDeleteForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentdeleteinternalservererror.md b/docs/models/documentattachmentdeleteinternalservererror.md new file mode 100644 index 0000000..840f94f --- /dev/null +++ b/docs/models/documentattachmentdeleteinternalservererror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentDeleteInternalServerError + +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.DocumentAttachmentDeleteInternalServerErrorIssue](../models/documentattachmentdeleteinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentdeleteinternalservererrorissue.md b/docs/models/documentattachmentdeleteinternalservererrorissue.md new file mode 100644 index 0000000..8d3558b --- /dev/null +++ b/docs/models/documentattachmentdeleteinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentDeleteInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentdeleterequest.md b/docs/models/documentattachmentdeleterequest.md new file mode 100644 index 0000000..17ce675 --- /dev/null +++ b/docs/models/documentattachmentdeleterequest.md @@ -0,0 +1,8 @@ +# DocumentAttachmentDeleteRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentdeleteresponse.md b/docs/models/documentattachmentdeleteresponse.md new file mode 100644 index 0000000..ca5816a --- /dev/null +++ b/docs/models/documentattachmentdeleteresponse.md @@ -0,0 +1,10 @@ +# DocumentAttachmentDeleteResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentdeleteunauthorizederror.md b/docs/models/documentattachmentdeleteunauthorizederror.md new file mode 100644 index 0000000..2ef899d --- /dev/null +++ b/docs/models/documentattachmentdeleteunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentDeleteUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentAttachmentDeleteUnauthorizedIssue](../models/documentattachmentdeleteunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentdeleteunauthorizedissue.md b/docs/models/documentattachmentdeleteunauthorizedissue.md new file mode 100644 index 0000000..2fbb5f2 --- /dev/null +++ b/docs/models/documentattachmentdeleteunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentDeleteUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdeletedocumentbadrequesterror.md b/docs/models/documentattachmentfindbadrequesterror.md similarity index 92% rename from docs/models/documentdeletedocumentbadrequesterror.md rename to docs/models/documentattachmentfindbadrequesterror.md index 17c750d..20f9ecd 100644 --- a/docs/models/documentdeletedocumentbadrequesterror.md +++ b/docs/models/documentattachmentfindbadrequesterror.md @@ -1,4 +1,4 @@ -# DocumentDeleteDocumentBadRequestError +# DocumentAttachmentFindBadRequestError 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.DocumentDeleteDocumentBadRequestIssue](../models/documentdeletedocumentbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.DocumentAttachmentFindBadRequestIssue](../models/documentattachmentfindbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdeletedocumentbadrequestissue.md b/docs/models/documentattachmentfindbadrequestissue.md similarity index 87% rename from docs/models/documentdeletedocumentbadrequestissue.md rename to docs/models/documentattachmentfindbadrequestissue.md index fab138d..890f6db 100644 --- a/docs/models/documentdeletedocumentbadrequestissue.md +++ b/docs/models/documentattachmentfindbadrequestissue.md @@ -1,4 +1,4 @@ -# DocumentDeleteDocumentBadRequestIssue +# DocumentAttachmentFindBadRequestIssue ## Fields diff --git a/docs/models/documentattachmentfinddata.md b/docs/models/documentattachmentfinddata.md new file mode 100644 index 0000000..41953bb --- /dev/null +++ b/docs/models/documentattachmentfinddata.md @@ -0,0 +1,11 @@ +# DocumentAttachmentFindData + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.DocumentAttachmentFindType](../models/documentattachmentfindtype.md) | :heavy_check_mark: | N/A | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentfindforbiddenerror.md b/docs/models/documentattachmentfindforbiddenerror.md new file mode 100644 index 0000000..3c1e10d --- /dev/null +++ b/docs/models/documentattachmentfindforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentFindForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentAttachmentFindForbiddenIssue](../models/documentattachmentfindforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsbadrequestissue.md b/docs/models/documentattachmentfindforbiddenissue.md similarity index 87% rename from docs/models/documentfinddocumentsbadrequestissue.md rename to docs/models/documentattachmentfindforbiddenissue.md index 599d929..6bac01e 100644 --- a/docs/models/documentfinddocumentsbadrequestissue.md +++ b/docs/models/documentattachmentfindforbiddenissue.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsBadRequestIssue +# DocumentAttachmentFindForbiddenIssue ## Fields diff --git a/docs/models/documentdeletedocumentinternalservererror.md b/docs/models/documentattachmentfindinternalservererror.md similarity index 93% rename from docs/models/documentdeletedocumentinternalservererror.md rename to docs/models/documentattachmentfindinternalservererror.md index 25d92d0..ce25658 100644 --- a/docs/models/documentdeletedocumentinternalservererror.md +++ b/docs/models/documentattachmentfindinternalservererror.md @@ -1,4 +1,4 @@ -# DocumentDeleteDocumentInternalServerError +# DocumentAttachmentFindInternalServerError 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.DocumentDeleteDocumentInternalServerErrorIssue](../models/documentdeletedocumentinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.DocumentAttachmentFindInternalServerErrorIssue](../models/documentattachmentfindinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdeletedocumentinternalservererrorissue.md b/docs/models/documentattachmentfindinternalservererrorissue.md similarity index 84% rename from docs/models/documentdeletedocumentinternalservererrorissue.md rename to docs/models/documentattachmentfindinternalservererrorissue.md index 5f72583..d43d4cd 100644 --- a/docs/models/documentdeletedocumentinternalservererrorissue.md +++ b/docs/models/documentattachmentfindinternalservererrorissue.md @@ -1,4 +1,4 @@ -# DocumentDeleteDocumentInternalServerErrorIssue +# DocumentAttachmentFindInternalServerErrorIssue ## Fields diff --git a/docs/models/documentattachmentfindnotfounderror.md b/docs/models/documentattachmentfindnotfounderror.md new file mode 100644 index 0000000..080b73d --- /dev/null +++ b/docs/models/documentattachmentfindnotfounderror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentFindNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentAttachmentFindNotFoundIssue](../models/documentattachmentfindnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentbadrequestissue.md b/docs/models/documentattachmentfindnotfoundissue.md similarity index 87% rename from docs/models/documentsenddocumentbadrequestissue.md rename to docs/models/documentattachmentfindnotfoundissue.md index d2033ac..69a67f9 100644 --- a/docs/models/documentsenddocumentbadrequestissue.md +++ b/docs/models/documentattachmentfindnotfoundissue.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentBadRequestIssue +# DocumentAttachmentFindNotFoundIssue ## Fields diff --git a/docs/models/documentdeletedocumentrequest.md b/docs/models/documentattachmentfindrequest.md similarity index 89% rename from docs/models/documentdeletedocumentrequest.md rename to docs/models/documentattachmentfindrequest.md index be5e608..b284734 100644 --- a/docs/models/documentdeletedocumentrequest.md +++ b/docs/models/documentattachmentfindrequest.md @@ -1,4 +1,4 @@ -# DocumentDeleteDocumentRequest +# DocumentAttachmentFindRequest ## Fields diff --git a/docs/models/documentattachmentfindresponse.md b/docs/models/documentattachmentfindresponse.md new file mode 100644 index 0000000..58d91bc --- /dev/null +++ b/docs/models/documentattachmentfindresponse.md @@ -0,0 +1,10 @@ +# DocumentAttachmentFindResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `data` | List[[models.DocumentAttachmentFindData](../models/documentattachmentfinddata.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentfindtype.md b/docs/models/documentattachmentfindtype.md new file mode 100644 index 0000000..f96b2c0 --- /dev/null +++ b/docs/models/documentattachmentfindtype.md @@ -0,0 +1,8 @@ +# DocumentAttachmentFindType + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/docs/models/documentattachmentfindunauthorizederror.md b/docs/models/documentattachmentfindunauthorizederror.md new file mode 100644 index 0000000..4d4a3cc --- /dev/null +++ b/docs/models/documentattachmentfindunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentFindUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentAttachmentFindUnauthorizedIssue](../models/documentattachmentfindunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentfindunauthorizedissue.md b/docs/models/documentattachmentfindunauthorizedissue.md new file mode 100644 index 0000000..90fdce2 --- /dev/null +++ b/docs/models/documentattachmentfindunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentFindUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdatebadrequesterror.md b/docs/models/documentattachmentupdatebadrequesterror.md new file mode 100644 index 0000000..14d8a55 --- /dev/null +++ b/docs/models/documentattachmentupdatebadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentUpdateBadRequestError + +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.DocumentAttachmentUpdateBadRequestIssue](../models/documentattachmentupdatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdatebadrequestissue.md b/docs/models/documentattachmentupdatebadrequestissue.md new file mode 100644 index 0000000..58be4eb --- /dev/null +++ b/docs/models/documentattachmentupdatebadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentUpdateBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdatedata.md b/docs/models/documentattachmentupdatedata.md new file mode 100644 index 0000000..05b7598 --- /dev/null +++ b/docs/models/documentattachmentupdatedata.md @@ -0,0 +1,9 @@ +# DocumentAttachmentUpdateData + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdateforbiddenerror.md b/docs/models/documentattachmentupdateforbiddenerror.md new file mode 100644 index 0000000..2284d78 --- /dev/null +++ b/docs/models/documentattachmentupdateforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentUpdateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentAttachmentUpdateForbiddenIssue](../models/documentattachmentupdateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdateforbiddenissue.md b/docs/models/documentattachmentupdateforbiddenissue.md new file mode 100644 index 0000000..213c8aa --- /dev/null +++ b/docs/models/documentattachmentupdateforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentUpdateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdateinternalservererror.md b/docs/models/documentattachmentupdateinternalservererror.md new file mode 100644 index 0000000..21a1029 --- /dev/null +++ b/docs/models/documentattachmentupdateinternalservererror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentUpdateInternalServerError + +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.DocumentAttachmentUpdateInternalServerErrorIssue](../models/documentattachmentupdateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdateinternalservererrorissue.md b/docs/models/documentattachmentupdateinternalservererrorissue.md new file mode 100644 index 0000000..1c6a808 --- /dev/null +++ b/docs/models/documentattachmentupdateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentUpdateInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdaterequest.md b/docs/models/documentattachmentupdaterequest.md new file mode 100644 index 0000000..3f73256 --- /dev/null +++ b/docs/models/documentattachmentupdaterequest.md @@ -0,0 +1,9 @@ +# DocumentAttachmentUpdateRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | N/A | +| `data` | [models.DocumentAttachmentUpdateData](../models/documentattachmentupdatedata.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdateresponse.md b/docs/models/documentattachmentupdateresponse.md new file mode 100644 index 0000000..2945dd7 --- /dev/null +++ b/docs/models/documentattachmentupdateresponse.md @@ -0,0 +1,10 @@ +# DocumentAttachmentUpdateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdateunauthorizederror.md b/docs/models/documentattachmentupdateunauthorizederror.md new file mode 100644 index 0000000..cc8fd20 --- /dev/null +++ b/docs/models/documentattachmentupdateunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentAttachmentUpdateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentAttachmentUpdateUnauthorizedIssue](../models/documentattachmentupdateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentattachmentupdateunauthorizedissue.md b/docs/models/documentattachmentupdateunauthorizedissue.md new file mode 100644 index 0000000..5907308 --- /dev/null +++ b/docs/models/documentattachmentupdateunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentAttachmentUpdateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreateaccessauth.md b/docs/models/documentcreateaccessauth.md new file mode 100644 index 0000000..1bf8221 --- /dev/null +++ b/docs/models/documentcreateaccessauth.md @@ -0,0 +1,9 @@ +# DocumentCreateAccessAuth + + +## 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/documentcreateactionauth.md similarity index 73% rename from docs/models/documentfinddocumentsactionauth.md rename to docs/models/documentcreateactionauth.md index 31a0c8f..581cb18 100644 --- a/docs/models/documentfinddocumentsactionauth.md +++ b/docs/models/documentcreateactionauth.md @@ -1,6 +1,4 @@ -# DocumentFindDocumentsActionAuth - -The type of authentication required for the recipient to sign the document. +# DocumentCreateActionAuth ## Values diff --git a/docs/models/documentcreateattachment.md b/docs/models/documentcreateattachment.md new file mode 100644 index 0000000..095ccac --- /dev/null +++ b/docs/models/documentcreateattachment.md @@ -0,0 +1,10 @@ +# DocumentCreateAttachment + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | +| `type` | [Optional[models.DocumentCreateTypeLink]](../models/documentcreatetypelink.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatebadrequesterror.md b/docs/models/documentcreatebadrequesterror.md new file mode 100644 index 0000000..cd229fb --- /dev/null +++ b/docs/models/documentcreatebadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentCreateBadRequestError + +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.DocumentCreateBadRequestIssue](../models/documentcreatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsnotfoundissue.md b/docs/models/documentcreatebadrequestissue.md similarity index 87% rename from docs/models/documentfinddocumentsnotfoundissue.md rename to docs/models/documentcreatebadrequestissue.md index b4b0ba3..8a95031 100644 --- a/docs/models/documentfinddocumentsnotfoundissue.md +++ b/docs/models/documentcreatebadrequestissue.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsNotFoundIssue +# DocumentCreateBadRequestIssue ## Fields diff --git a/docs/models/documentcreatedateformat.md b/docs/models/documentcreatedateformat.md new file mode 100644 index 0000000..df4e438 --- /dev/null +++ b/docs/models/documentcreatedateformat.md @@ -0,0 +1,29 @@ +# DocumentCreateDateFormat + + +## 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/documentcreatedirectioncheckbox.md b/docs/models/documentcreatedirectioncheckbox.md new file mode 100644 index 0000000..f9a6013 --- /dev/null +++ b/docs/models/documentcreatedirectioncheckbox.md @@ -0,0 +1,9 @@ +# DocumentCreateDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentcreatedirectionradio.md b/docs/models/documentcreatedirectionradio.md new file mode 100644 index 0000000..deff1b4 --- /dev/null +++ b/docs/models/documentcreatedirectionradio.md @@ -0,0 +1,9 @@ +# DocumentCreateDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyiddistributionmethod.md b/docs/models/documentcreatedistributionmethod.md similarity index 64% rename from docs/models/documentgetdocumentwithdetailsbyiddistributionmethod.md rename to docs/models/documentcreatedistributionmethod.md index 5b82747..0ad6ec0 100644 --- a/docs/models/documentgetdocumentwithdetailsbyiddistributionmethod.md +++ b/docs/models/documentcreatedistributionmethod.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDDistributionMethod +# DocumentCreateDistributionMethod ## Values diff --git a/docs/models/documentcreatedocumenttemporaryaccessauthrequest.md b/docs/models/documentcreatedocumenttemporaryaccessauthrequest.md index 214921d..4df82bd 100644 --- a/docs/models/documentcreatedocumenttemporaryaccessauthrequest.md +++ b/docs/models/documentcreatedocumenttemporaryaccessauthrequest.md @@ -1,10 +1,9 @@ # DocumentCreateDocumentTemporaryAccessAuthRequest -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/documentcreatedocumenttemporaryactionauthrequest.md b/docs/models/documentcreatedocumenttemporaryactionauthrequest.md index 57f7c51..f88d98b 100644 --- a/docs/models/documentcreatedocumenttemporaryactionauthrequest.md +++ b/docs/models/documentcreatedocumenttemporaryactionauthrequest.md @@ -1,7 +1,5 @@ # DocumentCreateDocumentTemporaryActionAuthRequest -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/documentcreatedocumenttemporaryattachment.md b/docs/models/documentcreatedocumenttemporaryattachment.md new file mode 100644 index 0000000..d77f5fd --- /dev/null +++ b/docs/models/documentcreatedocumenttemporaryattachment.md @@ -0,0 +1,10 @@ +# DocumentCreateDocumentTemporaryAttachment + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | +| `type` | [Optional[models.DocumentCreateDocumentTemporaryTypeLink]](../models/documentcreatedocumenttemporarytypelink.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarydateformat.md b/docs/models/documentcreatedocumenttemporarydateformat.md index 6290b39..db20410 100644 --- a/docs/models/documentcreatedocumenttemporarydateformat.md +++ b/docs/models/documentcreatedocumenttemporarydateformat.md @@ -1,19 +1,29 @@ # DocumentCreateDocumentTemporaryDateFormat -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/documentcreatedocumenttemporarydirectioncheckbox.md b/docs/models/documentcreatedocumenttemporarydirectioncheckbox.md new file mode 100644 index 0000000..ad99b7a --- /dev/null +++ b/docs/models/documentcreatedocumenttemporarydirectioncheckbox.md @@ -0,0 +1,9 @@ +# DocumentCreateDocumentTemporaryDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarydirectionradio.md b/docs/models/documentcreatedocumenttemporarydirectionradio.md new file mode 100644 index 0000000..f4f1f2c --- /dev/null +++ b/docs/models/documentcreatedocumenttemporarydirectionradio.md @@ -0,0 +1,9 @@ +# DocumentCreateDocumentTemporaryDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarydistributionmethodrequest.md b/docs/models/documentcreatedocumenttemporarydistributionmethodrequest.md deleted file mode 100644 index ab9afbc..0000000 --- a/docs/models/documentcreatedocumenttemporarydistributionmethodrequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# DocumentCreateDocumentTemporaryDistributionMethodRequest - -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/documentcreatedocumenttemporarydocument.md b/docs/models/documentcreatedocumenttemporarydocument.md new file mode 100644 index 0000000..eb624d2 --- /dev/null +++ b/docs/models/documentcreatedocumenttemporarydocument.md @@ -0,0 +1,32 @@ +# 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: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `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 | +| `internal_version` | *float* | :heavy_check_mark: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `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 | +| `envelope_items` | List[[models.DocumentCreateDocumentTemporaryEnvelopeItem](../models/documentcreatedocumenttemporaryenvelopeitem.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/documentcreatedocumenttemporaryemailsettingsrequest.md b/docs/models/documentcreatedocumenttemporaryemailsettingsrequest.md deleted file mode 100644 index 124ce56..0000000 --- a/docs/models/documentcreatedocumenttemporaryemailsettingsrequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# DocumentCreateDocumentTemporaryEmailSettingsRequest - - -## 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/documentcreatedocumenttemporaryenvelopeitem.md b/docs/models/documentcreatedocumenttemporaryenvelopeitem.md new file mode 100644 index 0000000..144b302 --- /dev/null +++ b/docs/models/documentcreatedocumenttemporaryenvelopeitem.md @@ -0,0 +1,9 @@ +# DocumentCreateDocumentTemporaryEnvelopeItem + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfieldcheckbox.md b/docs/models/documentcreatedocumenttemporaryfieldcheckbox.md index 9a59b66..cacd552 100644 --- a/docs/models/documentcreatedocumenttemporaryfieldcheckbox.md +++ b/docs/models/documentcreatedocumenttemporaryfieldcheckbox.md @@ -7,8 +7,8 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeCheckbox1](../models/documentcreatedocumenttemporaryrecipienttypecheckbox1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox]](../models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md) | :heavy_minus_sign: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfielddate.md b/docs/models/documentcreatedocumenttemporaryfielddate.md index 0e590c5..02dce76 100644 --- a/docs/models/documentcreatedocumenttemporaryfielddate.md +++ b/docs/models/documentcreatedocumenttemporaryfielddate.md @@ -7,8 +7,8 @@ | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeDate1](../models/documentcreatedocumenttemporaryrecipienttypedate1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaDate]](../models/documentcreatedocumenttemporaryrecipientfieldmetadate.md) | :heavy_minus_sign: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfielddropdown.md b/docs/models/documentcreatedocumenttemporaryfielddropdown.md index fd223d4..4e7c4ed 100644 --- a/docs/models/documentcreatedocumenttemporaryfielddropdown.md +++ b/docs/models/documentcreatedocumenttemporaryfielddropdown.md @@ -7,8 +7,8 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeDropdown1](../models/documentcreatedocumenttemporaryrecipienttypedropdown1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaDropdown]](../models/documentcreatedocumenttemporaryrecipientfieldmetadropdown.md) | :heavy_minus_sign: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfieldemail.md b/docs/models/documentcreatedocumenttemporaryfieldemail.md index bd3b623..5246593 100644 --- a/docs/models/documentcreatedocumenttemporaryfieldemail.md +++ b/docs/models/documentcreatedocumenttemporaryfieldemail.md @@ -7,8 +7,8 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeEmail1](../models/documentcreatedocumenttemporaryrecipienttypeemail1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaEmail]](../models/documentcreatedocumenttemporaryrecipientfieldmetaemail.md) | :heavy_minus_sign: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfieldfreesignature.md b/docs/models/documentcreatedocumenttemporaryfieldfreesignature.md index e88d0b6..57a5e82 100644 --- a/docs/models/documentcreatedocumenttemporaryfieldfreesignature.md +++ b/docs/models/documentcreatedocumenttemporaryfieldfreesignature.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.DocumentCreateDocumentTemporaryTypeFreeSignature](../models/documentcreatedocumenttemporarytypefreesignature.md) | :heavy_check_mark: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfieldinitials.md b/docs/models/documentcreatedocumenttemporaryfieldinitials.md index 6950631..1502d08 100644 --- a/docs/models/documentcreatedocumenttemporaryfieldinitials.md +++ b/docs/models/documentcreatedocumenttemporaryfieldinitials.md @@ -7,8 +7,8 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeInitials1](../models/documentcreatedocumenttemporaryrecipienttypeinitials1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaInitials]](../models/documentcreatedocumenttemporaryrecipientfieldmetainitials.md) | :heavy_minus_sign: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfieldname.md b/docs/models/documentcreatedocumenttemporaryfieldname.md index b07b929..b2d1c1e 100644 --- a/docs/models/documentcreatedocumenttemporaryfieldname.md +++ b/docs/models/documentcreatedocumenttemporaryfieldname.md @@ -7,8 +7,8 @@ | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeName1](../models/documentcreatedocumenttemporaryrecipienttypename1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaName]](../models/documentcreatedocumenttemporaryrecipientfieldmetaname.md) | :heavy_minus_sign: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfieldnumber.md b/docs/models/documentcreatedocumenttemporaryfieldnumber.md index 89d0076..ea02b0f 100644 --- a/docs/models/documentcreatedocumenttemporaryfieldnumber.md +++ b/docs/models/documentcreatedocumenttemporaryfieldnumber.md @@ -7,8 +7,8 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeNumber1](../models/documentcreatedocumenttemporaryrecipienttypenumber1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaNumber]](../models/documentcreatedocumenttemporaryrecipientfieldmetanumber.md) | :heavy_minus_sign: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfieldradio.md b/docs/models/documentcreatedocumenttemporaryfieldradio.md index a3e349d..5f1947e 100644 --- a/docs/models/documentcreatedocumenttemporaryfieldradio.md +++ b/docs/models/documentcreatedocumenttemporaryfieldradio.md @@ -7,8 +7,8 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeRadio1](../models/documentcreatedocumenttemporaryrecipienttyperadio1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaRadio]](../models/documentcreatedocumenttemporaryrecipientfieldmetaradio.md) | :heavy_minus_sign: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfieldsignature.md b/docs/models/documentcreatedocumenttemporaryfieldsignature.md index 3dbb26f..f3d2871 100644 --- a/docs/models/documentcreatedocumenttemporaryfieldsignature.md +++ b/docs/models/documentcreatedocumenttemporaryfieldsignature.md @@ -3,11 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `type` | [models.DocumentCreateDocumentTemporaryTypeSignature](../models/documentcreatedocumenttemporarytypesignature.md) | :heavy_check_mark: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeSignature1](../models/documentcreatedocumenttemporaryrecipienttypesignature1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaSignature]](../models/documentcreatedocumenttemporaryrecipientfieldmetasignature.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryfieldtext.md b/docs/models/documentcreatedocumenttemporaryfieldtext.md index 071f890..50f6894 100644 --- a/docs/models/documentcreatedocumenttemporaryfieldtext.md +++ b/docs/models/documentcreatedocumenttemporaryfieldtext.md @@ -7,8 +7,8 @@ | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeText1](../models/documentcreatedocumenttemporaryrecipienttypetext1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaText]](../models/documentcreatedocumenttemporaryrecipientfieldmetatext.md) | :heavy_minus_sign: | N/A | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsinternalservererror.md b/docs/models/documentcreatedocumenttemporaryforbiddenerror.md similarity index 92% rename from docs/models/documentfinddocumentsinternalservererror.md rename to docs/models/documentcreatedocumenttemporaryforbiddenerror.md index 5efc1b1..6bfb3c9 100644 --- a/docs/models/documentfinddocumentsinternalservererror.md +++ b/docs/models/documentcreatedocumenttemporaryforbiddenerror.md @@ -1,6 +1,6 @@ -# DocumentFindDocumentsInternalServerError +# DocumentCreateDocumentTemporaryForbiddenError -Internal server error +Insufficient access ## 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.DocumentFindDocumentsInternalServerErrorIssue](../models/documentfinddocumentsinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.DocumentCreateDocumentTemporaryForbiddenIssue](../models/documentcreatedocumenttemporaryforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsinternalservererrorissue.md b/docs/models/documentcreatedocumenttemporaryforbiddenissue.md similarity index 84% rename from docs/models/documentfinddocumentsinternalservererrorissue.md rename to docs/models/documentcreatedocumenttemporaryforbiddenissue.md index d8dd5f1..cfec325 100644 --- a/docs/models/documentfinddocumentsinternalservererrorissue.md +++ b/docs/models/documentcreatedocumenttemporaryforbiddenissue.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsInternalServerErrorIssue +# DocumentCreateDocumentTemporaryForbiddenIssue ## Fields diff --git a/docs/models/documentgetdocumentwithdetailsbyidformvalues.md b/docs/models/documentcreatedocumenttemporaryformvaluesrequest.md similarity index 79% rename from docs/models/documentgetdocumentwithdetailsbyidformvalues.md rename to docs/models/documentcreatedocumenttemporaryformvaluesrequest.md index 4252bea..0ca71b1 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidformvalues.md +++ b/docs/models/documentcreatedocumenttemporaryformvaluesrequest.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFormValues +# DocumentCreateDocumentTemporaryFormValuesRequest ## Supported Types diff --git a/docs/models/documentcreatedocumenttemporaryglobalaccessauthrequest.md b/docs/models/documentcreatedocumenttemporaryglobalaccessauthrequest.md index 6ba246b..b09f43b 100644 --- a/docs/models/documentcreatedocumenttemporaryglobalaccessauthrequest.md +++ b/docs/models/documentcreatedocumenttemporaryglobalaccessauthrequest.md @@ -1,10 +1,9 @@ # DocumentCreateDocumentTemporaryGlobalAccessAuthRequest -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/documentcreatedocumenttemporaryglobalactionauthrequest.md b/docs/models/documentcreatedocumenttemporaryglobalactionauthrequest.md index f5aee66..19142d3 100644 --- a/docs/models/documentcreatedocumenttemporaryglobalactionauthrequest.md +++ b/docs/models/documentcreatedocumenttemporaryglobalactionauthrequest.md @@ -1,7 +1,5 @@ # DocumentCreateDocumentTemporaryGlobalActionAuthRequest -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. - ## Values diff --git a/docs/models/documentcreatedocumenttemporarylanguage.md b/docs/models/documentcreatedocumenttemporarylanguage.md index 6749a71..10b6d7f 100644 --- a/docs/models/documentcreatedocumenttemporarylanguage.md +++ b/docs/models/documentcreatedocumenttemporarylanguage.md @@ -1,7 +1,5 @@ # DocumentCreateDocumentTemporaryLanguage -The language to use for email communications with recipients. - ## Values diff --git a/docs/models/documentcreatedocumenttemporarymeta.md b/docs/models/documentcreatedocumenttemporarymeta.md index 460fa99..e6d114d 100644 --- a/docs/models/documentcreatedocumenttemporarymeta.md +++ b/docs/models/documentcreatedocumenttemporarymeta.md @@ -3,17 +3,20 @@ ## 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.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 | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.DocumentCreateDocumentTemporaryDateFormat]](../models/documentcreatedocumenttemporarydateformat.md) | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.DocumentCreateDocumentTemporaryMetaDistributionMethod]](../models/documentcreatedocumenttemporarymetadistributionmethod.md) | :heavy_minus_sign: | N/A | +| `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: | N/A | +| `language` | [Optional[models.DocumentCreateDocumentTemporaryLanguage]](../models/documentcreatedocumenttemporarylanguage.md) | :heavy_minus_sign: | N/A | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [OptionalNullable[models.DocumentCreateDocumentTemporaryMetaEmailSettings]](../models/documentcreatedocumenttemporarymetaemailsettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarymetadistributionmethod.md b/docs/models/documentcreatedocumenttemporarymetadistributionmethod.md new file mode 100644 index 0000000..d026427 --- /dev/null +++ b/docs/models/documentcreatedocumenttemporarymetadistributionmethod.md @@ -0,0 +1,9 @@ +# DocumentCreateDocumentTemporaryMetaDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarymetaemailsettings.md b/docs/models/documentcreatedocumenttemporarymetaemailsettings.md new file mode 100644 index 0000000..7de2084 --- /dev/null +++ b/docs/models/documentcreatedocumenttemporarymetaemailsettings.md @@ -0,0 +1,14 @@ +# DocumentCreateDocumentTemporaryMetaEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md index e3f17a9..2d8265a 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md @@ -9,7 +9,9 @@ | `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 | +| `font_size` | *Optional[float]* | :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 +| `validation_length` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.DocumentCreateDocumentTemporaryDirectionCheckbox]](../models/documentcreatedocumenttemporarydirectioncheckbox.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetadate.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetadate.md index b4ab112..f604f92 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetadate.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetadate.md @@ -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.DocumentCreateDocumentTemporaryRecipientTypeDate2](../models/documentcreatedocumenttemporaryrecipienttypedate2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeDate2](../models/documentcreatedocumenttemporaryrecipienttypedate2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.DocumentCreateDocumentTemporaryTextAlignDate]](../models/documentcreatedocumenttemporarytextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetadropdown.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetadropdown.md index 74bb7d9..a166890 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetadropdown.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeDropdown2](../models/documentcreatedocumenttemporaryrecipienttypedropdown2.md) | :heavy_check_mark: | N/A | | `values` | List[[models.DocumentCreateDocumentTemporaryValueDropdown](../models/documentcreatedocumenttemporaryvaluedropdown.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/documentcreatedocumenttemporaryrecipientfieldmetaemail.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaemail.md index 96ddf4c..e036362 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaemail.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaemail.md @@ -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.DocumentCreateDocumentTemporaryRecipientTypeEmail2](../models/documentcreatedocumenttemporaryrecipienttypeemail2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeEmail2](../models/documentcreatedocumenttemporaryrecipienttypeemail2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.DocumentCreateDocumentTemporaryTextAlignEmail]](../models/documentcreatedocumenttemporarytextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetainitials.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetainitials.md index 59878a8..414853f 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetainitials.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetainitials.md @@ -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.DocumentCreateDocumentTemporaryRecipientTypeInitials2](../models/documentcreatedocumenttemporaryrecipienttypeinitials2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeInitials2](../models/documentcreatedocumenttemporaryrecipienttypeinitials2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.DocumentCreateDocumentTemporaryTextAlignInitials]](../models/documentcreatedocumenttemporarytextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaname.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaname.md index 25b0f07..a278a70 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaname.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaname.md @@ -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.DocumentCreateDocumentTemporaryRecipientTypeName2](../models/documentcreatedocumenttemporaryrecipienttypename2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeName2](../models/documentcreatedocumenttemporaryrecipienttypename2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.DocumentCreateDocumentTemporaryTextAlignName]](../models/documentcreatedocumenttemporarytextalignname.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..f6a13ea 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetanumber.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.DocumentCreateDocumentTemporaryRecipientTypeNumber2](../models/documentcreatedocumenttemporaryrecipienttypenumber2.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.DocumentCreateDocumentTemporaryTextAlignNumber]](../models/documentcreatedocumenttemporarytextalignnumber.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeNumber2](../models/documentcreatedocumenttemporaryrecipienttypenumber2.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 | +| `text_align` | [Optional[models.DocumentCreateDocumentTemporaryTextAlignNumber]](../models/documentcreatedocumenttemporarytextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.DocumentCreateDocumentTemporaryVerticalAlignNumber]](../models/documentcreatedocumenttemporaryverticalalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaradio.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaradio.md index c751f71..faf462d 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaradio.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetaradio.md @@ -9,5 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeRadio2](../models/documentcreatedocumenttemporaryrecipienttyperadio2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.DocumentCreateDocumentTemporaryValueRadio](../models/documentcreatedocumenttemporaryvalueradio.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `values` | List[[models.DocumentCreateDocumentTemporaryValueRadio](../models/documentcreatedocumenttemporaryvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.DocumentCreateDocumentTemporaryDirectionRadio]](../models/documentcreatedocumenttemporarydirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetasignature.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetasignature.md new file mode 100644 index 0000000..a350668 --- /dev/null +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetasignature.md @@ -0,0 +1,13 @@ +# DocumentCreateDocumentTemporaryRecipientFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeSignature2](../models/documentcreatedocumenttemporaryrecipienttypesignature2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetatext.md b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetatext.md index b891faa..40d9d0f 100644 --- a/docs/models/documentcreatedocumenttemporaryrecipientfieldmetatext.md +++ b/docs/models/documentcreatedocumenttemporaryrecipientfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.DocumentCreateDocumentTemporaryRecipientTypeText2](../models/documentcreatedocumenttemporaryrecipienttypetext2.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.DocumentCreateDocumentTemporaryTextAlignText]](../models/documentcreatedocumenttemporarytextaligntext.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeText2](../models/documentcreatedocumenttemporaryrecipienttypetext2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.DocumentCreateDocumentTemporaryTextAlignText]](../models/documentcreatedocumenttemporarytextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.DocumentCreateDocumentTemporaryVerticalAlignText]](../models/documentcreatedocumenttemporaryverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipienttypesignature1.md b/docs/models/documentcreatedocumenttemporaryrecipienttypesignature1.md new file mode 100644 index 0000000..6732bce --- /dev/null +++ b/docs/models/documentcreatedocumenttemporaryrecipienttypesignature1.md @@ -0,0 +1,8 @@ +# DocumentCreateDocumentTemporaryRecipientTypeSignature1 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | SIGNATURE | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrecipienttypesignature2.md b/docs/models/documentcreatedocumenttemporaryrecipienttypesignature2.md new file mode 100644 index 0000000..5206ad4 --- /dev/null +++ b/docs/models/documentcreatedocumenttemporaryrecipienttypesignature2.md @@ -0,0 +1,8 @@ +# DocumentCreateDocumentTemporaryRecipientTypeSignature2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryrequest.md b/docs/models/documentcreatedocumenttemporaryrequest.md index b7ece11..e246a0b 100644 --- a/docs/models/documentcreatedocumenttemporaryrequest.md +++ b/docs/models/documentcreatedocumenttemporaryrequest.md @@ -5,11 +5,13 @@ | Field | 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. | +| `title` | *str* | :heavy_check_mark: | N/A | +| `external_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.DocumentCreateDocumentTemporaryVisibilityRequest]](../models/documentcreatedocumenttemporaryvisibilityrequest.md) | :heavy_minus_sign: | N/A | | `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 | +| `form_values` | Dict[str, [models.DocumentCreateDocumentTemporaryFormValuesRequest](../models/documentcreatedocumenttemporaryformvaluesrequest.md)] | :heavy_minus_sign: | N/A | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | `recipients` | List[[models.DocumentCreateDocumentTemporaryRecipientRequest](../models/documentcreatedocumenttemporaryrecipientrequest.md)] | :heavy_minus_sign: | N/A | +| `attachments` | List[[models.DocumentCreateDocumentTemporaryAttachment](../models/documentcreatedocumenttemporaryattachment.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..6373978 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: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarytypelink.md b/docs/models/documentcreatedocumenttemporarytypelink.md new file mode 100644 index 0000000..fcaa008 --- /dev/null +++ b/docs/models/documentcreatedocumenttemporarytypelink.md @@ -0,0 +1,8 @@ +# DocumentCreateDocumentTemporaryTypeLink + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryunauthorizederror.md b/docs/models/documentcreatedocumenttemporaryunauthorizederror.md new file mode 100644 index 0000000..112e5c6 --- /dev/null +++ b/docs/models/documentcreatedocumenttemporaryunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentCreateDocumentTemporaryUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentCreateDocumentTemporaryUnauthorizedIssue](../models/documentcreatedocumenttemporaryunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryunauthorizedissue.md b/docs/models/documentcreatedocumenttemporaryunauthorizedissue.md new file mode 100644 index 0000000..715ffd8 --- /dev/null +++ b/docs/models/documentcreatedocumenttemporaryunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentCreateDocumentTemporaryUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryverticalalignnumber.md b/docs/models/documentcreatedocumenttemporaryverticalalignnumber.md new file mode 100644 index 0000000..902a9ac --- /dev/null +++ b/docs/models/documentcreatedocumenttemporaryverticalalignnumber.md @@ -0,0 +1,10 @@ +# DocumentCreateDocumentTemporaryVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryverticalaligntext.md b/docs/models/documentcreatedocumenttemporaryverticalaligntext.md new file mode 100644 index 0000000..99b3bba --- /dev/null +++ b/docs/models/documentcreatedocumenttemporaryverticalaligntext.md @@ -0,0 +1,10 @@ +# DocumentCreateDocumentTemporaryVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporaryvisibilityrequest.md b/docs/models/documentcreatedocumenttemporaryvisibilityrequest.md index bd7abcd..ee9fe86 100644 --- a/docs/models/documentcreatedocumenttemporaryvisibilityrequest.md +++ b/docs/models/documentcreatedocumenttemporaryvisibilityrequest.md @@ -1,7 +1,5 @@ # DocumentCreateDocumentTemporaryVisibilityRequest -The visibility of the document. - ## Values diff --git a/docs/models/documentcreateemailsettings.md b/docs/models/documentcreateemailsettings.md new file mode 100644 index 0000000..f9a88cb --- /dev/null +++ b/docs/models/documentcreateemailsettings.md @@ -0,0 +1,14 @@ +# DocumentCreateEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldcheckbox.md b/docs/models/documentcreatefieldcheckbox.md new file mode 100644 index 0000000..9ad87a8 --- /dev/null +++ b/docs/models/documentcreatefieldcheckbox.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldCheckbox + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `type` | [models.DocumentCreateTypeCheckbox1](../models/documentcreatetypecheckbox1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateFieldMetaCheckbox]](../models/documentcreatefieldmetacheckbox.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefielddate.md b/docs/models/documentcreatefielddate.md new file mode 100644 index 0000000..e948652 --- /dev/null +++ b/docs/models/documentcreatefielddate.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldDate + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `type` | [models.DocumentCreateTypeDate1](../models/documentcreatetypedate1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateFieldMetaDate]](../models/documentcreatefieldmetadate.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefielddropdown.md b/docs/models/documentcreatefielddropdown.md new file mode 100644 index 0000000..bbb252f --- /dev/null +++ b/docs/models/documentcreatefielddropdown.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldDropdown + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `type` | [models.DocumentCreateTypeDropdown1](../models/documentcreatetypedropdown1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateFieldMetaDropdown]](../models/documentcreatefieldmetadropdown.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldemail.md b/docs/models/documentcreatefieldemail.md new file mode 100644 index 0000000..3a307f6 --- /dev/null +++ b/docs/models/documentcreatefieldemail.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldEmail + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `type` | [models.DocumentCreateTypeEmail1](../models/documentcreatetypeemail1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateFieldMetaEmail]](../models/documentcreatefieldmetaemail.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldfreesignature.md b/docs/models/documentcreatefieldfreesignature.md new file mode 100644 index 0000000..f2b008a --- /dev/null +++ b/docs/models/documentcreatefieldfreesignature.md @@ -0,0 +1,13 @@ +# DocumentCreateFieldFreeSignature + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `type` | [models.DocumentCreateTypeFreeSignature](../models/documentcreatetypefreesignature.md) | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldinitials.md b/docs/models/documentcreatefieldinitials.md new file mode 100644 index 0000000..759e89b --- /dev/null +++ b/docs/models/documentcreatefieldinitials.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldInitials + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `type` | [models.DocumentCreateTypeInitials1](../models/documentcreatetypeinitials1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateFieldMetaInitials]](../models/documentcreatefieldmetainitials.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldmetacheckbox.md b/docs/models/documentcreatefieldmetacheckbox.md new file mode 100644 index 0000000..3c73c4d --- /dev/null +++ b/docs/models/documentcreatefieldmetacheckbox.md @@ -0,0 +1,17 @@ +# DocumentCreateFieldMetaCheckbox + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateTypeCheckbox2](../models/documentcreatetypecheckbox2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.DocumentCreateValueCheckbox](../models/documentcreatevaluecheckbox.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.DocumentCreateDirectionCheckbox]](../models/documentcreatedirectioncheckbox.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldmetadate.md b/docs/models/documentcreatefieldmetadate.md new file mode 100644 index 0000000..a1cc2a6 --- /dev/null +++ b/docs/models/documentcreatefieldmetadate.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldMetaDate + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateTypeDate2](../models/documentcreatetypedate2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.DocumentCreateTextAlignDate]](../models/documentcreatetextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldmetadropdown.md b/docs/models/documentcreatefieldmetadropdown.md new file mode 100644 index 0000000..2a44b4e --- /dev/null +++ b/docs/models/documentcreatefieldmetadropdown.md @@ -0,0 +1,15 @@ +# DocumentCreateFieldMetaDropdown + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateTypeDropdown2](../models/documentcreatetypedropdown2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.DocumentCreateValueDropdown](../models/documentcreatevaluedropdown.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/documentcreatefieldmetaemail.md b/docs/models/documentcreatefieldmetaemail.md new file mode 100644 index 0000000..1e428c8 --- /dev/null +++ b/docs/models/documentcreatefieldmetaemail.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldMetaEmail + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateTypeEmail2](../models/documentcreatetypeemail2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.DocumentCreateTextAlignEmail]](../models/documentcreatetextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldmetainitials.md b/docs/models/documentcreatefieldmetainitials.md new file mode 100644 index 0000000..6f2e931 --- /dev/null +++ b/docs/models/documentcreatefieldmetainitials.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldMetaInitials + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateTypeInitials2](../models/documentcreatetypeinitials2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.DocumentCreateTextAlignInitials]](../models/documentcreatetextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldmetaname.md b/docs/models/documentcreatefieldmetaname.md new file mode 100644 index 0000000..6330986 --- /dev/null +++ b/docs/models/documentcreatefieldmetaname.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldMetaName + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateTypeName2](../models/documentcreatetypename2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.DocumentCreateTextAlignName]](../models/documentcreatetextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldmetanumber.md b/docs/models/documentcreatefieldmetanumber.md new file mode 100644 index 0000000..8f095b7 --- /dev/null +++ b/docs/models/documentcreatefieldmetanumber.md @@ -0,0 +1,21 @@ +# DocumentCreateFieldMetaNumber + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateTypeNumber2](../models/documentcreatetypenumber2.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 | +| `text_align` | [Optional[models.DocumentCreateTextAlignNumber]](../models/documentcreatetextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.DocumentCreateVerticalAlignNumber]](../models/documentcreateverticalalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldmetaradio.md b/docs/models/documentcreatefieldmetaradio.md new file mode 100644 index 0000000..881a526 --- /dev/null +++ b/docs/models/documentcreatefieldmetaradio.md @@ -0,0 +1,15 @@ +# DocumentCreateFieldMetaRadio + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateTypeRadio2](../models/documentcreatetyperadio2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.DocumentCreateValueRadio](../models/documentcreatevalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.DocumentCreateDirectionRadio]](../models/documentcreatedirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldmetasignature.md b/docs/models/documentcreatefieldmetasignature.md new file mode 100644 index 0000000..ddf3b7f --- /dev/null +++ b/docs/models/documentcreatefieldmetasignature.md @@ -0,0 +1,13 @@ +# DocumentCreateFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateTypeSignature2](../models/documentcreatetypesignature2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldmetatext.md b/docs/models/documentcreatefieldmetatext.md new file mode 100644 index 0000000..98265a1 --- /dev/null +++ b/docs/models/documentcreatefieldmetatext.md @@ -0,0 +1,19 @@ +# DocumentCreateFieldMetaText + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentCreateTypeText2](../models/documentcreatetypetext2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.DocumentCreateTextAlignText]](../models/documentcreatetextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.DocumentCreateVerticalAlignText]](../models/documentcreateverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldname.md b/docs/models/documentcreatefieldname.md new file mode 100644 index 0000000..41c1ac4 --- /dev/null +++ b/docs/models/documentcreatefieldname.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldName + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `type` | [models.DocumentCreateTypeName1](../models/documentcreatetypename1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateFieldMetaName]](../models/documentcreatefieldmetaname.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldnumber.md b/docs/models/documentcreatefieldnumber.md new file mode 100644 index 0000000..32d0c5b --- /dev/null +++ b/docs/models/documentcreatefieldnumber.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldNumber + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `type` | [models.DocumentCreateTypeNumber1](../models/documentcreatetypenumber1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateFieldMetaNumber]](../models/documentcreatefieldmetanumber.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldradio.md b/docs/models/documentcreatefieldradio.md new file mode 100644 index 0000000..e3d2f0b --- /dev/null +++ b/docs/models/documentcreatefieldradio.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldRadio + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `type` | [models.DocumentCreateTypeRadio1](../models/documentcreatetyperadio1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateFieldMetaRadio]](../models/documentcreatefieldmetaradio.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldsignature.md b/docs/models/documentcreatefieldsignature.md new file mode 100644 index 0000000..1c57982 --- /dev/null +++ b/docs/models/documentcreatefieldsignature.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldSignature + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `type` | [models.DocumentCreateTypeSignature1](../models/documentcreatetypesignature1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateFieldMetaSignature]](../models/documentcreatefieldmetasignature.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldtext.md b/docs/models/documentcreatefieldtext.md new file mode 100644 index 0000000..adb778f --- /dev/null +++ b/docs/models/documentcreatefieldtext.md @@ -0,0 +1,14 @@ +# DocumentCreateFieldText + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `type` | [models.DocumentCreateTypeText1](../models/documentcreatetypetext1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.DocumentCreateFieldMetaText]](../models/documentcreatefieldmetatext.md) | :heavy_minus_sign: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatefieldunion.md b/docs/models/documentcreatefieldunion.md new file mode 100644 index 0000000..8923337 --- /dev/null +++ b/docs/models/documentcreatefieldunion.md @@ -0,0 +1,71 @@ +# DocumentCreateFieldUnion + + +## Supported Types + +### `models.DocumentCreateFieldSignature` + +```python +value: models.DocumentCreateFieldSignature = /* values here */ +``` + +### `models.DocumentCreateFieldFreeSignature` + +```python +value: models.DocumentCreateFieldFreeSignature = /* values here */ +``` + +### `models.DocumentCreateFieldInitials` + +```python +value: models.DocumentCreateFieldInitials = /* values here */ +``` + +### `models.DocumentCreateFieldName` + +```python +value: models.DocumentCreateFieldName = /* values here */ +``` + +### `models.DocumentCreateFieldEmail` + +```python +value: models.DocumentCreateFieldEmail = /* values here */ +``` + +### `models.DocumentCreateFieldDate` + +```python +value: models.DocumentCreateFieldDate = /* values here */ +``` + +### `models.DocumentCreateFieldText` + +```python +value: models.DocumentCreateFieldText = /* values here */ +``` + +### `models.DocumentCreateFieldNumber` + +```python +value: models.DocumentCreateFieldNumber = /* values here */ +``` + +### `models.DocumentCreateFieldRadio` + +```python +value: models.DocumentCreateFieldRadio = /* values here */ +``` + +### `models.DocumentCreateFieldCheckbox` + +```python +value: models.DocumentCreateFieldCheckbox = /* values here */ +``` + +### `models.DocumentCreateFieldDropdown` + +```python +value: models.DocumentCreateFieldDropdown = /* values here */ +``` + diff --git a/docs/models/documentcreatefile.md b/docs/models/documentcreatefile.md new file mode 100644 index 0000000..1e94f74 --- /dev/null +++ b/docs/models/documentcreatefile.md @@ -0,0 +1,10 @@ +# DocumentCreateFile + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `file_name` | *str* | :heavy_check_mark: | N/A | +| `content` | *Union[bytes, IO[bytes], io.BufferedReader]* | :heavy_check_mark: | N/A | +| `content_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentrequest.md b/docs/models/documentcreateforbiddenerror.md similarity index 66% rename from docs/models/documentupdatedocumentrequest.md rename to docs/models/documentcreateforbiddenerror.md index 8ffc3fc..e2d15ca 100644 --- a/docs/models/documentupdatedocumentrequest.md +++ b/docs/models/documentcreateforbiddenerror.md @@ -1,10 +1,12 @@ -# DocumentUpdateDocumentRequest +# DocumentCreateForbiddenError + +Insufficient access ## 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 +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentCreateForbiddenIssue](../models/documentcreateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentresenddocumentbadrequestissue.md b/docs/models/documentcreateforbiddenissue.md similarity index 87% rename from docs/models/documentresenddocumentbadrequestissue.md rename to docs/models/documentcreateforbiddenissue.md index 1f60f7d..0b3f6d9 100644 --- a/docs/models/documentresenddocumentbadrequestissue.md +++ b/docs/models/documentcreateforbiddenissue.md @@ -1,4 +1,4 @@ -# DocumentResendDocumentBadRequestIssue +# DocumentCreateForbiddenIssue ## Fields diff --git a/docs/models/documentsenddocumentformvalues.md b/docs/models/documentcreateformvalues.md similarity index 85% rename from docs/models/documentsenddocumentformvalues.md rename to docs/models/documentcreateformvalues.md index 7f1fb3f..f7b1e61 100644 --- a/docs/models/documentsenddocumentformvalues.md +++ b/docs/models/documentcreateformvalues.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentFormValues +# DocumentCreateFormValues ## Supported Types diff --git a/docs/models/documentcreateglobalaccessauth.md b/docs/models/documentcreateglobalaccessauth.md new file mode 100644 index 0000000..32f70d2 --- /dev/null +++ b/docs/models/documentcreateglobalaccessauth.md @@ -0,0 +1,9 @@ +# DocumentCreateGlobalAccessAuth + + +## 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/documentcreateglobalactionauth.md similarity index 60% rename from docs/models/documentsenddocumentglobalactionauth.md rename to docs/models/documentcreateglobalactionauth.md index f7b911d..7212e4e 100644 --- a/docs/models/documentsenddocumentglobalactionauth.md +++ b/docs/models/documentcreateglobalactionauth.md @@ -1,6 +1,4 @@ -# DocumentSendDocumentGlobalActionAuth - -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. +# DocumentCreateGlobalActionAuth ## Values diff --git a/docs/models/documentcreateinternalservererror.md b/docs/models/documentcreateinternalservererror.md new file mode 100644 index 0000000..1c8e418 --- /dev/null +++ b/docs/models/documentcreateinternalservererror.md @@ -0,0 +1,12 @@ +# DocumentCreateInternalServerError + +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.DocumentCreateInternalServerErrorIssue](../models/documentcreateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreateinternalservererrorissue.md b/docs/models/documentcreateinternalservererrorissue.md new file mode 100644 index 0000000..961c062 --- /dev/null +++ b/docs/models/documentcreateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentCreateInternalServerErrorIssue + + +## 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/documentcreatelanguage.md similarity index 62% rename from docs/models/documentsenddocumentlanguage.md rename to docs/models/documentcreatelanguage.md index b199c5d..f296caa 100644 --- a/docs/models/documentsenddocumentlanguage.md +++ b/docs/models/documentcreatelanguage.md @@ -1,6 +1,4 @@ -# DocumentSendDocumentLanguage - -The language to use for email communications with recipients. +# DocumentCreateLanguage ## Values diff --git a/docs/models/documentcreatemeta.md b/docs/models/documentcreatemeta.md new file mode 100644 index 0000000..fd9fbf2 --- /dev/null +++ b/docs/models/documentcreatemeta.md @@ -0,0 +1,22 @@ +# DocumentCreateMeta + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.DocumentCreateDateFormat]](../models/documentcreatedateformat.md) | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.DocumentCreateDistributionMethod]](../models/documentcreatedistributionmethod.md) | :heavy_minus_sign: | N/A | +| `signing_order` | [Optional[models.DocumentCreateSigningOrder]](../models/documentcreatesigningorder.md) | :heavy_minus_sign: | N/A | +| `allow_dictate_next_signer` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `language` | [Optional[models.DocumentCreateLanguage]](../models/documentcreatelanguage.md) | :heavy_minus_sign: | N/A | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [OptionalNullable[models.DocumentCreateEmailSettings]](../models/documentcreateemailsettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreatepayload.md b/docs/models/documentcreatepayload.md new file mode 100644 index 0000000..b246c7d --- /dev/null +++ b/docs/models/documentcreatepayload.md @@ -0,0 +1,17 @@ +# DocumentCreatePayload + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `title` | *str* | :heavy_check_mark: | N/A | +| `external_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.DocumentCreateVisibility]](../models/documentcreatevisibility.md) | :heavy_minus_sign: | N/A | +| `global_access_auth` | List[[models.DocumentCreateGlobalAccessAuth](../models/documentcreateglobalaccessauth.md)] | :heavy_minus_sign: | N/A | +| `global_action_auth` | List[[models.DocumentCreateGlobalActionAuth](../models/documentcreateglobalactionauth.md)] | :heavy_minus_sign: | N/A | +| `form_values` | Dict[str, [models.DocumentCreateFormValues](../models/documentcreateformvalues.md)] | :heavy_minus_sign: | N/A | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `recipients` | List[[models.DocumentCreateRecipient](../models/documentcreaterecipient.md)] | :heavy_minus_sign: | N/A | +| `attachments` | List[[models.DocumentCreateAttachment](../models/documentcreateattachment.md)] | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.DocumentCreateMeta]](../models/documentcreatemeta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreaterecipient.md b/docs/models/documentcreaterecipient.md new file mode 100644 index 0000000..b46aa81 --- /dev/null +++ b/docs/models/documentcreaterecipient.md @@ -0,0 +1,14 @@ +# DocumentCreateRecipient + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `email` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `role` | [models.DocumentCreateRole](../models/documentcreaterole.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `access_auth` | List[[models.DocumentCreateAccessAuth](../models/documentcreateaccessauth.md)] | :heavy_minus_sign: | N/A | +| `action_auth` | List[[models.DocumentCreateActionAuth](../models/documentcreateactionauth.md)] | :heavy_minus_sign: | N/A | +| `fields` | List[[models.DocumentCreateFieldUnion](../models/documentcreatefieldunion.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreaterequest.md b/docs/models/documentcreaterequest.md new file mode 100644 index 0000000..469d629 --- /dev/null +++ b/docs/models/documentcreaterequest.md @@ -0,0 +1,9 @@ +# DocumentCreateRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `payload` | [models.DocumentCreatePayload](../models/documentcreatepayload.md) | :heavy_check_mark: | N/A | +| `file` | [models.DocumentCreateFile](../models/documentcreatefile.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreateresponse.md b/docs/models/documentcreateresponse.md new file mode 100644 index 0000000..974fee6 --- /dev/null +++ b/docs/models/documentcreateresponse.md @@ -0,0 +1,11 @@ +# DocumentCreateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsrole.md b/docs/models/documentcreaterole.md similarity index 88% rename from docs/models/documentfinddocumentsrole.md rename to docs/models/documentcreaterole.md index 0e646bb..27230a8 100644 --- a/docs/models/documentfinddocumentsrole.md +++ b/docs/models/documentcreaterole.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsRole +# DocumentCreateRole ## Values diff --git a/docs/models/documentupdatedocumentsigningorder.md b/docs/models/documentcreatesigningorder.md similarity index 79% rename from docs/models/documentupdatedocumentsigningorder.md rename to docs/models/documentcreatesigningorder.md index e511d91..6303a3d 100644 --- a/docs/models/documentupdatedocumentsigningorder.md +++ b/docs/models/documentcreatesigningorder.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentSigningOrder +# DocumentCreateSigningOrder ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtextalign2.md b/docs/models/documentcreatetextaligndate.md similarity index 73% rename from docs/models/documentgetdocumentwithdetailsbyidtextalign2.md rename to docs/models/documentcreatetextaligndate.md index 2bf9687..0f4cbc6 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtextalign2.md +++ b/docs/models/documentcreatetextaligndate.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTextAlign2 +# DocumentCreateTextAlignDate ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtextalign1.md b/docs/models/documentcreatetextalignemail.md similarity index 73% rename from docs/models/documentgetdocumentwithdetailsbyidtextalign1.md rename to docs/models/documentcreatetextalignemail.md index 24f132a..cea559c 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtextalign1.md +++ b/docs/models/documentcreatetextalignemail.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTextAlign1 +# DocumentCreateTextAlignEmail ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtextalign3.md b/docs/models/documentcreatetextaligninitials.md similarity index 73% rename from docs/models/documentgetdocumentwithdetailsbyidtextalign3.md rename to docs/models/documentcreatetextaligninitials.md index 3e16a6c..2b1953e 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtextalign3.md +++ b/docs/models/documentcreatetextaligninitials.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTextAlign3 +# DocumentCreateTextAlignInitials ## Values diff --git a/docs/models/documentgetdocumentwithdetailsbyidtextalign4.md b/docs/models/documentcreatetextalignname.md similarity index 73% rename from docs/models/documentgetdocumentwithdetailsbyidtextalign4.md rename to docs/models/documentcreatetextalignname.md index d240edb..9074327 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtextalign4.md +++ b/docs/models/documentcreatetextalignname.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTextAlign4 +# DocumentCreateTextAlignName ## Values diff --git a/docs/models/documentcreatetextalignnumber.md b/docs/models/documentcreatetextalignnumber.md new file mode 100644 index 0000000..feb1e16 --- /dev/null +++ b/docs/models/documentcreatetextalignnumber.md @@ -0,0 +1,10 @@ +# DocumentCreateTextAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/documentcreatetextaligntext.md b/docs/models/documentcreatetextaligntext.md new file mode 100644 index 0000000..659018d --- /dev/null +++ b/docs/models/documentcreatetextaligntext.md @@ -0,0 +1,10 @@ +# DocumentCreateTextAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/documentcreatetypecheckbox1.md b/docs/models/documentcreatetypecheckbox1.md new file mode 100644 index 0000000..8ca34cd --- /dev/null +++ b/docs/models/documentcreatetypecheckbox1.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeCheckbox1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | CHECKBOX | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypecheckbox.md b/docs/models/documentcreatetypecheckbox2.md similarity index 66% rename from docs/models/documentgetdocumentwithdetailsbyidtypecheckbox.md rename to docs/models/documentcreatetypecheckbox2.md index 0b6ffdb..1a1a3a8 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypecheckbox.md +++ b/docs/models/documentcreatetypecheckbox2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeCheckbox +# DocumentCreateTypeCheckbox2 ## Values diff --git a/docs/models/documentcreatetypedate1.md b/docs/models/documentcreatetypedate1.md new file mode 100644 index 0000000..8165de5 --- /dev/null +++ b/docs/models/documentcreatetypedate1.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeDate1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | DATE | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypedate.md b/docs/models/documentcreatetypedate2.md similarity index 61% rename from docs/models/documentgetdocumentwithdetailsbyidtypedate.md rename to docs/models/documentcreatetypedate2.md index da257a8..93de1bf 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypedate.md +++ b/docs/models/documentcreatetypedate2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeDate +# DocumentCreateTypeDate2 ## Values diff --git a/docs/models/documentcreatetypedropdown1.md b/docs/models/documentcreatetypedropdown1.md new file mode 100644 index 0000000..ca059a6 --- /dev/null +++ b/docs/models/documentcreatetypedropdown1.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeDropdown1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | DROPDOWN | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypedropdown.md b/docs/models/documentcreatetypedropdown2.md similarity index 66% rename from docs/models/documentgetdocumentwithdetailsbyidtypedropdown.md rename to docs/models/documentcreatetypedropdown2.md index e5f4fcc..bde14a3 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypedropdown.md +++ b/docs/models/documentcreatetypedropdown2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeDropdown +# DocumentCreateTypeDropdown2 ## Values diff --git a/docs/models/documentcreatetypeemail1.md b/docs/models/documentcreatetypeemail1.md new file mode 100644 index 0000000..e81deda --- /dev/null +++ b/docs/models/documentcreatetypeemail1.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeEmail1 + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypeemail.md b/docs/models/documentcreatetypeemail2.md similarity index 62% rename from docs/models/documentgetdocumentwithdetailsbyidtypeemail.md rename to docs/models/documentcreatetypeemail2.md index b9ee442..f223859 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypeemail.md +++ b/docs/models/documentcreatetypeemail2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeEmail +# DocumentCreateTypeEmail2 ## Values diff --git a/docs/models/documentcreatetypefreesignature.md b/docs/models/documentcreatetypefreesignature.md new file mode 100644 index 0000000..ae5e25c --- /dev/null +++ b/docs/models/documentcreatetypefreesignature.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeFreeSignature + + +## Values + +| Name | Value | +| ---------------- | ---------------- | +| `FREE_SIGNATURE` | FREE_SIGNATURE | \ No newline at end of file diff --git a/docs/models/documentcreatetypeinitials1.md b/docs/models/documentcreatetypeinitials1.md new file mode 100644 index 0000000..8085643 --- /dev/null +++ b/docs/models/documentcreatetypeinitials1.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeInitials1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | INITIALS | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypeinitials.md b/docs/models/documentcreatetypeinitials2.md similarity index 66% rename from docs/models/documentgetdocumentwithdetailsbyidtypeinitials.md rename to docs/models/documentcreatetypeinitials2.md index 2f18bc6..7cefda1 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypeinitials.md +++ b/docs/models/documentcreatetypeinitials2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeInitials +# DocumentCreateTypeInitials2 ## Values diff --git a/docs/models/documentcreatetypelink.md b/docs/models/documentcreatetypelink.md new file mode 100644 index 0000000..1ae1693 --- /dev/null +++ b/docs/models/documentcreatetypelink.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeLink + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/docs/models/documentcreatetypename1.md b/docs/models/documentcreatetypename1.md new file mode 100644 index 0000000..af3919b --- /dev/null +++ b/docs/models/documentcreatetypename1.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeName1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | NAME | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypename.md b/docs/models/documentcreatetypename2.md similarity index 61% rename from docs/models/documentgetdocumentwithdetailsbyidtypename.md rename to docs/models/documentcreatetypename2.md index 89b3c20..13903d8 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypename.md +++ b/docs/models/documentcreatetypename2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeName +# DocumentCreateTypeName2 ## Values diff --git a/docs/models/documentcreatetypenumber1.md b/docs/models/documentcreatetypenumber1.md new file mode 100644 index 0000000..c2d0796 --- /dev/null +++ b/docs/models/documentcreatetypenumber1.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeNumber1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | NUMBER | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypenumber.md b/docs/models/documentcreatetypenumber2.md similarity index 64% rename from docs/models/documentgetdocumentwithdetailsbyidtypenumber.md rename to docs/models/documentcreatetypenumber2.md index 1c3d574..3a02d38 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypenumber.md +++ b/docs/models/documentcreatetypenumber2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeNumber +# DocumentCreateTypeNumber2 ## Values diff --git a/docs/models/documentcreatetyperadio1.md b/docs/models/documentcreatetyperadio1.md new file mode 100644 index 0000000..65ab1f6 --- /dev/null +++ b/docs/models/documentcreatetyperadio1.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeRadio1 + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | RADIO | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtyperadio.md b/docs/models/documentcreatetyperadio2.md similarity index 62% rename from docs/models/documentgetdocumentwithdetailsbyidtyperadio.md rename to docs/models/documentcreatetyperadio2.md index c87bd57..4edd01e 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtyperadio.md +++ b/docs/models/documentcreatetyperadio2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeRadio +# DocumentCreateTypeRadio2 ## Values diff --git a/docs/models/fieldupdatedocumentfieldtypesignature.md b/docs/models/documentcreatetypesignature1.md similarity index 71% rename from docs/models/fieldupdatedocumentfieldtypesignature.md rename to docs/models/documentcreatetypesignature1.md index 54d0e79..a0daf4e 100644 --- a/docs/models/fieldupdatedocumentfieldtypesignature.md +++ b/docs/models/documentcreatetypesignature1.md @@ -1,4 +1,4 @@ -# FieldUpdateDocumentFieldTypeSignature +# DocumentCreateTypeSignature1 ## Values diff --git a/docs/models/fieldcreatetemplatefieldtypesignature.md b/docs/models/documentcreatetypesignature2.md similarity index 51% rename from docs/models/fieldcreatetemplatefieldtypesignature.md rename to docs/models/documentcreatetypesignature2.md index c809ecf..f2a4fc9 100644 --- a/docs/models/fieldcreatetemplatefieldtypesignature.md +++ b/docs/models/documentcreatetypesignature2.md @@ -1,8 +1,8 @@ -# FieldCreateTemplateFieldTypeSignature +# DocumentCreateTypeSignature2 ## Values | Name | Value | | ----------- | ----------- | -| `SIGNATURE` | SIGNATURE | \ No newline at end of file +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/documentcreatetypetext1.md b/docs/models/documentcreatetypetext1.md new file mode 100644 index 0000000..fb12280 --- /dev/null +++ b/docs/models/documentcreatetypetext1.md @@ -0,0 +1,8 @@ +# DocumentCreateTypeText1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | TEXT | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidtypetext.md b/docs/models/documentcreatetypetext2.md similarity index 61% rename from docs/models/documentgetdocumentwithdetailsbyidtypetext.md rename to docs/models/documentcreatetypetext2.md index a14aa20..bd22482 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidtypetext.md +++ b/docs/models/documentcreatetypetext2.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDTypeText +# DocumentCreateTypeText2 ## Values diff --git a/docs/models/documentcreateunauthorizederror.md b/docs/models/documentcreateunauthorizederror.md new file mode 100644 index 0000000..dfa7549 --- /dev/null +++ b/docs/models/documentcreateunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentCreateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentCreateUnauthorizedIssue](../models/documentcreateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentcreateunauthorizedissue.md b/docs/models/documentcreateunauthorizedissue.md new file mode 100644 index 0000000..bd36fff --- /dev/null +++ b/docs/models/documentcreateunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentCreateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidvalue1.md b/docs/models/documentcreatevaluecheckbox.md similarity index 91% rename from docs/models/documentgetdocumentwithdetailsbyidvalue1.md rename to docs/models/documentcreatevaluecheckbox.md index 721e323..10edf94 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidvalue1.md +++ b/docs/models/documentcreatevaluecheckbox.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDValue1 +# DocumentCreateValueCheckbox ## Fields diff --git a/docs/models/documentgetdocumentwithdetailsbyidvalue3.md b/docs/models/documentcreatevaluedropdown.md similarity index 86% rename from docs/models/documentgetdocumentwithdetailsbyidvalue3.md rename to docs/models/documentcreatevaluedropdown.md index 75a5ef7..ef586f8 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidvalue3.md +++ b/docs/models/documentcreatevaluedropdown.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDValue3 +# DocumentCreateValueDropdown ## Fields diff --git a/docs/models/documentgetdocumentwithdetailsbyidvalue2.md b/docs/models/documentcreatevalueradio.md similarity index 91% rename from docs/models/documentgetdocumentwithdetailsbyidvalue2.md rename to docs/models/documentcreatevalueradio.md index a207698..10ffdd5 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidvalue2.md +++ b/docs/models/documentcreatevalueradio.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDValue2 +# DocumentCreateValueRadio ## Fields diff --git a/docs/models/documentcreateverticalalignnumber.md b/docs/models/documentcreateverticalalignnumber.md new file mode 100644 index 0000000..08fb0cb --- /dev/null +++ b/docs/models/documentcreateverticalalignnumber.md @@ -0,0 +1,10 @@ +# DocumentCreateVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/documentcreateverticalaligntext.md b/docs/models/documentcreateverticalaligntext.md new file mode 100644 index 0000000..2c9d3c7 --- /dev/null +++ b/docs/models/documentcreateverticalaligntext.md @@ -0,0 +1,10 @@ +# DocumentCreateVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/documentsenddocumentvisibility.md b/docs/models/documentcreatevisibility.md similarity index 88% rename from docs/models/documentsenddocumentvisibility.md rename to docs/models/documentcreatevisibility.md index 72c1a40..8b55387 100644 --- a/docs/models/documentsenddocumentvisibility.md +++ b/docs/models/documentcreatevisibility.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentVisibility +# DocumentCreateVisibility ## Values 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/documentdeletebadrequestissue.md b/docs/models/documentdeletebadrequestissue.md new file mode 100644 index 0000000..4fb2858 --- /dev/null +++ b/docs/models/documentdeletebadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentDeleteBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdeleteforbiddenerror.md b/docs/models/documentdeleteforbiddenerror.md new file mode 100644 index 0000000..d3548c4 --- /dev/null +++ b/docs/models/documentdeleteforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentDeleteForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDeleteForbiddenIssue](../models/documentdeleteforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdeleteforbiddenissue.md b/docs/models/documentdeleteforbiddenissue.md new file mode 100644 index 0000000..9dd5218 --- /dev/null +++ b/docs/models/documentdeleteforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentDeleteForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | 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/documentdeleteinternalservererrorissue.md b/docs/models/documentdeleteinternalservererrorissue.md new file mode 100644 index 0000000..a8de16e --- /dev/null +++ b/docs/models/documentdeleteinternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentDeleteInternalServerErrorIssue + + +## 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/documentdeleterequest.md similarity index 88% rename from docs/models/documentduplicatedocumentrequest.md rename to docs/models/documentdeleterequest.md index be9b08c..588f8d5 100644 --- a/docs/models/documentduplicatedocumentrequest.md +++ b/docs/models/documentdeleterequest.md @@ -1,4 +1,4 @@ -# DocumentDuplicateDocumentRequest +# DocumentDeleteRequest ## Fields diff --git a/docs/models/documentdeletedocumentresponse.md b/docs/models/documentdeleteresponse.md similarity index 89% rename from docs/models/documentdeletedocumentresponse.md rename to docs/models/documentdeleteresponse.md index f61a0d7..a63ad32 100644 --- a/docs/models/documentdeletedocumentresponse.md +++ b/docs/models/documentdeleteresponse.md @@ -1,4 +1,4 @@ -# DocumentDeleteDocumentResponse +# DocumentDeleteResponse Successful response diff --git a/docs/models/documentdeleteunauthorizederror.md b/docs/models/documentdeleteunauthorizederror.md new file mode 100644 index 0000000..8dfd9ac --- /dev/null +++ b/docs/models/documentdeleteunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentDeleteUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDeleteUnauthorizedIssue](../models/documentdeleteunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdeleteunauthorizedissue.md b/docs/models/documentdeleteunauthorizedissue.md new file mode 100644 index 0000000..4a1d955 --- /dev/null +++ b/docs/models/documentdeleteunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentDeleteUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdirection1.md b/docs/models/documentdirection1.md new file mode 100644 index 0000000..4e036fe --- /dev/null +++ b/docs/models/documentdirection1.md @@ -0,0 +1,9 @@ +# DocumentDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentdirection2.md b/docs/models/documentdirection2.md new file mode 100644 index 0000000..77968f5 --- /dev/null +++ b/docs/models/documentdirection2.md @@ -0,0 +1,9 @@ +# DocumentDirection2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentdistributeauthoptions.md b/docs/models/documentdistributeauthoptions.md new file mode 100644 index 0000000..450e451 --- /dev/null +++ b/docs/models/documentdistributeauthoptions.md @@ -0,0 +1,9 @@ +# DocumentDistributeAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `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/documentdistributebadrequestissue.md b/docs/models/documentdistributebadrequestissue.md new file mode 100644 index 0000000..3d78574 --- /dev/null +++ b/docs/models/documentdistributebadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentDistributeBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdistributedateformat.md b/docs/models/documentdistributedateformat.md new file mode 100644 index 0000000..675977b --- /dev/null +++ b/docs/models/documentdistributedateformat.md @@ -0,0 +1,29 @@ +# DocumentDistributeDateFormat + + +## 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/documentdistributedistributionmethod.md b/docs/models/documentdistributedistributionmethod.md new file mode 100644 index 0000000..7a1d12d --- /dev/null +++ b/docs/models/documentdistributedistributionmethod.md @@ -0,0 +1,9 @@ +# DocumentDistributeDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/documentdistributeemailsettings.md b/docs/models/documentdistributeemailsettings.md new file mode 100644 index 0000000..31549d6 --- /dev/null +++ b/docs/models/documentdistributeemailsettings.md @@ -0,0 +1,14 @@ +# DocumentDistributeEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdistributeforbiddenerror.md b/docs/models/documentdistributeforbiddenerror.md new file mode 100644 index 0000000..94e050d --- /dev/null +++ b/docs/models/documentdistributeforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentDistributeForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDistributeForbiddenIssue](../models/documentdistributeforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdistributeforbiddenissue.md b/docs/models/documentdistributeforbiddenissue.md new file mode 100644 index 0000000..440c6fd --- /dev/null +++ b/docs/models/documentdistributeforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentDistributeForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsformvalues.md b/docs/models/documentdistributeformvalues.md similarity index 85% rename from docs/models/documentfinddocumentsformvalues.md rename to docs/models/documentdistributeformvalues.md index 0e5e789..b0d8f63 100644 --- a/docs/models/documentfinddocumentsformvalues.md +++ b/docs/models/documentdistributeformvalues.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsFormValues +# DocumentDistributeFormValues ## Supported Types diff --git a/docs/models/documentdistributeglobalaccessauth.md b/docs/models/documentdistributeglobalaccessauth.md new file mode 100644 index 0000000..ef0951c --- /dev/null +++ b/docs/models/documentdistributeglobalaccessauth.md @@ -0,0 +1,9 @@ +# DocumentDistributeGlobalAccessAuth + + +## 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/documentdistributeglobalactionauth.md similarity index 60% rename from docs/models/documentfinddocumentsglobalactionauth.md rename to docs/models/documentdistributeglobalactionauth.md index acbc433..62d92c6 100644 --- a/docs/models/documentfinddocumentsglobalactionauth.md +++ b/docs/models/documentdistributeglobalactionauth.md @@ -1,6 +1,4 @@ -# DocumentFindDocumentsGlobalActionAuth - -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. +# DocumentDistributeGlobalActionAuth ## Values diff --git a/docs/models/documentdistributeinternalservererror.md b/docs/models/documentdistributeinternalservererror.md new file mode 100644 index 0000000..6d30ecd --- /dev/null +++ b/docs/models/documentdistributeinternalservererror.md @@ -0,0 +1,12 @@ +# 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.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/documentupdatedocumentlanguage.md b/docs/models/documentdistributelanguage.md similarity index 61% rename from docs/models/documentupdatedocumentlanguage.md rename to docs/models/documentdistributelanguage.md index 41ddc89..670b7c3 100644 --- a/docs/models/documentupdatedocumentlanguage.md +++ b/docs/models/documentdistributelanguage.md @@ -1,6 +1,4 @@ -# DocumentUpdateDocumentLanguage - -The language to use for email communications with recipients. +# DocumentDistributeLanguage ## Values diff --git a/docs/models/documentdistributemeta.md b/docs/models/documentdistributemeta.md new file mode 100644 index 0000000..24845e1 --- /dev/null +++ b/docs/models/documentdistributemeta.md @@ -0,0 +1,17 @@ +# DocumentDistributeMeta + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.DocumentDistributeDateFormat]](../models/documentdistributedateformat.md) | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.DocumentDistributeDistributionMethod]](../models/documentdistributedistributionmethod.md) | :heavy_minus_sign: | N/A | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `language` | [Optional[models.DocumentDistributeLanguage]](../models/documentdistributelanguage.md) | :heavy_minus_sign: | N/A | +| `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..7a9275a --- /dev/null +++ b/docs/models/documentdistributerequest.md @@ -0,0 +1,9 @@ +# DocumentDistributeRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `document_id` | *float* | :heavy_check_mark: | N/A | +| `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..10a2b4e --- /dev/null +++ b/docs/models/documentdistributeresponse.md @@ -0,0 +1,29 @@ +# 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: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `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 | +| `internal_version` | *float* | :heavy_check_mark: | N/A | +| `document_data_id` | *Optional[str]* | :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/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/documentdistributeunauthorizederror.md b/docs/models/documentdistributeunauthorizederror.md new file mode 100644 index 0000000..99a6782 --- /dev/null +++ b/docs/models/documentdistributeunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentDistributeUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDistributeUnauthorizedIssue](../models/documentdistributeunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdistributeunauthorizedissue.md b/docs/models/documentdistributeunauthorizedissue.md new file mode 100644 index 0000000..bfafcc4 --- /dev/null +++ b/docs/models/documentdistributeunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentDistributeUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsvisibility.md b/docs/models/documentdistributevisibility.md similarity index 87% rename from docs/models/documentfinddocumentsvisibility.md rename to docs/models/documentdistributevisibility.md index 373908d..de1aa72 100644 --- a/docs/models/documentfinddocumentsvisibility.md +++ b/docs/models/documentdistributevisibility.md @@ -1,4 +1,4 @@ -# DocumentFindDocumentsVisibility +# 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/documentdownloadbadrequestissue.md b/docs/models/documentdownloadbadrequestissue.md new file mode 100644 index 0000000..8af3567 --- /dev/null +++ b/docs/models/documentdownloadbadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentDownloadBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentbadrequesterror.md b/docs/models/documentdownloadbetabadrequesterror.md similarity index 92% rename from docs/models/documentsenddocumentbadrequesterror.md rename to docs/models/documentdownloadbetabadrequesterror.md index e054b88..a70fb23 100644 --- a/docs/models/documentsenddocumentbadrequesterror.md +++ b/docs/models/documentdownloadbetabadrequesterror.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentBadRequestError +# DocumentDownloadBetaBadRequestError 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.DocumentDownloadBetaBadRequestIssue](../models/documentdownloadbetabadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadbetabadrequestissue.md b/docs/models/documentdownloadbetabadrequestissue.md new file mode 100644 index 0000000..da55b19 --- /dev/null +++ b/docs/models/documentdownloadbetabadrequestissue.md @@ -0,0 +1,8 @@ +# DocumentDownloadBetaBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadbetaforbiddenerror.md b/docs/models/documentdownloadbetaforbiddenerror.md new file mode 100644 index 0000000..c3310d1 --- /dev/null +++ b/docs/models/documentdownloadbetaforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentDownloadBetaForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDownloadBetaForbiddenIssue](../models/documentdownloadbetaforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadbetaforbiddenissue.md b/docs/models/documentdownloadbetaforbiddenissue.md new file mode 100644 index 0000000..2b03a78 --- /dev/null +++ b/docs/models/documentdownloadbetaforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentDownloadBetaForbiddenIssue + + +## 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/documentdownloadbetainternalservererror.md similarity index 93% rename from docs/models/documentsenddocumentinternalservererror.md rename to docs/models/documentdownloadbetainternalservererror.md index 6fb4300..fae77ae 100644 --- a/docs/models/documentsenddocumentinternalservererror.md +++ b/docs/models/documentdownloadbetainternalservererror.md @@ -1,4 +1,4 @@ -# DocumentSendDocumentInternalServerError +# DocumentDownloadBetaInternalServerError 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.DocumentDownloadBetaInternalServerErrorIssue](../models/documentdownloadbetainternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadbetainternalservererrorissue.md b/docs/models/documentdownloadbetainternalservererrorissue.md new file mode 100644 index 0000000..1bbf518 --- /dev/null +++ b/docs/models/documentdownloadbetainternalservererrorissue.md @@ -0,0 +1,8 @@ +# DocumentDownloadBetaInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadbetanotfounderror.md b/docs/models/documentdownloadbetanotfounderror.md new file mode 100644 index 0000000..bef615d --- /dev/null +++ b/docs/models/documentdownloadbetanotfounderror.md @@ -0,0 +1,12 @@ +# DocumentDownloadBetaNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDownloadBetaNotFoundIssue](../models/documentdownloadbetanotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadbetanotfoundissue.md b/docs/models/documentdownloadbetanotfoundissue.md new file mode 100644 index 0000000..b1427e3 --- /dev/null +++ b/docs/models/documentdownloadbetanotfoundissue.md @@ -0,0 +1,8 @@ +# DocumentDownloadBetaNotFoundIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadbetarequest.md b/docs/models/documentdownloadbetarequest.md new file mode 100644 index 0000000..251f4fe --- /dev/null +++ b/docs/models/documentdownloadbetarequest.md @@ -0,0 +1,9 @@ +# DocumentDownloadBetaRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | The ID of the document to download. | +| `version` | [Optional[models.DocumentDownloadBetaVersion]](../models/documentdownloadbetaversion.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/documentdownloadbetaresponse.md b/docs/models/documentdownloadbetaresponse.md new file mode 100644 index 0000000..051edac --- /dev/null +++ b/docs/models/documentdownloadbetaresponse.md @@ -0,0 +1,12 @@ +# DocumentDownloadBetaResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `download_url` | *str* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentresenddocumentbadrequesterror.md b/docs/models/documentdownloadbetaunauthorizederror.md similarity index 91% rename from docs/models/documentresenddocumentbadrequesterror.md rename to docs/models/documentdownloadbetaunauthorizederror.md index b308703..bdc140c 100644 --- a/docs/models/documentresenddocumentbadrequesterror.md +++ b/docs/models/documentdownloadbetaunauthorizederror.md @@ -1,6 +1,6 @@ -# DocumentResendDocumentBadRequestError +# DocumentDownloadBetaUnauthorizedError -Invalid input data +Authorization not provided ## 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.DocumentResendDocumentBadRequestIssue](../models/documentresenddocumentbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.DocumentDownloadBetaUnauthorizedIssue](../models/documentdownloadbetaunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadbetaunauthorizedissue.md b/docs/models/documentdownloadbetaunauthorizedissue.md new file mode 100644 index 0000000..4aeb522 --- /dev/null +++ b/docs/models/documentdownloadbetaunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentDownloadBetaUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadbetaversion.md b/docs/models/documentdownloadbetaversion.md new file mode 100644 index 0000000..dd93a68 --- /dev/null +++ b/docs/models/documentdownloadbetaversion.md @@ -0,0 +1,11 @@ +# DocumentDownloadBetaVersion + +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/models/documentdownloadforbiddenerror.md b/docs/models/documentdownloadforbiddenerror.md new file mode 100644 index 0000000..1dfdce3 --- /dev/null +++ b/docs/models/documentdownloadforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentDownloadForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDownloadForbiddenIssue](../models/documentdownloadforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadforbiddenissue.md b/docs/models/documentdownloadforbiddenissue.md new file mode 100644 index 0000000..a0da1a4 --- /dev/null +++ b/docs/models/documentdownloadforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentDownloadForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file 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/documentdownloadnotfoundissue.md b/docs/models/documentdownloadnotfoundissue.md new file mode 100644 index 0000000..6389b5d --- /dev/null +++ b/docs/models/documentdownloadnotfoundissue.md @@ -0,0 +1,8 @@ +# DocumentDownloadNotFoundIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadrequest.md b/docs/models/documentdownloadrequest.md new file mode 100644 index 0000000..bf0f95f --- /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.DocumentDownloadVersion]](../models/documentdownloadversion.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..875d138 --- /dev/null +++ b/docs/models/documentdownloadresponse.md @@ -0,0 +1,9 @@ +# DocumentDownloadResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------- | ---------------------- | ---------------------- | ---------------------- | +| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | +| `result` | *Any* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadunauthorizederror.md b/docs/models/documentdownloadunauthorizederror.md new file mode 100644 index 0000000..9f8b00c --- /dev/null +++ b/docs/models/documentdownloadunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentDownloadUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDownloadUnauthorizedIssue](../models/documentdownloadunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadunauthorizedissue.md b/docs/models/documentdownloadunauthorizedissue.md new file mode 100644 index 0000000..52d72b3 --- /dev/null +++ b/docs/models/documentdownloadunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentDownloadUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentdownloadversion.md b/docs/models/documentdownloadversion.md new file mode 100644 index 0000000..5de220e --- /dev/null +++ b/docs/models/documentdownloadversion.md @@ -0,0 +1,11 @@ +# DocumentDownloadVersion + +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/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/documentduplicateforbiddenerror.md b/docs/models/documentduplicateforbiddenerror.md new file mode 100644 index 0000000..f3dbd02 --- /dev/null +++ b/docs/models/documentduplicateforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentDuplicateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDuplicateForbiddenIssue](../models/documentduplicateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicateforbiddenissue.md b/docs/models/documentduplicateforbiddenissue.md new file mode 100644 index 0000000..2bd5f29 --- /dev/null +++ b/docs/models/documentduplicateforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentDuplicateForbiddenIssue + + +## 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/documentduplicatedocumentresponse.md b/docs/models/documentduplicaterequest.md similarity index 82% rename from docs/models/documentduplicatedocumentresponse.md rename to docs/models/documentduplicaterequest.md index 468c3e1..802c14d 100644 --- a/docs/models/documentduplicatedocumentresponse.md +++ b/docs/models/documentduplicaterequest.md @@ -1,6 +1,4 @@ -# DocumentDuplicateDocumentResponse - -Successful response +# DocumentDuplicateRequest ## Fields diff --git a/docs/models/documentduplicateresponse.md b/docs/models/documentduplicateresponse.md new file mode 100644 index 0000000..e1fe43f --- /dev/null +++ b/docs/models/documentduplicateresponse.md @@ -0,0 +1,11 @@ +# DocumentDuplicateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `document_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicateunauthorizederror.md b/docs/models/documentduplicateunauthorizederror.md new file mode 100644 index 0000000..4f494fb --- /dev/null +++ b/docs/models/documentduplicateunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentDuplicateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentDuplicateUnauthorizedIssue](../models/documentduplicateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicateunauthorizedissue.md b/docs/models/documentduplicateunauthorizedissue.md new file mode 100644 index 0000000..3fe1b4a --- /dev/null +++ b/docs/models/documentduplicateunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentDuplicateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentemailsettings.md b/docs/models/documentemailsettings.md index a734fee..bd0101c 100644 --- a/docs/models/documentemailsettings.md +++ b/docs/models/documentemailsettings.md @@ -3,12 +3,12 @@ ## 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 +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfield.md b/docs/models/documentfield.md index 8c124b0..3b64659 100644 --- a/docs/models/documentfield.md +++ b/docs/models/documentfield.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/documentfieldmetaunion.md b/docs/models/documentfieldmetaunion.md index ae9936b..bb91d5c 100644 --- a/docs/models/documentfieldmetaunion.md +++ b/docs/models/documentfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldMetaDocumentSignature` + +```python +value: models.FieldMetaDocumentSignature = /* values here */ +``` + ### `models.FieldMetaDocumentInitials` ```python diff --git a/docs/models/documentfindaccessauth.md b/docs/models/documentfindaccessauth.md new file mode 100644 index 0000000..f61b3bd --- /dev/null +++ b/docs/models/documentfindaccessauth.md @@ -0,0 +1,9 @@ +# DocumentFindAccessAuth + + +## 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/documentfindactionauth.md similarity index 71% rename from docs/models/documentgetdocumentwithdetailsbyidactionauth.md rename to docs/models/documentfindactionauth.md index 1a28804..414c8a4 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidactionauth.md +++ b/docs/models/documentfindactionauth.md @@ -1,6 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDActionAuth - -The type of authentication required for the recipient to sign the document. +# DocumentFindActionAuth ## Values diff --git a/docs/models/documentfindauthoptions.md b/docs/models/documentfindauthoptions.md new file mode 100644 index 0000000..7cceb5b --- /dev/null +++ b/docs/models/documentfindauthoptions.md @@ -0,0 +1,9 @@ +# DocumentFindAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `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..916ef4a --- /dev/null +++ b/docs/models/documentfinddata.md @@ -0,0 +1,30 @@ +# 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: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `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 | +| `internal_version` | *float* | :heavy_check_mark: | N/A | +| `document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `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/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/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/documentfindforbiddenerror.md b/docs/models/documentfindforbiddenerror.md new file mode 100644 index 0000000..6dca5a6 --- /dev/null +++ b/docs/models/documentfindforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentFindForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentFindForbiddenIssue](../models/documentfindforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfindforbiddenissue.md b/docs/models/documentfindforbiddenissue.md new file mode 100644 index 0000000..e8894ad --- /dev/null +++ b/docs/models/documentfindforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentFindForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentformvalues.md b/docs/models/documentfindformvalues.md similarity index 85% rename from docs/models/documentupdatedocumentformvalues.md rename to docs/models/documentfindformvalues.md index 032d30c..c386ebb 100644 --- a/docs/models/documentupdatedocumentformvalues.md +++ b/docs/models/documentfindformvalues.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentFormValues +# DocumentFindFormValues ## Supported Types diff --git a/docs/models/documentfindglobalaccessauth.md b/docs/models/documentfindglobalaccessauth.md new file mode 100644 index 0000000..754d615 --- /dev/null +++ b/docs/models/documentfindglobalaccessauth.md @@ -0,0 +1,9 @@ +# DocumentFindGlobalAccessAuth + + +## 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/documentfindglobalactionauth.md similarity index 59% rename from docs/models/documentupdatedocumentglobalactionauthrequest.md rename to docs/models/documentfindglobalactionauth.md index 3d25c65..bbf9c78 100644 --- a/docs/models/documentupdatedocumentglobalactionauthrequest.md +++ b/docs/models/documentfindglobalactionauth.md @@ -1,6 +1,4 @@ -# DocumentUpdateDocumentGlobalActionAuthRequest - -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. +# DocumentFindGlobalActionAuth ## Values 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/documentfinddocumentsdata.md b/docs/models/documentfindrecipient.md similarity index 63% rename from docs/models/documentfinddocumentsdata.md rename to docs/models/documentfindrecipient.md index 21b8d3b..d66f0c8 100644 --- a/docs/models/documentfinddocumentsdata.md +++ b/docs/models/documentfindrecipient.md @@ -1,28 +1,24 @@ -# DocumentFindDocumentsData +# DocumentFindRecipient ## 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 | +| `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 | -| `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 +| `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: | N/A | +| `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..cdf4a40 --- /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: | N/A | +| `current_page` | *float* | :heavy_check_mark: | N/A | +| `per_page` | *float* | :heavy_check_mark: | N/A | +| `total_pages` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidrole.md b/docs/models/documentfindrole.md similarity index 84% rename from docs/models/documentgetdocumentwithdetailsbyidrole.md rename to docs/models/documentfindrole.md index e2a2a18..fe63314 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidrole.md +++ b/docs/models/documentfindrole.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDRole +# 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/documentfindunauthorizederror.md b/docs/models/documentfindunauthorizederror.md new file mode 100644 index 0000000..60d8d30 --- /dev/null +++ b/docs/models/documentfindunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentFindUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentFindUnauthorizedIssue](../models/documentfindunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentfindunauthorizedissue.md b/docs/models/documentfindunauthorizedissue.md new file mode 100644 index 0000000..f6b99da --- /dev/null +++ b/docs/models/documentfindunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentFindUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file 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/templateupdatetemplatevisibilityrequest.md b/docs/models/documentfindvisibility.md similarity index 85% rename from docs/models/templateupdatetemplatevisibilityrequest.md rename to docs/models/documentfindvisibility.md index da81e44..6b3ae8d 100644 --- a/docs/models/templateupdatetemplatevisibilityrequest.md +++ b/docs/models/documentfindvisibility.md @@ -1,4 +1,4 @@ -# TemplateUpdateTemplateVisibilityRequest +# DocumentFindVisibility ## Values diff --git a/docs/models/documentgetaccessauth.md b/docs/models/documentgetaccessauth.md new file mode 100644 index 0000000..26dd994 --- /dev/null +++ b/docs/models/documentgetaccessauth.md @@ -0,0 +1,9 @@ +# DocumentGetAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentgetactionauth.md b/docs/models/documentgetactionauth.md new file mode 100644 index 0000000..cff6ac5 --- /dev/null +++ b/docs/models/documentgetactionauth.md @@ -0,0 +1,12 @@ +# DocumentGetActionAuth + + +## 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/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/documentgetbadrequesterror.md b/docs/models/documentgetbadrequesterror.md new file mode 100644 index 0000000..7a2802b --- /dev/null +++ b/docs/models/documentgetbadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentGetBadRequestError + +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.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/documentgetdirection1.md b/docs/models/documentgetdirection1.md new file mode 100644 index 0000000..ac766c6 --- /dev/null +++ b/docs/models/documentgetdirection1.md @@ -0,0 +1,9 @@ +# DocumentGetDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentgetdirection2.md b/docs/models/documentgetdirection2.md new file mode 100644 index 0000000..9cac16f --- /dev/null +++ b/docs/models/documentgetdirection2.md @@ -0,0 +1,9 @@ +# DocumentGetDirection2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/documentgetdistributionmethod.md b/docs/models/documentgetdistributionmethod.md new file mode 100644 index 0000000..360c32d --- /dev/null +++ b/docs/models/documentgetdistributionmethod.md @@ -0,0 +1,9 @@ +# DocumentGetDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file 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/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/documentgetdocumentwithdetailsbyidemailsettings.md b/docs/models/documentgetdocumentwithdetailsbyidemailsettings.md deleted file mode 100644 index deefd32..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidemailsettings.md +++ /dev/null @@ -1,14 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDEmailSettings - - -## 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/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/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/documentgetdocumentwithdetailsbyidglobalactionauth.md b/docs/models/documentgetdocumentwithdetailsbyidglobalactionauth.md deleted file mode 100644 index e96885c..0000000 --- a/docs/models/documentgetdocumentwithdetailsbyidglobalactionauth.md +++ /dev/null @@ -1,13 +0,0 @@ -# DocumentGetDocumentWithDetailsByIDGlobalActionAuth - -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/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/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/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/documentgetemailsettings.md b/docs/models/documentgetemailsettings.md new file mode 100644 index 0000000..745ba52 --- /dev/null +++ b/docs/models/documentgetemailsettings.md @@ -0,0 +1,14 @@ +# DocumentGetEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetenvelopeitem.md b/docs/models/documentgetenvelopeitem.md new file mode 100644 index 0000000..c9cd816 --- /dev/null +++ b/docs/models/documentgetenvelopeitem.md @@ -0,0 +1,9 @@ +# DocumentGetEnvelopeItem + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetfield.md b/docs/models/documentgetfield.md new file mode 100644 index 0000000..297c5ee --- /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: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..df77051 --- /dev/null +++ b/docs/models/documentgetfieldmetacheckbox.md @@ -0,0 +1,17 @@ +# 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 | +| `font_size` | *Optional[float]* | :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.DocumentGetDirection2]](../models/documentgetdirection2.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..4f708dd --- /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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeDate](../models/documentgettypedate.md) | :heavy_check_mark: | 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..4ec7bcf --- /dev/null +++ b/docs/models/documentgetfieldmetadropdown.md @@ -0,0 +1,15 @@ +# 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 | +| `font_size` | *Optional[float]* | :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..59f1730 --- /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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeEmail](../models/documentgettypeemail.md) | :heavy_check_mark: | 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..91a62ce --- /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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeInitials](../models/documentgettypeinitials.md) | :heavy_check_mark: | 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..bb2977a --- /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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeName](../models/documentgettypename.md) | :heavy_check_mark: | 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..c4bf89c --- /dev/null +++ b/docs/models/documentgetfieldmetanumber.md @@ -0,0 +1,21 @@ +# 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 | +| `font_size` | *Optional[float]* | :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 | +| `text_align` | [Optional[models.DocumentGetTextAlign6]](../models/documentgettextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.DocumentGetVerticalAlign2]](../models/documentgetverticalalign2.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..3eaefe4 --- /dev/null +++ b/docs/models/documentgetfieldmetaradio.md @@ -0,0 +1,15 @@ +# 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 | +| `font_size` | *Optional[float]* | :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 | +| `direction` | [Optional[models.DocumentGetDirection1]](../models/documentgetdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/prefillfielddropdown.md b/docs/models/documentgetfieldmetasignature.md similarity index 58% rename from docs/models/prefillfielddropdown.md rename to docs/models/documentgetfieldmetasignature.md index 31a904f..f31e6c8 100644 --- a/docs/models/prefillfielddropdown.md +++ b/docs/models/documentgetfieldmetasignature.md @@ -1,11 +1,13 @@ -# PrefillFieldDropdown +# DocumentGetFieldMetaSignature ## Fields | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [models.PrefillFieldTypeDropdown](../models/prefillfieldtypedropdown.md) | :heavy_check_mark: | N/A | | `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file +| `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentGetTypeSignature](../models/documentgettypesignature.md) | :heavy_check_mark: | 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..f6eff25 --- /dev/null +++ b/docs/models/documentgetfieldmetatext.md @@ -0,0 +1,19 @@ +# 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 | +| `font_size` | *Optional[float]* | :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 | +| `text_align` | [Optional[models.DocumentGetTextAlign5]](../models/documentgettextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.DocumentGetVerticalAlign1]](../models/documentgetverticalalign1.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..241328d --- /dev/null +++ b/docs/models/documentgetfieldmetaunion.md @@ -0,0 +1,65 @@ +# DocumentGetFieldMetaUnion + + +## Supported Types + +### `models.DocumentGetFieldMetaSignature` + +```python +value: models.DocumentGetFieldMetaSignature = /* values here */ +``` + +### `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/documentgetforbiddenerror.md b/docs/models/documentgetforbiddenerror.md new file mode 100644 index 0000000..69acd4b --- /dev/null +++ b/docs/models/documentgetforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentGetForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentGetForbiddenIssue](../models/documentgetforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetforbiddenissue.md b/docs/models/documentgetforbiddenissue.md new file mode 100644 index 0000000..bfab163 --- /dev/null +++ b/docs/models/documentgetforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentGetForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/formvaluesrequest.md b/docs/models/documentgetformvalues.md similarity index 89% rename from docs/models/formvaluesrequest.md rename to docs/models/documentgetformvalues.md index 7ebf2de..d62993f 100644 --- a/docs/models/formvaluesrequest.md +++ b/docs/models/documentgetformvalues.md @@ -1,4 +1,4 @@ -# FormValuesRequest +# DocumentGetFormValues ## Supported Types diff --git a/docs/models/documentgetglobalaccessauth.md b/docs/models/documentgetglobalaccessauth.md new file mode 100644 index 0000000..e9e2241 --- /dev/null +++ b/docs/models/documentgetglobalaccessauth.md @@ -0,0 +1,9 @@ +# DocumentGetGlobalAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templateupdatetemplateglobalactionauthrequest.md b/docs/models/documentgetglobalactionauth.md similarity index 59% rename from docs/models/templateupdatetemplateglobalactionauthrequest.md rename to docs/models/documentgetglobalactionauth.md index f1dab4d..c1f97db 100644 --- a/docs/models/templateupdatetemplateglobalactionauthrequest.md +++ b/docs/models/documentgetglobalactionauth.md @@ -1,6 +1,4 @@ -# TemplateUpdateTemplateGlobalActionAuthRequest - -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. +# DocumentGetGlobalActionAuth ## Values 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/documentsenddocumentresponse.md b/docs/models/documentgetrecipient.md similarity index 71% rename from docs/models/documentsenddocumentresponse.md rename to docs/models/documentgetrecipient.md index 2a209e1..0fbc4a9 100644 --- a/docs/models/documentsenddocumentresponse.md +++ b/docs/models/documentgetrecipient.md @@ -1,27 +1,24 @@ -# DocumentSendDocumentResponse - -Successful response +# DocumentGetRecipient ## 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 | +| `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 | -| `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 +| `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: | N/A | +| `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/documentgetrequest.md b/docs/models/documentgetrequest.md new file mode 100644 index 0000000..f6959d8 --- /dev/null +++ b/docs/models/documentgetrequest.md @@ -0,0 +1,8 @@ +# DocumentGetRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `document_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetresponse.md b/docs/models/documentgetresponse.md new file mode 100644 index 0000000..1115fb9 --- /dev/null +++ b/docs/models/documentgetresponse.md @@ -0,0 +1,34 @@ +# 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: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `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 | +| `internal_version` | *float* | :heavy_check_mark: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `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 | +| `envelope_items` | List[[models.DocumentGetEnvelopeItem](../models/documentgetenvelopeitem.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/documentgetrole.md b/docs/models/documentgetrole.md new file mode 100644 index 0000000..ad9427f --- /dev/null +++ b/docs/models/documentgetrole.md @@ -0,0 +1,12 @@ +# DocumentGetRole + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `CC` | CC | +| `SIGNER` | SIGNER | +| `VIEWER` | VIEWER | +| `APPROVER` | APPROVER | +| `ASSISTANT` | ASSISTANT | \ No newline at end of file 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/documentgetdocumentwithdetailsbyidsigningorder.md b/docs/models/documentgetsigningorder.md similarity index 74% rename from docs/models/documentgetdocumentwithdetailsbyidsigningorder.md rename to docs/models/documentgetsigningorder.md index 98dd22d..10f543e 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidsigningorder.md +++ b/docs/models/documentgetsigningorder.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDSigningOrder +# 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/documentgettextalign1.md b/docs/models/documentgettextalign1.md new file mode 100644 index 0000000..4ec28b0 --- /dev/null +++ b/docs/models/documentgettextalign1.md @@ -0,0 +1,10 @@ +# DocumentGetTextAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/documentgettextalign2.md b/docs/models/documentgettextalign2.md new file mode 100644 index 0000000..58feabc --- /dev/null +++ b/docs/models/documentgettextalign2.md @@ -0,0 +1,10 @@ +# DocumentGetTextAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/documentgettextalign3.md b/docs/models/documentgettextalign3.md new file mode 100644 index 0000000..f276fdc --- /dev/null +++ b/docs/models/documentgettextalign3.md @@ -0,0 +1,10 @@ +# DocumentGetTextAlign3 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/documentgettextalign4.md b/docs/models/documentgettextalign4.md new file mode 100644 index 0000000..7199904 --- /dev/null +++ b/docs/models/documentgettextalign4.md @@ -0,0 +1,10 @@ +# DocumentGetTextAlign4 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file 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/prefillfieldtypecheckbox.md b/docs/models/documentgettypecheckbox.md similarity index 78% rename from docs/models/prefillfieldtypecheckbox.md rename to docs/models/documentgettypecheckbox.md index 5785533..1d98f1c 100644 --- a/docs/models/prefillfieldtypecheckbox.md +++ b/docs/models/documentgettypecheckbox.md @@ -1,4 +1,4 @@ -# PrefillFieldTypeCheckbox +# DocumentGetTypeCheckbox ## Values diff --git a/docs/models/prefillfieldtypedate.md b/docs/models/documentgettypedate.md similarity index 75% rename from docs/models/prefillfieldtypedate.md rename to docs/models/documentgettypedate.md index 8315e92..e3d1806 100644 --- a/docs/models/prefillfieldtypedate.md +++ b/docs/models/documentgettypedate.md @@ -1,4 +1,4 @@ -# PrefillFieldTypeDate +# DocumentGetTypeDate ## Values diff --git a/docs/models/prefillfieldtypedropdown.md b/docs/models/documentgettypedropdown.md similarity index 78% rename from docs/models/prefillfieldtypedropdown.md rename to docs/models/documentgettypedropdown.md index ed9ccc8..1e413db 100644 --- a/docs/models/prefillfieldtypedropdown.md +++ b/docs/models/documentgettypedropdown.md @@ -1,4 +1,4 @@ -# PrefillFieldTypeDropdown +# DocumentGetTypeDropdown ## Values diff --git a/docs/models/documentgettypeemail.md b/docs/models/documentgettypeemail.md new file mode 100644 index 0000000..d2605a4 --- /dev/null +++ b/docs/models/documentgettypeemail.md @@ -0,0 +1,8 @@ +# DocumentGetTypeEmail + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | email | \ No newline at end of file diff --git a/docs/models/documentgettypeinitials.md b/docs/models/documentgettypeinitials.md new file mode 100644 index 0000000..b71e258 --- /dev/null +++ b/docs/models/documentgettypeinitials.md @@ -0,0 +1,8 @@ +# DocumentGetTypeInitials + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | initials | \ No newline at end of file diff --git a/docs/models/documentgettypename.md b/docs/models/documentgettypename.md new file mode 100644 index 0000000..f2141b0 --- /dev/null +++ b/docs/models/documentgettypename.md @@ -0,0 +1,8 @@ +# DocumentGetTypeName + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | name | \ No newline at end of file diff --git a/docs/models/prefillfieldtypenumber.md b/docs/models/documentgettypenumber.md similarity index 77% rename from docs/models/prefillfieldtypenumber.md rename to docs/models/documentgettypenumber.md index 59e9f93..e97e248 100644 --- a/docs/models/prefillfieldtypenumber.md +++ b/docs/models/documentgettypenumber.md @@ -1,4 +1,4 @@ -# PrefillFieldTypeNumber +# DocumentGetTypeNumber ## Values diff --git a/docs/models/prefillfieldtyperadio.md b/docs/models/documentgettyperadio.md similarity index 76% rename from docs/models/prefillfieldtyperadio.md rename to docs/models/documentgettyperadio.md index aa1c8cf..c7719d0 100644 --- a/docs/models/prefillfieldtyperadio.md +++ b/docs/models/documentgettyperadio.md @@ -1,4 +1,4 @@ -# PrefillFieldTypeRadio +# DocumentGetTypeRadio ## Values diff --git a/docs/models/documentgettypesignature.md b/docs/models/documentgettypesignature.md new file mode 100644 index 0000000..d19370c --- /dev/null +++ b/docs/models/documentgettypesignature.md @@ -0,0 +1,8 @@ +# DocumentGetTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/prefillfieldtypetext.md b/docs/models/documentgettypetext.md similarity index 75% rename from docs/models/prefillfieldtypetext.md rename to docs/models/documentgettypetext.md index 3e8e7cf..a9a1535 100644 --- a/docs/models/prefillfieldtypetext.md +++ b/docs/models/documentgettypetext.md @@ -1,4 +1,4 @@ -# PrefillFieldTypeText +# DocumentGetTypeText ## Values diff --git a/docs/models/documentgetunauthorizederror.md b/docs/models/documentgetunauthorizederror.md new file mode 100644 index 0000000..3245f7f --- /dev/null +++ b/docs/models/documentgetunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentGetUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentGetUnauthorizedIssue](../models/documentgetunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetunauthorizedissue.md b/docs/models/documentgetunauthorizedissue.md new file mode 100644 index 0000000..7698a40 --- /dev/null +++ b/docs/models/documentgetunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentGetUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetvalue1.md b/docs/models/documentgetvalue1.md new file mode 100644 index 0000000..6e46545 --- /dev/null +++ b/docs/models/documentgetvalue1.md @@ -0,0 +1,10 @@ +# DocumentGetValue1 + + +## 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/documentgetvalue2.md b/docs/models/documentgetvalue2.md new file mode 100644 index 0000000..b670807 --- /dev/null +++ b/docs/models/documentgetvalue2.md @@ -0,0 +1,10 @@ +# DocumentGetValue2 + + +## 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/documentgetvalue3.md b/docs/models/documentgetvalue3.md new file mode 100644 index 0000000..ba0d0ce --- /dev/null +++ b/docs/models/documentgetvalue3.md @@ -0,0 +1,8 @@ +# DocumentGetValue3 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetverticalalign1.md b/docs/models/documentgetverticalalign1.md new file mode 100644 index 0000000..5c706d0 --- /dev/null +++ b/docs/models/documentgetverticalalign1.md @@ -0,0 +1,10 @@ +# DocumentGetVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/documentgetverticalalign2.md b/docs/models/documentgetverticalalign2.md new file mode 100644 index 0000000..5d1a486 --- /dev/null +++ b/docs/models/documentgetverticalalign2.md @@ -0,0 +1,10 @@ +# DocumentGetVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/documentgetvisibility.md b/docs/models/documentgetvisibility.md new file mode 100644 index 0000000..4e16931 --- /dev/null +++ b/docs/models/documentgetvisibility.md @@ -0,0 +1,10 @@ +# DocumentGetVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/documentglobalaccessauth.md b/docs/models/documentglobalaccessauth.md index 6575b4d..f5d36a7 100644 --- a/docs/models/documentglobalaccessauth.md +++ b/docs/models/documentglobalaccessauth.md @@ -1,10 +1,9 @@ # DocumentGlobalAccessAuth -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/documentglobalactionauth.md b/docs/models/documentglobalactionauth.md index 7923b8a..56ee185 100644 --- a/docs/models/documentglobalactionauth.md +++ b/docs/models/documentglobalactionauth.md @@ -1,7 +1,5 @@ # DocumentGlobalActionAuth -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. - ## Values diff --git a/docs/models/documentrecipient.md b/docs/models/documentrecipient.md index 9d10fd6..24d405d 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 | @@ -19,5 +18,7 @@ | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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 +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `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/documentredistributebadrequesterror.md b/docs/models/documentredistributebadrequesterror.md new file mode 100644 index 0000000..d78c4b0 --- /dev/null +++ b/docs/models/documentredistributebadrequesterror.md @@ -0,0 +1,12 @@ +# DocumentRedistributeBadRequestError + +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.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/documentredistributeforbiddenerror.md b/docs/models/documentredistributeforbiddenerror.md new file mode 100644 index 0000000..03afaaf --- /dev/null +++ b/docs/models/documentredistributeforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentRedistributeForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentRedistributeForbiddenIssue](../models/documentredistributeforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentredistributeforbiddenissue.md b/docs/models/documentredistributeforbiddenissue.md new file mode 100644 index 0000000..0be72ce --- /dev/null +++ b/docs/models/documentredistributeforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentRedistributeForbiddenIssue + + +## 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/documentredistributeinternalservererror.md similarity index 60% rename from docs/models/documentgetdocumentwithdetailsbyidrecipientauthoptions.md rename to docs/models/documentredistributeinternalservererror.md index df95a3a..9f7db1a 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidrecipientauthoptions.md +++ b/docs/models/documentredistributeinternalservererror.md @@ -1,9 +1,12 @@ -# DocumentGetDocumentWithDetailsByIDRecipientAuthOptions +# DocumentRedistributeInternalServerError + +Internal server error ## 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 +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `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/documentredistributerequest.md b/docs/models/documentredistributerequest.md new file mode 100644 index 0000000..0f0d15d --- /dev/null +++ b/docs/models/documentredistributerequest.md @@ -0,0 +1,9 @@ +# DocumentRedistributeRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `document_id` | *float* | :heavy_check_mark: | N/A | +| `recipients` | List[*float*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentresenddocumentresponse.md b/docs/models/documentredistributeresponse.md similarity index 89% rename from docs/models/documentresenddocumentresponse.md rename to docs/models/documentredistributeresponse.md index eb4468e..576294c 100644 --- a/docs/models/documentresenddocumentresponse.md +++ b/docs/models/documentredistributeresponse.md @@ -1,4 +1,4 @@ -# DocumentResendDocumentResponse +# DocumentRedistributeResponse Successful response diff --git a/docs/models/documentupdatedocumentbadrequesterror.md b/docs/models/documentredistributeunauthorizederror.md similarity index 91% rename from docs/models/documentupdatedocumentbadrequesterror.md rename to docs/models/documentredistributeunauthorizederror.md index 9a7dd10..66a99a6 100644 --- a/docs/models/documentupdatedocumentbadrequesterror.md +++ b/docs/models/documentredistributeunauthorizederror.md @@ -1,6 +1,6 @@ -# DocumentUpdateDocumentBadRequestError +# DocumentRedistributeUnauthorizedError -Invalid input data +Authorization not provided ## 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.DocumentUpdateDocumentBadRequestIssue](../models/documentupdatedocumentbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.DocumentRedistributeUnauthorizedIssue](../models/documentredistributeunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentredistributeunauthorizedissue.md b/docs/models/documentredistributeunauthorizedissue.md new file mode 100644 index 0000000..9b9eabc --- /dev/null +++ b/docs/models/documentredistributeunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentRedistributeUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | 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/documentresenddocumentrequest.md b/docs/models/documentresenddocumentrequest.md deleted file mode 100644 index bb2aadc..0000000 --- a/docs/models/documentresenddocumentrequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# DocumentResendDocumentRequest - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `document_id` | *float* | :heavy_check_mark: | N/A | -| `recipients` | List[*float*] | :heavy_check_mark: | The IDs of the recipients to redistribute the document to. | \ 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/documentsenddocumentdistributionmethod.md b/docs/models/documentsenddocumentdistributionmethod.md deleted file mode 100644 index 2d28a63..0000000 --- a/docs/models/documentsenddocumentdistributionmethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# DocumentSendDocumentDistributionMethod - -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/documentsenddocumentemailsettings.md b/docs/models/documentsenddocumentemailsettings.md deleted file mode 100644 index 997d62a..0000000 --- a/docs/models/documentsenddocumentemailsettings.md +++ /dev/null @@ -1,14 +0,0 @@ -# DocumentSendDocumentEmailSettings - - -## 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/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/documenttypesignature.md b/docs/models/documenttypesignature.md new file mode 100644 index 0000000..bcb6205 --- /dev/null +++ b/docs/models/documenttypesignature.md @@ -0,0 +1,8 @@ +# DocumentTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ 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..9af9f49 --- /dev/null +++ b/docs/models/documentupdatedata.md @@ -0,0 +1,14 @@ +# DocumentUpdateData + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.DocumentUpdateDataVisibility]](../models/documentupdatedatavisibility.md) | :heavy_minus_sign: | N/A | +| `global_access_auth` | List[[models.DocumentUpdateDataGlobalAccessAuth](../models/documentupdatedataglobalaccessauth.md)] | :heavy_minus_sign: | N/A | +| `global_action_auth` | List[[models.DocumentUpdateDataGlobalActionAuth](../models/documentupdatedataglobalactionauth.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/documentupdatedataglobalaccessauth.md b/docs/models/documentupdatedataglobalaccessauth.md new file mode 100644 index 0000000..21f123a --- /dev/null +++ b/docs/models/documentupdatedataglobalaccessauth.md @@ -0,0 +1,9 @@ +# DocumentUpdateDataGlobalAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentupdatedataglobalactionauth.md b/docs/models/documentupdatedataglobalactionauth.md new file mode 100644 index 0000000..7667a8c --- /dev/null +++ b/docs/models/documentupdatedataglobalactionauth.md @@ -0,0 +1,11 @@ +# DocumentUpdateDataGlobalActionAuth + + +## 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/documentupdatedatavisibility.md b/docs/models/documentupdatedatavisibility.md new file mode 100644 index 0000000..cf02d2b --- /dev/null +++ b/docs/models/documentupdatedatavisibility.md @@ -0,0 +1,10 @@ +# DocumentUpdateDataVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/documentupdatedateformat.md b/docs/models/documentupdatedateformat.md new file mode 100644 index 0000000..7ec3dca --- /dev/null +++ b/docs/models/documentupdatedateformat.md @@ -0,0 +1,29 @@ +# DocumentUpdateDateFormat + + +## 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/documentupdatedistributionmethod.md b/docs/models/documentupdatedistributionmethod.md new file mode 100644 index 0000000..5d2902f --- /dev/null +++ b/docs/models/documentupdatedistributionmethod.md @@ -0,0 +1,9 @@ +# DocumentUpdateDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ 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/documentupdatedocumentdistributionmethod.md b/docs/models/documentupdatedocumentdistributionmethod.md deleted file mode 100644 index 2c7158f..0000000 --- a/docs/models/documentupdatedocumentdistributionmethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# DocumentUpdateDocumentDistributionMethod - -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/documentupdatedocumentemailsettings.md b/docs/models/documentupdatedocumentemailsettings.md deleted file mode 100644 index c27f020..0000000 --- a/docs/models/documentupdatedocumentemailsettings.md +++ /dev/null @@ -1,14 +0,0 @@ -# DocumentUpdateDocumentEmailSettings - - -## 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/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/documentupdatedocumentglobalactionauthresponse.md b/docs/models/documentupdatedocumentglobalactionauthresponse.md deleted file mode 100644 index 52b8794..0000000 --- a/docs/models/documentupdatedocumentglobalactionauthresponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# DocumentUpdateDocumentGlobalActionAuthResponse - -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/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/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/documentupdatedocumentvisibilityrequest.md b/docs/models/documentupdatedocumentvisibilityrequest.md deleted file mode 100644 index 7b31c26..0000000 --- a/docs/models/documentupdatedocumentvisibilityrequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# DocumentUpdateDocumentVisibilityRequest - -The visibility of the document. - - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `EVERYONE` | EVERYONE | -| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | -| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/documentupdateemailsettings.md b/docs/models/documentupdateemailsettings.md new file mode 100644 index 0000000..23377c2 --- /dev/null +++ b/docs/models/documentupdateemailsettings.md @@ -0,0 +1,14 @@ +# DocumentUpdateEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdateforbiddenerror.md b/docs/models/documentupdateforbiddenerror.md new file mode 100644 index 0000000..960477a --- /dev/null +++ b/docs/models/documentupdateforbiddenerror.md @@ -0,0 +1,12 @@ +# DocumentUpdateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentUpdateForbiddenIssue](../models/documentupdateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdateforbiddenissue.md b/docs/models/documentupdateforbiddenissue.md new file mode 100644 index 0000000..34c8300 --- /dev/null +++ b/docs/models/documentupdateforbiddenissue.md @@ -0,0 +1,8 @@ +# DocumentUpdateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdateformvalues.md b/docs/models/documentupdateformvalues.md new file mode 100644 index 0000000..4cf4117 --- /dev/null +++ b/docs/models/documentupdateformvalues.md @@ -0,0 +1,23 @@ +# DocumentUpdateFormValues + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `bool` + +```python +value: bool = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/documentupdateglobalaccessauthresponse.md b/docs/models/documentupdateglobalaccessauthresponse.md new file mode 100644 index 0000000..7b43836 --- /dev/null +++ b/docs/models/documentupdateglobalaccessauthresponse.md @@ -0,0 +1,9 @@ +# DocumentUpdateGlobalAccessAuthResponse + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/documentupdateglobalactionauthresponse.md b/docs/models/documentupdateglobalactionauthresponse.md new file mode 100644 index 0000000..c3cef3f --- /dev/null +++ b/docs/models/documentupdateglobalactionauthresponse.md @@ -0,0 +1,11 @@ +# DocumentUpdateGlobalActionAuthResponse + + +## 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/documentupdatelanguage.md b/docs/models/documentupdatelanguage.md new file mode 100644 index 0000000..cf82c7c --- /dev/null +++ b/docs/models/documentupdatelanguage.md @@ -0,0 +1,13 @@ +# DocumentUpdateLanguage + + +## 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/documentupdatemeta.md b/docs/models/documentupdatemeta.md new file mode 100644 index 0000000..143692a --- /dev/null +++ b/docs/models/documentupdatemeta.md @@ -0,0 +1,22 @@ +# DocumentUpdateMeta + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.DocumentUpdateDateFormat]](../models/documentupdatedateformat.md) | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.DocumentUpdateDistributionMethod]](../models/documentupdatedistributionmethod.md) | :heavy_minus_sign: | N/A | +| `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: | N/A | +| `language` | [Optional[models.DocumentUpdateLanguage]](../models/documentupdatelanguage.md) | :heavy_minus_sign: | N/A | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `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..ecc8594 --- /dev/null +++ b/docs/models/documentupdateresponse.md @@ -0,0 +1,29 @@ +# 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: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `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 | +| `internal_version` | *float* | :heavy_check_mark: | N/A | +| `document_data_id` | *Optional[str]* | :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/documentupdatesigningorder.md b/docs/models/documentupdatesigningorder.md new file mode 100644 index 0000000..7c2d794 --- /dev/null +++ b/docs/models/documentupdatesigningorder.md @@ -0,0 +1,9 @@ +# DocumentUpdateSigningOrder + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `PARALLEL` | PARALLEL | +| `SEQUENTIAL` | SEQUENTIAL | \ No newline at end of file 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/documentupdateunauthorizederror.md b/docs/models/documentupdateunauthorizederror.md new file mode 100644 index 0000000..bb351c8 --- /dev/null +++ b/docs/models/documentupdateunauthorizederror.md @@ -0,0 +1,12 @@ +# DocumentUpdateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.DocumentUpdateUnauthorizedIssue](../models/documentupdateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdateunauthorizedissue.md b/docs/models/documentupdateunauthorizedissue.md new file mode 100644 index 0000000..f684321 --- /dev/null +++ b/docs/models/documentupdateunauthorizedissue.md @@ -0,0 +1,8 @@ +# DocumentUpdateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file 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/documentverticalalign1.md b/docs/models/documentverticalalign1.md new file mode 100644 index 0000000..cbdb3aa --- /dev/null +++ b/docs/models/documentverticalalign1.md @@ -0,0 +1,10 @@ +# DocumentVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/documentverticalalign2.md b/docs/models/documentverticalalign2.md new file mode 100644 index 0000000..e40b6eb --- /dev/null +++ b/docs/models/documentverticalalign2.md @@ -0,0 +1,10 @@ +# DocumentVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/embeddingpresigncreateembeddingpresigntokenforbiddenerror.md b/docs/models/embeddingpresigncreateembeddingpresigntokenforbiddenerror.md new file mode 100644 index 0000000..d607fba --- /dev/null +++ b/docs/models/embeddingpresigncreateembeddingpresigntokenforbiddenerror.md @@ -0,0 +1,12 @@ +# EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssue](../models/embeddingpresigncreateembeddingpresigntokenforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/embeddingpresigncreateembeddingpresigntokenforbiddenissue.md b/docs/models/embeddingpresigncreateembeddingpresigntokenforbiddenissue.md new file mode 100644 index 0000000..456bfa4 --- /dev/null +++ b/docs/models/embeddingpresigncreateembeddingpresigntokenforbiddenissue.md @@ -0,0 +1,8 @@ +# EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/embeddingpresigncreateembeddingpresigntokenrequest.md b/docs/models/embeddingpresigncreateembeddingpresigntokenrequest.md index b990d89..0a41046 100644 --- a/docs/models/embeddingpresigncreateembeddingpresigntokenrequest.md +++ b/docs/models/embeddingpresigncreateembeddingpresigntokenrequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `expires_in` | *Optional[float]* | :heavy_minus_sign: | Expiration time in minutes (default: 60, max: 10,080) | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `expires_in` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/embeddingpresigncreateembeddingpresigntokenresponse.md b/docs/models/embeddingpresigncreateembeddingpresigntokenresponse.md index 1f2fc02..e8a5a60 100644 --- a/docs/models/embeddingpresigncreateembeddingpresigntokenresponse.md +++ b/docs/models/embeddingpresigncreateembeddingpresigntokenresponse.md @@ -5,8 +5,8 @@ Successful response ## Fields -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `token` | *str* | :heavy_check_mark: | N/A | -| `expires_at` | *str* | :heavy_check_mark: | N/A | -| `expires_in` | *float* | :heavy_check_mark: | Expiration time in seconds | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `token` | *str* | :heavy_check_mark: | N/A | +| `expires_at` | *str* | :heavy_check_mark: | N/A | +| `expires_in` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/embeddingpresigncreateembeddingpresigntokenunauthorizederror.md b/docs/models/embeddingpresigncreateembeddingpresigntokenunauthorizederror.md new file mode 100644 index 0000000..8202263 --- /dev/null +++ b/docs/models/embeddingpresigncreateembeddingpresigntokenunauthorizederror.md @@ -0,0 +1,12 @@ +# EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssue](../models/embeddingpresigncreateembeddingpresigntokenunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/embeddingpresigncreateembeddingpresigntokenunauthorizedissue.md b/docs/models/embeddingpresigncreateembeddingpresigntokenunauthorizedissue.md new file mode 100644 index 0000000..c60935f --- /dev/null +++ b/docs/models/embeddingpresigncreateembeddingpresigntokenunauthorizedissue.md @@ -0,0 +1,8 @@ +# EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/embeddingpresignverifyembeddingpresigntokenforbiddenerror.md b/docs/models/embeddingpresignverifyembeddingpresigntokenforbiddenerror.md new file mode 100644 index 0000000..c90944a --- /dev/null +++ b/docs/models/embeddingpresignverifyembeddingpresigntokenforbiddenerror.md @@ -0,0 +1,12 @@ +# EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssue](../models/embeddingpresignverifyembeddingpresigntokenforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/embeddingpresignverifyembeddingpresigntokenforbiddenissue.md b/docs/models/embeddingpresignverifyembeddingpresigntokenforbiddenissue.md new file mode 100644 index 0000000..5cc23cf --- /dev/null +++ b/docs/models/embeddingpresignverifyembeddingpresigntokenforbiddenissue.md @@ -0,0 +1,8 @@ +# EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/embeddingpresignverifyembeddingpresigntokenrequest.md b/docs/models/embeddingpresignverifyembeddingpresigntokenrequest.md index bc254bf..3797dc2 100644 --- a/docs/models/embeddingpresignverifyembeddingpresigntokenrequest.md +++ b/docs/models/embeddingpresignverifyembeddingpresigntokenrequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `token` | *str* | :heavy_check_mark: | The presign token to verify | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/embeddingpresignverifyembeddingpresigntokenunauthorizederror.md b/docs/models/embeddingpresignverifyembeddingpresigntokenunauthorizederror.md new file mode 100644 index 0000000..12ed3a6 --- /dev/null +++ b/docs/models/embeddingpresignverifyembeddingpresigntokenunauthorizederror.md @@ -0,0 +1,12 @@ +# EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssue](../models/embeddingpresignverifyembeddingpresigntokenunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/embeddingpresignverifyembeddingpresigntokenunauthorizedissue.md b/docs/models/embeddingpresignverifyembeddingpresigntokenunauthorizedissue.md new file mode 100644 index 0000000..f43979a --- /dev/null +++ b/docs/models/embeddingpresignverifyembeddingpresigntokenunauthorizedissue.md @@ -0,0 +1,8 @@ +# EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreatebadrequesterror.md b/docs/models/envelopeattachmentcreatebadrequesterror.md new file mode 100644 index 0000000..e053c08 --- /dev/null +++ b/docs/models/envelopeattachmentcreatebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentCreateBadRequestError + +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.EnvelopeAttachmentCreateBadRequestIssue](../models/envelopeattachmentcreatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreatebadrequestissue.md b/docs/models/envelopeattachmentcreatebadrequestissue.md new file mode 100644 index 0000000..fb57e27 --- /dev/null +++ b/docs/models/envelopeattachmentcreatebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentCreateBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreatedata.md b/docs/models/envelopeattachmentcreatedata.md new file mode 100644 index 0000000..82155b2 --- /dev/null +++ b/docs/models/envelopeattachmentcreatedata.md @@ -0,0 +1,9 @@ +# EnvelopeAttachmentCreateData + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreateforbiddenerror.md b/docs/models/envelopeattachmentcreateforbiddenerror.md new file mode 100644 index 0000000..ee07ba0 --- /dev/null +++ b/docs/models/envelopeattachmentcreateforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentCreateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeAttachmentCreateForbiddenIssue](../models/envelopeattachmentcreateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreateforbiddenissue.md b/docs/models/envelopeattachmentcreateforbiddenissue.md new file mode 100644 index 0000000..1d895d2 --- /dev/null +++ b/docs/models/envelopeattachmentcreateforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentCreateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreateinternalservererror.md b/docs/models/envelopeattachmentcreateinternalservererror.md new file mode 100644 index 0000000..2d8fe64 --- /dev/null +++ b/docs/models/envelopeattachmentcreateinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentCreateInternalServerError + +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.EnvelopeAttachmentCreateInternalServerErrorIssue](../models/envelopeattachmentcreateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreateinternalservererrorissue.md b/docs/models/envelopeattachmentcreateinternalservererrorissue.md new file mode 100644 index 0000000..6e9ba40 --- /dev/null +++ b/docs/models/envelopeattachmentcreateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentCreateInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreaterequest.md b/docs/models/envelopeattachmentcreaterequest.md new file mode 100644 index 0000000..0053443 --- /dev/null +++ b/docs/models/envelopeattachmentcreaterequest.md @@ -0,0 +1,9 @@ +# EnvelopeAttachmentCreateRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | [models.EnvelopeAttachmentCreateData](../models/envelopeattachmentcreatedata.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreateresponse.md b/docs/models/envelopeattachmentcreateresponse.md new file mode 100644 index 0000000..f3cf56a --- /dev/null +++ b/docs/models/envelopeattachmentcreateresponse.md @@ -0,0 +1,10 @@ +# EnvelopeAttachmentCreateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreateunauthorizederror.md b/docs/models/envelopeattachmentcreateunauthorizederror.md new file mode 100644 index 0000000..802e9aa --- /dev/null +++ b/docs/models/envelopeattachmentcreateunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentCreateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeAttachmentCreateUnauthorizedIssue](../models/envelopeattachmentcreateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentcreateunauthorizedissue.md b/docs/models/envelopeattachmentcreateunauthorizedissue.md new file mode 100644 index 0000000..5aa04ad --- /dev/null +++ b/docs/models/envelopeattachmentcreateunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentCreateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentdeletebadrequesterror.md b/docs/models/envelopeattachmentdeletebadrequesterror.md new file mode 100644 index 0000000..e7d8756 --- /dev/null +++ b/docs/models/envelopeattachmentdeletebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentDeleteBadRequestError + +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.EnvelopeAttachmentDeleteBadRequestIssue](../models/envelopeattachmentdeletebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentdeletebadrequestissue.md b/docs/models/envelopeattachmentdeletebadrequestissue.md new file mode 100644 index 0000000..fd6d352 --- /dev/null +++ b/docs/models/envelopeattachmentdeletebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentDeleteBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentdeleteforbiddenerror.md b/docs/models/envelopeattachmentdeleteforbiddenerror.md new file mode 100644 index 0000000..01df473 --- /dev/null +++ b/docs/models/envelopeattachmentdeleteforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentDeleteForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeAttachmentDeleteForbiddenIssue](../models/envelopeattachmentdeleteforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentdeleteforbiddenissue.md b/docs/models/envelopeattachmentdeleteforbiddenissue.md new file mode 100644 index 0000000..056d04a --- /dev/null +++ b/docs/models/envelopeattachmentdeleteforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentDeleteForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentdeleteinternalservererror.md b/docs/models/envelopeattachmentdeleteinternalservererror.md new file mode 100644 index 0000000..f8f1c80 --- /dev/null +++ b/docs/models/envelopeattachmentdeleteinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentDeleteInternalServerError + +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.EnvelopeAttachmentDeleteInternalServerErrorIssue](../models/envelopeattachmentdeleteinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentdeleteinternalservererrorissue.md b/docs/models/envelopeattachmentdeleteinternalservererrorissue.md new file mode 100644 index 0000000..f9e6060 --- /dev/null +++ b/docs/models/envelopeattachmentdeleteinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentDeleteInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentdeleterequest.md b/docs/models/envelopeattachmentdeleterequest.md new file mode 100644 index 0000000..38d0e54 --- /dev/null +++ b/docs/models/envelopeattachmentdeleterequest.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentDeleteRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentdeleteresponse.md b/docs/models/envelopeattachmentdeleteresponse.md new file mode 100644 index 0000000..e34dc6f --- /dev/null +++ b/docs/models/envelopeattachmentdeleteresponse.md @@ -0,0 +1,10 @@ +# EnvelopeAttachmentDeleteResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentdeleteunauthorizederror.md b/docs/models/envelopeattachmentdeleteunauthorizederror.md new file mode 100644 index 0000000..6b8db0b --- /dev/null +++ b/docs/models/envelopeattachmentdeleteunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentDeleteUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeAttachmentDeleteUnauthorizedIssue](../models/envelopeattachmentdeleteunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentdeleteunauthorizedissue.md b/docs/models/envelopeattachmentdeleteunauthorizedissue.md new file mode 100644 index 0000000..ee9ed27 --- /dev/null +++ b/docs/models/envelopeattachmentdeleteunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentDeleteUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsauthoptions.md b/docs/models/envelopeattachmentfindbadrequesterror.md similarity index 54% rename from docs/models/documentfinddocumentsauthoptions.md rename to docs/models/envelopeattachmentfindbadrequesterror.md index 408c70f..505fd11 100644 --- a/docs/models/documentfinddocumentsauthoptions.md +++ b/docs/models/envelopeattachmentfindbadrequesterror.md @@ -1,9 +1,12 @@ -# DocumentFindDocumentsAuthOptions +# EnvelopeAttachmentFindBadRequestError + +Invalid input data ## 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 +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeAttachmentFindBadRequestIssue](../models/envelopeattachmentfindbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindbadrequestissue.md b/docs/models/envelopeattachmentfindbadrequestissue.md new file mode 100644 index 0000000..eae0fb2 --- /dev/null +++ b/docs/models/envelopeattachmentfindbadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentFindBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfinddata.md b/docs/models/envelopeattachmentfinddata.md new file mode 100644 index 0000000..f984344 --- /dev/null +++ b/docs/models/envelopeattachmentfinddata.md @@ -0,0 +1,11 @@ +# EnvelopeAttachmentFindData + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeAttachmentFindType](../models/envelopeattachmentfindtype.md) | :heavy_check_mark: | N/A | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindforbiddenerror.md b/docs/models/envelopeattachmentfindforbiddenerror.md new file mode 100644 index 0000000..36d470a --- /dev/null +++ b/docs/models/envelopeattachmentfindforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentFindForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeAttachmentFindForbiddenIssue](../models/envelopeattachmentfindforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindforbiddenissue.md b/docs/models/envelopeattachmentfindforbiddenissue.md new file mode 100644 index 0000000..19fd185 --- /dev/null +++ b/docs/models/envelopeattachmentfindforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentFindForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentinternalservererror.md b/docs/models/envelopeattachmentfindinternalservererror.md similarity index 93% rename from docs/models/documentupdatedocumentinternalservererror.md rename to docs/models/envelopeattachmentfindinternalservererror.md index cf88241..d8b016a 100644 --- a/docs/models/documentupdatedocumentinternalservererror.md +++ b/docs/models/envelopeattachmentfindinternalservererror.md @@ -1,4 +1,4 @@ -# DocumentUpdateDocumentInternalServerError +# EnvelopeAttachmentFindInternalServerError 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.DocumentUpdateDocumentInternalServerErrorIssue](../models/documentupdatedocumentinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.EnvelopeAttachmentFindInternalServerErrorIssue](../models/envelopeattachmentfindinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindinternalservererrorissue.md b/docs/models/envelopeattachmentfindinternalservererrorissue.md new file mode 100644 index 0000000..33cb461 --- /dev/null +++ b/docs/models/envelopeattachmentfindinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentFindInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindnotfounderror.md b/docs/models/envelopeattachmentfindnotfounderror.md new file mode 100644 index 0000000..0f6c04b --- /dev/null +++ b/docs/models/envelopeattachmentfindnotfounderror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentFindNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeAttachmentFindNotFoundIssue](../models/envelopeattachmentfindnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindnotfoundissue.md b/docs/models/envelopeattachmentfindnotfoundissue.md new file mode 100644 index 0000000..4a813bc --- /dev/null +++ b/docs/models/envelopeattachmentfindnotfoundissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentFindNotFoundIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindrequest.md b/docs/models/envelopeattachmentfindrequest.md new file mode 100644 index 0000000..752a946 --- /dev/null +++ b/docs/models/envelopeattachmentfindrequest.md @@ -0,0 +1,9 @@ +# EnvelopeAttachmentFindRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `token` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindresponse.md b/docs/models/envelopeattachmentfindresponse.md new file mode 100644 index 0000000..0a7aba2 --- /dev/null +++ b/docs/models/envelopeattachmentfindresponse.md @@ -0,0 +1,10 @@ +# EnvelopeAttachmentFindResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `data` | List[[models.EnvelopeAttachmentFindData](../models/envelopeattachmentfinddata.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindtype.md b/docs/models/envelopeattachmentfindtype.md new file mode 100644 index 0000000..1f0348e --- /dev/null +++ b/docs/models/envelopeattachmentfindtype.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentFindType + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindunauthorizederror.md b/docs/models/envelopeattachmentfindunauthorizederror.md new file mode 100644 index 0000000..4fa09e0 --- /dev/null +++ b/docs/models/envelopeattachmentfindunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentFindUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeAttachmentFindUnauthorizedIssue](../models/envelopeattachmentfindunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentfindunauthorizedissue.md b/docs/models/envelopeattachmentfindunauthorizedissue.md new file mode 100644 index 0000000..a9a80c0 --- /dev/null +++ b/docs/models/envelopeattachmentfindunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentFindUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdatebadrequesterror.md b/docs/models/envelopeattachmentupdatebadrequesterror.md new file mode 100644 index 0000000..5283476 --- /dev/null +++ b/docs/models/envelopeattachmentupdatebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentUpdateBadRequestError + +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.EnvelopeAttachmentUpdateBadRequestIssue](../models/envelopeattachmentupdatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdatebadrequestissue.md b/docs/models/envelopeattachmentupdatebadrequestissue.md new file mode 100644 index 0000000..8dc7690 --- /dev/null +++ b/docs/models/envelopeattachmentupdatebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentUpdateBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdatedata.md b/docs/models/envelopeattachmentupdatedata.md new file mode 100644 index 0000000..66547b1 --- /dev/null +++ b/docs/models/envelopeattachmentupdatedata.md @@ -0,0 +1,9 @@ +# EnvelopeAttachmentUpdateData + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdateforbiddenerror.md b/docs/models/envelopeattachmentupdateforbiddenerror.md new file mode 100644 index 0000000..a5399ab --- /dev/null +++ b/docs/models/envelopeattachmentupdateforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentUpdateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeAttachmentUpdateForbiddenIssue](../models/envelopeattachmentupdateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdateforbiddenissue.md b/docs/models/envelopeattachmentupdateforbiddenissue.md new file mode 100644 index 0000000..f0f4938 --- /dev/null +++ b/docs/models/envelopeattachmentupdateforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentUpdateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdateinternalservererror.md b/docs/models/envelopeattachmentupdateinternalservererror.md new file mode 100644 index 0000000..1eff7f3 --- /dev/null +++ b/docs/models/envelopeattachmentupdateinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentUpdateInternalServerError + +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.EnvelopeAttachmentUpdateInternalServerErrorIssue](../models/envelopeattachmentupdateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdateinternalservererrorissue.md b/docs/models/envelopeattachmentupdateinternalservererrorissue.md new file mode 100644 index 0000000..5bf7cb7 --- /dev/null +++ b/docs/models/envelopeattachmentupdateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentUpdateInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdaterequest.md b/docs/models/envelopeattachmentupdaterequest.md new file mode 100644 index 0000000..2c6c00c --- /dev/null +++ b/docs/models/envelopeattachmentupdaterequest.md @@ -0,0 +1,9 @@ +# EnvelopeAttachmentUpdateRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | N/A | +| `data` | [models.EnvelopeAttachmentUpdateData](../models/envelopeattachmentupdatedata.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdateresponse.md b/docs/models/envelopeattachmentupdateresponse.md new file mode 100644 index 0000000..a706906 --- /dev/null +++ b/docs/models/envelopeattachmentupdateresponse.md @@ -0,0 +1,10 @@ +# EnvelopeAttachmentUpdateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdateunauthorizederror.md b/docs/models/envelopeattachmentupdateunauthorizederror.md new file mode 100644 index 0000000..d88579b --- /dev/null +++ b/docs/models/envelopeattachmentupdateunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeAttachmentUpdateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeAttachmentUpdateUnauthorizedIssue](../models/envelopeattachmentupdateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeattachmentupdateunauthorizedissue.md b/docs/models/envelopeattachmentupdateunauthorizedissue.md new file mode 100644 index 0000000..e22501f --- /dev/null +++ b/docs/models/envelopeattachmentupdateunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeAttachmentUpdateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreateaccessauth.md b/docs/models/envelopecreateaccessauth.md new file mode 100644 index 0000000..79b7e6d --- /dev/null +++ b/docs/models/envelopecreateaccessauth.md @@ -0,0 +1,9 @@ +# EnvelopeCreateAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/envelopecreateactionauth.md b/docs/models/envelopecreateactionauth.md new file mode 100644 index 0000000..edb3b6f --- /dev/null +++ b/docs/models/envelopecreateactionauth.md @@ -0,0 +1,12 @@ +# EnvelopeCreateActionAuth + + +## 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/envelopecreateattachment.md b/docs/models/envelopecreateattachment.md new file mode 100644 index 0000000..61e580a --- /dev/null +++ b/docs/models/envelopecreateattachment.md @@ -0,0 +1,10 @@ +# EnvelopeCreateAttachment + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | +| `type` | [Optional[models.EnvelopeCreateTypeLink]](../models/envelopecreatetypelink.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatebadrequesterror.md b/docs/models/envelopecreatebadrequesterror.md new file mode 100644 index 0000000..e30acf3 --- /dev/null +++ b/docs/models/envelopecreatebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeCreateBadRequestError + +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.EnvelopeCreateBadRequestIssue](../models/envelopecreatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatebadrequestissue.md b/docs/models/envelopecreatebadrequestissue.md new file mode 100644 index 0000000..dd72d82 --- /dev/null +++ b/docs/models/envelopecreatebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeCreateBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatedateformat.md b/docs/models/envelopecreatedateformat.md new file mode 100644 index 0000000..e91ff57 --- /dev/null +++ b/docs/models/envelopecreatedateformat.md @@ -0,0 +1,29 @@ +# EnvelopeCreateDateFormat + + +## 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/envelopecreatedirectioncheckbox.md b/docs/models/envelopecreatedirectioncheckbox.md new file mode 100644 index 0000000..ee42a87 --- /dev/null +++ b/docs/models/envelopecreatedirectioncheckbox.md @@ -0,0 +1,9 @@ +# EnvelopeCreateDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopecreatedirectionradio.md b/docs/models/envelopecreatedirectionradio.md new file mode 100644 index 0000000..d4457bc --- /dev/null +++ b/docs/models/envelopecreatedirectionradio.md @@ -0,0 +1,9 @@ +# EnvelopeCreateDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopecreatedistributionmethod.md b/docs/models/envelopecreatedistributionmethod.md new file mode 100644 index 0000000..4f2c172 --- /dev/null +++ b/docs/models/envelopecreatedistributionmethod.md @@ -0,0 +1,9 @@ +# EnvelopeCreateDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/envelopecreateemailsettings.md b/docs/models/envelopecreateemailsettings.md new file mode 100644 index 0000000..7ac4c22 --- /dev/null +++ b/docs/models/envelopecreateemailsettings.md @@ -0,0 +1,14 @@ +# EnvelopeCreateEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldcheckbox.md b/docs/models/envelopecreatefieldcheckbox.md new file mode 100644 index 0000000..67bf830 --- /dev/null +++ b/docs/models/envelopecreatefieldcheckbox.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldCheckbox + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeCreateTypeCheckbox1](../models/envelopecreatetypecheckbox1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeCreateFieldMetaCheckbox]](../models/envelopecreatefieldmetacheckbox.md) | :heavy_minus_sign: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier10]](../models/envelopecreateidentifier10.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefielddate.md b/docs/models/envelopecreatefielddate.md new file mode 100644 index 0000000..8b8eaf7 --- /dev/null +++ b/docs/models/envelopecreatefielddate.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldDate + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeCreateTypeDate1](../models/envelopecreatetypedate1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeCreateFieldMetaDate]](../models/envelopecreatefieldmetadate.md) | :heavy_minus_sign: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier6]](../models/envelopecreateidentifier6.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefielddropdown.md b/docs/models/envelopecreatefielddropdown.md new file mode 100644 index 0000000..e9e95de --- /dev/null +++ b/docs/models/envelopecreatefielddropdown.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldDropdown + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeCreateTypeDropdown1](../models/envelopecreatetypedropdown1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeCreateFieldMetaDropdown]](../models/envelopecreatefieldmetadropdown.md) | :heavy_minus_sign: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier11]](../models/envelopecreateidentifier11.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldemail.md b/docs/models/envelopecreatefieldemail.md new file mode 100644 index 0000000..d725ef7 --- /dev/null +++ b/docs/models/envelopecreatefieldemail.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldEmail + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeCreateTypeEmail1](../models/envelopecreatetypeemail1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeCreateFieldMetaEmail]](../models/envelopecreatefieldmetaemail.md) | :heavy_minus_sign: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier5]](../models/envelopecreateidentifier5.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldfreesignature.md b/docs/models/envelopecreatefieldfreesignature.md new file mode 100644 index 0000000..fd4c05e --- /dev/null +++ b/docs/models/envelopecreatefieldfreesignature.md @@ -0,0 +1,14 @@ +# EnvelopeCreateFieldFreeSignature + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeCreateTypeFreeSignature](../models/envelopecreatetypefreesignature.md) | :heavy_check_mark: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier2]](../models/envelopecreateidentifier2.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldinitials.md b/docs/models/envelopecreatefieldinitials.md new file mode 100644 index 0000000..9e34148 --- /dev/null +++ b/docs/models/envelopecreatefieldinitials.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldInitials + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeCreateTypeInitials1](../models/envelopecreatetypeinitials1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeCreateFieldMetaInitials]](../models/envelopecreatefieldmetainitials.md) | :heavy_minus_sign: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier3]](../models/envelopecreateidentifier3.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldmetacheckbox.md b/docs/models/envelopecreatefieldmetacheckbox.md new file mode 100644 index 0000000..112665d --- /dev/null +++ b/docs/models/envelopecreatefieldmetacheckbox.md @@ -0,0 +1,17 @@ +# EnvelopeCreateFieldMetaCheckbox + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeCreateTypeCheckbox2](../models/envelopecreatetypecheckbox2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeCreateValueCheckbox](../models/envelopecreatevaluecheckbox.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.EnvelopeCreateDirectionCheckbox]](../models/envelopecreatedirectioncheckbox.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldmetadate.md b/docs/models/envelopecreatefieldmetadate.md new file mode 100644 index 0000000..3b95d42 --- /dev/null +++ b/docs/models/envelopecreatefieldmetadate.md @@ -0,0 +1,14 @@ +# EnvelopeCreateFieldMetaDate + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeCreateTypeDate2](../models/envelopecreatetypedate2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeCreateTextAlignDate]](../models/envelopecreatetextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldmetadropdown.md b/docs/models/envelopecreatefieldmetadropdown.md new file mode 100644 index 0000000..50d0007 --- /dev/null +++ b/docs/models/envelopecreatefieldmetadropdown.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldMetaDropdown + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeCreateTypeDropdown2](../models/envelopecreatetypedropdown2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeCreateValueDropdown](../models/envelopecreatevaluedropdown.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/envelopecreatefieldmetaemail.md b/docs/models/envelopecreatefieldmetaemail.md new file mode 100644 index 0000000..3cc765f --- /dev/null +++ b/docs/models/envelopecreatefieldmetaemail.md @@ -0,0 +1,14 @@ +# EnvelopeCreateFieldMetaEmail + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeCreateTypeEmail2](../models/envelopecreatetypeemail2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeCreateTextAlignEmail]](../models/envelopecreatetextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldmetainitials.md b/docs/models/envelopecreatefieldmetainitials.md new file mode 100644 index 0000000..22c077a --- /dev/null +++ b/docs/models/envelopecreatefieldmetainitials.md @@ -0,0 +1,14 @@ +# EnvelopeCreateFieldMetaInitials + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeCreateTypeInitials2](../models/envelopecreatetypeinitials2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeCreateTextAlignInitials]](../models/envelopecreatetextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldmetaname.md b/docs/models/envelopecreatefieldmetaname.md new file mode 100644 index 0000000..8494008 --- /dev/null +++ b/docs/models/envelopecreatefieldmetaname.md @@ -0,0 +1,14 @@ +# EnvelopeCreateFieldMetaName + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeCreateTypeName2](../models/envelopecreatetypename2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeCreateTextAlignName]](../models/envelopecreatetextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldmetanumber.md b/docs/models/envelopecreatefieldmetanumber.md new file mode 100644 index 0000000..1789962 --- /dev/null +++ b/docs/models/envelopecreatefieldmetanumber.md @@ -0,0 +1,21 @@ +# EnvelopeCreateFieldMetaNumber + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeCreateTypeNumber2](../models/envelopecreatetypenumber2.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 | +| `text_align` | [Optional[models.EnvelopeCreateTextAlignNumber]](../models/envelopecreatetextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeCreateVerticalAlignNumber]](../models/envelopecreateverticalalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldmetaradio.md b/docs/models/envelopecreatefieldmetaradio.md new file mode 100644 index 0000000..a12bd5c --- /dev/null +++ b/docs/models/envelopecreatefieldmetaradio.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldMetaRadio + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeCreateTypeRadio2](../models/envelopecreatetyperadio2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeCreateValueRadio](../models/envelopecreatevalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.EnvelopeCreateDirectionRadio]](../models/envelopecreatedirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldmetasignature.md b/docs/models/envelopecreatefieldmetasignature.md new file mode 100644 index 0000000..ce593e9 --- /dev/null +++ b/docs/models/envelopecreatefieldmetasignature.md @@ -0,0 +1,13 @@ +# EnvelopeCreateFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeCreateTypeSignature2](../models/envelopecreatetypesignature2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldmetatext.md b/docs/models/envelopecreatefieldmetatext.md new file mode 100644 index 0000000..953e60b --- /dev/null +++ b/docs/models/envelopecreatefieldmetatext.md @@ -0,0 +1,19 @@ +# EnvelopeCreateFieldMetaText + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeCreateTypeText2](../models/envelopecreatetypetext2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.EnvelopeCreateTextAlignText]](../models/envelopecreatetextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeCreateVerticalAlignText]](../models/envelopecreateverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldname.md b/docs/models/envelopecreatefieldname.md new file mode 100644 index 0000000..81678ee --- /dev/null +++ b/docs/models/envelopecreatefieldname.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldName + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeCreateTypeName1](../models/envelopecreatetypename1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeCreateFieldMetaName]](../models/envelopecreatefieldmetaname.md) | :heavy_minus_sign: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier4]](../models/envelopecreateidentifier4.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldnumber.md b/docs/models/envelopecreatefieldnumber.md new file mode 100644 index 0000000..7fa3a7a --- /dev/null +++ b/docs/models/envelopecreatefieldnumber.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldNumber + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeCreateTypeNumber1](../models/envelopecreatetypenumber1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeCreateFieldMetaNumber]](../models/envelopecreatefieldmetanumber.md) | :heavy_minus_sign: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier8]](../models/envelopecreateidentifier8.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldradio.md b/docs/models/envelopecreatefieldradio.md new file mode 100644 index 0000000..631b4a0 --- /dev/null +++ b/docs/models/envelopecreatefieldradio.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldRadio + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeCreateTypeRadio1](../models/envelopecreatetyperadio1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeCreateFieldMetaRadio]](../models/envelopecreatefieldmetaradio.md) | :heavy_minus_sign: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier9]](../models/envelopecreateidentifier9.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldsignature.md b/docs/models/envelopecreatefieldsignature.md new file mode 100644 index 0000000..d3ee6ef --- /dev/null +++ b/docs/models/envelopecreatefieldsignature.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldSignature + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeCreateTypeSignature1](../models/envelopecreatetypesignature1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeCreateFieldMetaSignature]](../models/envelopecreatefieldmetasignature.md) | :heavy_minus_sign: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier1]](../models/envelopecreateidentifier1.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldtext.md b/docs/models/envelopecreatefieldtext.md new file mode 100644 index 0000000..4057caa --- /dev/null +++ b/docs/models/envelopecreatefieldtext.md @@ -0,0 +1,15 @@ +# EnvelopeCreateFieldText + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeCreateTypeText1](../models/envelopecreatetypetext1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeCreateFieldMetaText]](../models/envelopecreatefieldmetatext.md) | :heavy_minus_sign: | N/A | +| `identifier` | [Optional[models.EnvelopeCreateIdentifier7]](../models/envelopecreateidentifier7.md) | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatefieldunion.md b/docs/models/envelopecreatefieldunion.md new file mode 100644 index 0000000..9cbc128 --- /dev/null +++ b/docs/models/envelopecreatefieldunion.md @@ -0,0 +1,71 @@ +# EnvelopeCreateFieldUnion + + +## Supported Types + +### `models.EnvelopeCreateFieldSignature` + +```python +value: models.EnvelopeCreateFieldSignature = /* values here */ +``` + +### `models.EnvelopeCreateFieldFreeSignature` + +```python +value: models.EnvelopeCreateFieldFreeSignature = /* values here */ +``` + +### `models.EnvelopeCreateFieldInitials` + +```python +value: models.EnvelopeCreateFieldInitials = /* values here */ +``` + +### `models.EnvelopeCreateFieldName` + +```python +value: models.EnvelopeCreateFieldName = /* values here */ +``` + +### `models.EnvelopeCreateFieldEmail` + +```python +value: models.EnvelopeCreateFieldEmail = /* values here */ +``` + +### `models.EnvelopeCreateFieldDate` + +```python +value: models.EnvelopeCreateFieldDate = /* values here */ +``` + +### `models.EnvelopeCreateFieldText` + +```python +value: models.EnvelopeCreateFieldText = /* values here */ +``` + +### `models.EnvelopeCreateFieldNumber` + +```python +value: models.EnvelopeCreateFieldNumber = /* values here */ +``` + +### `models.EnvelopeCreateFieldRadio` + +```python +value: models.EnvelopeCreateFieldRadio = /* values here */ +``` + +### `models.EnvelopeCreateFieldCheckbox` + +```python +value: models.EnvelopeCreateFieldCheckbox = /* values here */ +``` + +### `models.EnvelopeCreateFieldDropdown` + +```python +value: models.EnvelopeCreateFieldDropdown = /* values here */ +``` + diff --git a/docs/models/envelopecreatefile.md b/docs/models/envelopecreatefile.md new file mode 100644 index 0000000..badcf8d --- /dev/null +++ b/docs/models/envelopecreatefile.md @@ -0,0 +1,10 @@ +# EnvelopeCreateFile + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `file_name` | *str* | :heavy_check_mark: | N/A | +| `content` | *Union[bytes, IO[bytes], io.BufferedReader]* | :heavy_check_mark: | N/A | +| `content_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreateforbiddenerror.md b/docs/models/envelopecreateforbiddenerror.md new file mode 100644 index 0000000..6583a0f --- /dev/null +++ b/docs/models/envelopecreateforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeCreateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeCreateForbiddenIssue](../models/envelopecreateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreateforbiddenissue.md b/docs/models/envelopecreateforbiddenissue.md new file mode 100644 index 0000000..37079cc --- /dev/null +++ b/docs/models/envelopecreateforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeCreateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreateformvalues.md b/docs/models/envelopecreateformvalues.md new file mode 100644 index 0000000..4aa66b0 --- /dev/null +++ b/docs/models/envelopecreateformvalues.md @@ -0,0 +1,23 @@ +# EnvelopeCreateFormValues + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `bool` + +```python +value: bool = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateglobalaccessauth.md b/docs/models/envelopecreateglobalaccessauth.md new file mode 100644 index 0000000..ae8c627 --- /dev/null +++ b/docs/models/envelopecreateglobalaccessauth.md @@ -0,0 +1,9 @@ +# EnvelopeCreateGlobalAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/envelopecreateglobalactionauth.md b/docs/models/envelopecreateglobalactionauth.md new file mode 100644 index 0000000..ae3cc11 --- /dev/null +++ b/docs/models/envelopecreateglobalactionauth.md @@ -0,0 +1,11 @@ +# EnvelopeCreateGlobalActionAuth + + +## 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/envelopecreateidentifier1.md b/docs/models/envelopecreateidentifier1.md new file mode 100644 index 0000000..c922c8f --- /dev/null +++ b/docs/models/envelopecreateidentifier1.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier1 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateidentifier10.md b/docs/models/envelopecreateidentifier10.md new file mode 100644 index 0000000..62e712d --- /dev/null +++ b/docs/models/envelopecreateidentifier10.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier10 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateidentifier11.md b/docs/models/envelopecreateidentifier11.md new file mode 100644 index 0000000..f5954d8 --- /dev/null +++ b/docs/models/envelopecreateidentifier11.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier11 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateidentifier2.md b/docs/models/envelopecreateidentifier2.md new file mode 100644 index 0000000..8487bc1 --- /dev/null +++ b/docs/models/envelopecreateidentifier2.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier2 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateidentifier3.md b/docs/models/envelopecreateidentifier3.md new file mode 100644 index 0000000..60b4bbf --- /dev/null +++ b/docs/models/envelopecreateidentifier3.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier3 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateidentifier4.md b/docs/models/envelopecreateidentifier4.md new file mode 100644 index 0000000..4bad9e5 --- /dev/null +++ b/docs/models/envelopecreateidentifier4.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier4 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateidentifier5.md b/docs/models/envelopecreateidentifier5.md new file mode 100644 index 0000000..c21421b --- /dev/null +++ b/docs/models/envelopecreateidentifier5.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier5 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateidentifier6.md b/docs/models/envelopecreateidentifier6.md new file mode 100644 index 0000000..1354381 --- /dev/null +++ b/docs/models/envelopecreateidentifier6.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier6 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateidentifier7.md b/docs/models/envelopecreateidentifier7.md new file mode 100644 index 0000000..ca1f824 --- /dev/null +++ b/docs/models/envelopecreateidentifier7.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier7 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateidentifier8.md b/docs/models/envelopecreateidentifier8.md new file mode 100644 index 0000000..22e1a3a --- /dev/null +++ b/docs/models/envelopecreateidentifier8.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier8 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateidentifier9.md b/docs/models/envelopecreateidentifier9.md new file mode 100644 index 0000000..f2a8bf7 --- /dev/null +++ b/docs/models/envelopecreateidentifier9.md @@ -0,0 +1,17 @@ +# EnvelopeCreateIdentifier9 + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopecreateinternalservererror.md b/docs/models/envelopecreateinternalservererror.md new file mode 100644 index 0000000..1889bb0 --- /dev/null +++ b/docs/models/envelopecreateinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeCreateInternalServerError + +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.EnvelopeCreateInternalServerErrorIssue](../models/envelopecreateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreateinternalservererrorissue.md b/docs/models/envelopecreateinternalservererrorissue.md new file mode 100644 index 0000000..b64b8de --- /dev/null +++ b/docs/models/envelopecreateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeCreateInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatelanguage.md b/docs/models/envelopecreatelanguage.md new file mode 100644 index 0000000..2df8773 --- /dev/null +++ b/docs/models/envelopecreatelanguage.md @@ -0,0 +1,13 @@ +# EnvelopeCreateLanguage + + +## 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/envelopecreatemeta.md b/docs/models/envelopecreatemeta.md new file mode 100644 index 0000000..e3529f2 --- /dev/null +++ b/docs/models/envelopecreatemeta.md @@ -0,0 +1,22 @@ +# EnvelopeCreateMeta + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.EnvelopeCreateDateFormat]](../models/envelopecreatedateformat.md) | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.EnvelopeCreateDistributionMethod]](../models/envelopecreatedistributionmethod.md) | :heavy_minus_sign: | N/A | +| `signing_order` | [Optional[models.EnvelopeCreateSigningOrder]](../models/envelopecreatesigningorder.md) | :heavy_minus_sign: | N/A | +| `allow_dictate_next_signer` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `language` | [Optional[models.EnvelopeCreateLanguage]](../models/envelopecreatelanguage.md) | :heavy_minus_sign: | N/A | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [OptionalNullable[models.EnvelopeCreateEmailSettings]](../models/envelopecreateemailsettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatepayload.md b/docs/models/envelopecreatepayload.md new file mode 100644 index 0000000..7d21c89 --- /dev/null +++ b/docs/models/envelopecreatepayload.md @@ -0,0 +1,18 @@ +# EnvelopeCreatePayload + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `title` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeCreateType](../models/envelopecreatetype.md) | :heavy_check_mark: | N/A | +| `external_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.EnvelopeCreateVisibility]](../models/envelopecreatevisibility.md) | :heavy_minus_sign: | N/A | +| `global_access_auth` | List[[models.EnvelopeCreateGlobalAccessAuth](../models/envelopecreateglobalaccessauth.md)] | :heavy_minus_sign: | N/A | +| `global_action_auth` | List[[models.EnvelopeCreateGlobalActionAuth](../models/envelopecreateglobalactionauth.md)] | :heavy_minus_sign: | N/A | +| `form_values` | Dict[str, [models.EnvelopeCreateFormValues](../models/envelopecreateformvalues.md)] | :heavy_minus_sign: | N/A | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `recipients` | List[[models.EnvelopeCreateRecipient](../models/envelopecreaterecipient.md)] | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.EnvelopeCreateMeta]](../models/envelopecreatemeta.md) | :heavy_minus_sign: | N/A | +| `attachments` | List[[models.EnvelopeCreateAttachment](../models/envelopecreateattachment.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreaterecipient.md b/docs/models/envelopecreaterecipient.md new file mode 100644 index 0000000..36ac1e6 --- /dev/null +++ b/docs/models/envelopecreaterecipient.md @@ -0,0 +1,14 @@ +# EnvelopeCreateRecipient + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `email` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `role` | [models.EnvelopeCreateRole](../models/envelopecreaterole.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `access_auth` | List[[models.EnvelopeCreateAccessAuth](../models/envelopecreateaccessauth.md)] | :heavy_minus_sign: | N/A | +| `action_auth` | List[[models.EnvelopeCreateActionAuth](../models/envelopecreateactionauth.md)] | :heavy_minus_sign: | N/A | +| `fields` | List[[models.EnvelopeCreateFieldUnion](../models/envelopecreatefieldunion.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreaterequest.md b/docs/models/envelopecreaterequest.md new file mode 100644 index 0000000..593e0b2 --- /dev/null +++ b/docs/models/envelopecreaterequest.md @@ -0,0 +1,9 @@ +# EnvelopeCreateRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `payload` | [models.EnvelopeCreatePayload](../models/envelopecreatepayload.md) | :heavy_check_mark: | N/A | +| `files` | List[[models.EnvelopeCreateFile](../models/envelopecreatefile.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreateresponse.md b/docs/models/envelopecreateresponse.md new file mode 100644 index 0000000..341b90e --- /dev/null +++ b/docs/models/envelopecreateresponse.md @@ -0,0 +1,10 @@ +# EnvelopeCreateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreaterole.md b/docs/models/envelopecreaterole.md new file mode 100644 index 0000000..d0b0054 --- /dev/null +++ b/docs/models/envelopecreaterole.md @@ -0,0 +1,12 @@ +# EnvelopeCreateRole + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `CC` | CC | +| `SIGNER` | SIGNER | +| `VIEWER` | VIEWER | +| `APPROVER` | APPROVER | +| `ASSISTANT` | ASSISTANT | \ No newline at end of file diff --git a/docs/models/envelopecreatesigningorder.md b/docs/models/envelopecreatesigningorder.md new file mode 100644 index 0000000..ee40206 --- /dev/null +++ b/docs/models/envelopecreatesigningorder.md @@ -0,0 +1,9 @@ +# EnvelopeCreateSigningOrder + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `PARALLEL` | PARALLEL | +| `SEQUENTIAL` | SEQUENTIAL | \ No newline at end of file diff --git a/docs/models/envelopecreatetextaligndate.md b/docs/models/envelopecreatetextaligndate.md new file mode 100644 index 0000000..ce00309 --- /dev/null +++ b/docs/models/envelopecreatetextaligndate.md @@ -0,0 +1,10 @@ +# EnvelopeCreateTextAlignDate + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopecreatetextalignemail.md b/docs/models/envelopecreatetextalignemail.md new file mode 100644 index 0000000..c2e30b5 --- /dev/null +++ b/docs/models/envelopecreatetextalignemail.md @@ -0,0 +1,10 @@ +# EnvelopeCreateTextAlignEmail + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopecreatetextaligninitials.md b/docs/models/envelopecreatetextaligninitials.md new file mode 100644 index 0000000..df8d3a7 --- /dev/null +++ b/docs/models/envelopecreatetextaligninitials.md @@ -0,0 +1,10 @@ +# EnvelopeCreateTextAlignInitials + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopecreatetextalignname.md b/docs/models/envelopecreatetextalignname.md new file mode 100644 index 0000000..a175fb7 --- /dev/null +++ b/docs/models/envelopecreatetextalignname.md @@ -0,0 +1,10 @@ +# EnvelopeCreateTextAlignName + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopecreatetextalignnumber.md b/docs/models/envelopecreatetextalignnumber.md new file mode 100644 index 0000000..28d1321 --- /dev/null +++ b/docs/models/envelopecreatetextalignnumber.md @@ -0,0 +1,10 @@ +# EnvelopeCreateTextAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopecreatetextaligntext.md b/docs/models/envelopecreatetextaligntext.md new file mode 100644 index 0000000..68bc15e --- /dev/null +++ b/docs/models/envelopecreatetextaligntext.md @@ -0,0 +1,10 @@ +# EnvelopeCreateTextAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopecreatetype.md b/docs/models/envelopecreatetype.md new file mode 100644 index 0000000..3848d22 --- /dev/null +++ b/docs/models/envelopecreatetype.md @@ -0,0 +1,9 @@ +# EnvelopeCreateType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | \ No newline at end of file diff --git a/docs/models/envelopecreatetypecheckbox1.md b/docs/models/envelopecreatetypecheckbox1.md new file mode 100644 index 0000000..7c314e4 --- /dev/null +++ b/docs/models/envelopecreatetypecheckbox1.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeCheckbox1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | CHECKBOX | \ No newline at end of file diff --git a/docs/models/envelopecreatetypecheckbox2.md b/docs/models/envelopecreatetypecheckbox2.md new file mode 100644 index 0000000..08baf98 --- /dev/null +++ b/docs/models/envelopecreatetypecheckbox2.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeCheckbox2 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/envelopecreatetypedate1.md b/docs/models/envelopecreatetypedate1.md new file mode 100644 index 0000000..3e3b66e --- /dev/null +++ b/docs/models/envelopecreatetypedate1.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeDate1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | DATE | \ No newline at end of file diff --git a/docs/models/envelopecreatetypedate2.md b/docs/models/envelopecreatetypedate2.md new file mode 100644 index 0000000..d048937 --- /dev/null +++ b/docs/models/envelopecreatetypedate2.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeDate2 + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/envelopecreatetypedropdown1.md b/docs/models/envelopecreatetypedropdown1.md new file mode 100644 index 0000000..a4cafbe --- /dev/null +++ b/docs/models/envelopecreatetypedropdown1.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeDropdown1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | DROPDOWN | \ No newline at end of file diff --git a/docs/models/envelopecreatetypedropdown2.md b/docs/models/envelopecreatetypedropdown2.md new file mode 100644 index 0000000..8e54297 --- /dev/null +++ b/docs/models/envelopecreatetypedropdown2.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeDropdown2 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/envelopecreatetypeemail1.md b/docs/models/envelopecreatetypeemail1.md new file mode 100644 index 0000000..89c19a0 --- /dev/null +++ b/docs/models/envelopecreatetypeemail1.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeEmail1 + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | \ No newline at end of file diff --git a/docs/models/envelopecreatetypeemail2.md b/docs/models/envelopecreatetypeemail2.md new file mode 100644 index 0000000..a5d5b3a --- /dev/null +++ b/docs/models/envelopecreatetypeemail2.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeEmail2 + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | email | \ No newline at end of file diff --git a/docs/models/envelopecreatetypefreesignature.md b/docs/models/envelopecreatetypefreesignature.md new file mode 100644 index 0000000..7b05d5a --- /dev/null +++ b/docs/models/envelopecreatetypefreesignature.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeFreeSignature + + +## Values + +| Name | Value | +| ---------------- | ---------------- | +| `FREE_SIGNATURE` | FREE_SIGNATURE | \ No newline at end of file diff --git a/docs/models/envelopecreatetypeinitials1.md b/docs/models/envelopecreatetypeinitials1.md new file mode 100644 index 0000000..1757fc4 --- /dev/null +++ b/docs/models/envelopecreatetypeinitials1.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeInitials1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | INITIALS | \ No newline at end of file diff --git a/docs/models/envelopecreatetypeinitials2.md b/docs/models/envelopecreatetypeinitials2.md new file mode 100644 index 0000000..62a6402 --- /dev/null +++ b/docs/models/envelopecreatetypeinitials2.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeInitials2 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | initials | \ No newline at end of file diff --git a/docs/models/envelopecreatetypelink.md b/docs/models/envelopecreatetypelink.md new file mode 100644 index 0000000..f2791b0 --- /dev/null +++ b/docs/models/envelopecreatetypelink.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeLink + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/docs/models/envelopecreatetypename1.md b/docs/models/envelopecreatetypename1.md new file mode 100644 index 0000000..181d164 --- /dev/null +++ b/docs/models/envelopecreatetypename1.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeName1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | NAME | \ No newline at end of file diff --git a/docs/models/envelopecreatetypename2.md b/docs/models/envelopecreatetypename2.md new file mode 100644 index 0000000..f4b96b2 --- /dev/null +++ b/docs/models/envelopecreatetypename2.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeName2 + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | name | \ No newline at end of file diff --git a/docs/models/envelopecreatetypenumber1.md b/docs/models/envelopecreatetypenumber1.md new file mode 100644 index 0000000..1f02262 --- /dev/null +++ b/docs/models/envelopecreatetypenumber1.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeNumber1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | NUMBER | \ No newline at end of file diff --git a/docs/models/envelopecreatetypenumber2.md b/docs/models/envelopecreatetypenumber2.md new file mode 100644 index 0000000..c585b7d --- /dev/null +++ b/docs/models/envelopecreatetypenumber2.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeNumber2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/envelopecreatetyperadio1.md b/docs/models/envelopecreatetyperadio1.md new file mode 100644 index 0000000..6d202ea --- /dev/null +++ b/docs/models/envelopecreatetyperadio1.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeRadio1 + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | RADIO | \ No newline at end of file diff --git a/docs/models/envelopecreatetyperadio2.md b/docs/models/envelopecreatetyperadio2.md new file mode 100644 index 0000000..dde2c67 --- /dev/null +++ b/docs/models/envelopecreatetyperadio2.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeRadio2 + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldtypesignature.md b/docs/models/envelopecreatetypesignature1.md similarity index 71% rename from docs/models/fieldupdatetemplatefieldtypesignature.md rename to docs/models/envelopecreatetypesignature1.md index b305496..743ca4c 100644 --- a/docs/models/fieldupdatetemplatefieldtypesignature.md +++ b/docs/models/envelopecreatetypesignature1.md @@ -1,4 +1,4 @@ -# FieldUpdateTemplateFieldTypeSignature +# EnvelopeCreateTypeSignature1 ## Values diff --git a/docs/models/envelopecreatetypesignature2.md b/docs/models/envelopecreatetypesignature2.md new file mode 100644 index 0000000..b66200d --- /dev/null +++ b/docs/models/envelopecreatetypesignature2.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeSignature2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/envelopecreatetypetext1.md b/docs/models/envelopecreatetypetext1.md new file mode 100644 index 0000000..c26a194 --- /dev/null +++ b/docs/models/envelopecreatetypetext1.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeText1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | TEXT | \ No newline at end of file diff --git a/docs/models/envelopecreatetypetext2.md b/docs/models/envelopecreatetypetext2.md new file mode 100644 index 0000000..377b095 --- /dev/null +++ b/docs/models/envelopecreatetypetext2.md @@ -0,0 +1,8 @@ +# EnvelopeCreateTypeText2 + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/envelopecreateunauthorizederror.md b/docs/models/envelopecreateunauthorizederror.md new file mode 100644 index 0000000..36ad756 --- /dev/null +++ b/docs/models/envelopecreateunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeCreateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeCreateUnauthorizedIssue](../models/envelopecreateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreateunauthorizedissue.md b/docs/models/envelopecreateunauthorizedissue.md new file mode 100644 index 0000000..4178f94 --- /dev/null +++ b/docs/models/envelopecreateunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeCreateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatevaluecheckbox.md b/docs/models/envelopecreatevaluecheckbox.md new file mode 100644 index 0000000..75b73c3 --- /dev/null +++ b/docs/models/envelopecreatevaluecheckbox.md @@ -0,0 +1,10 @@ +# EnvelopeCreateValueCheckbox + + +## 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/envelopecreatevaluedropdown.md b/docs/models/envelopecreatevaluedropdown.md new file mode 100644 index 0000000..bf1e3c2 --- /dev/null +++ b/docs/models/envelopecreatevaluedropdown.md @@ -0,0 +1,8 @@ +# EnvelopeCreateValueDropdown + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopecreatevalueradio.md b/docs/models/envelopecreatevalueradio.md new file mode 100644 index 0000000..3c54b29 --- /dev/null +++ b/docs/models/envelopecreatevalueradio.md @@ -0,0 +1,10 @@ +# EnvelopeCreateValueRadio + + +## 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/envelopecreateverticalalignnumber.md b/docs/models/envelopecreateverticalalignnumber.md new file mode 100644 index 0000000..c8d0df6 --- /dev/null +++ b/docs/models/envelopecreateverticalalignnumber.md @@ -0,0 +1,10 @@ +# EnvelopeCreateVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopecreateverticalaligntext.md b/docs/models/envelopecreateverticalaligntext.md new file mode 100644 index 0000000..24fe05d --- /dev/null +++ b/docs/models/envelopecreateverticalaligntext.md @@ -0,0 +1,10 @@ +# EnvelopeCreateVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopecreatevisibility.md b/docs/models/envelopecreatevisibility.md new file mode 100644 index 0000000..b26362e --- /dev/null +++ b/docs/models/envelopecreatevisibility.md @@ -0,0 +1,10 @@ +# EnvelopeCreateVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/envelopedeletebadrequesterror.md b/docs/models/envelopedeletebadrequesterror.md new file mode 100644 index 0000000..e891c02 --- /dev/null +++ b/docs/models/envelopedeletebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeDeleteBadRequestError + +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.EnvelopeDeleteBadRequestIssue](../models/envelopedeletebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedeletebadrequestissue.md b/docs/models/envelopedeletebadrequestissue.md new file mode 100644 index 0000000..4827deb --- /dev/null +++ b/docs/models/envelopedeletebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeDeleteBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedeleteforbiddenerror.md b/docs/models/envelopedeleteforbiddenerror.md new file mode 100644 index 0000000..acf7f5c --- /dev/null +++ b/docs/models/envelopedeleteforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeDeleteForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeDeleteForbiddenIssue](../models/envelopedeleteforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedeleteforbiddenissue.md b/docs/models/envelopedeleteforbiddenissue.md new file mode 100644 index 0000000..9cab234 --- /dev/null +++ b/docs/models/envelopedeleteforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeDeleteForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedeleteinternalservererror.md b/docs/models/envelopedeleteinternalservererror.md new file mode 100644 index 0000000..d74f6ad --- /dev/null +++ b/docs/models/envelopedeleteinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeDeleteInternalServerError + +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.EnvelopeDeleteInternalServerErrorIssue](../models/envelopedeleteinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedeleteinternalservererrorissue.md b/docs/models/envelopedeleteinternalservererrorissue.md new file mode 100644 index 0000000..b4f38a8 --- /dev/null +++ b/docs/models/envelopedeleteinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeDeleteInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedeleterequest.md b/docs/models/envelopedeleterequest.md new file mode 100644 index 0000000..6c9a52b --- /dev/null +++ b/docs/models/envelopedeleterequest.md @@ -0,0 +1,8 @@ +# EnvelopeDeleteRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedeleteresponse.md b/docs/models/envelopedeleteresponse.md new file mode 100644 index 0000000..c735410 --- /dev/null +++ b/docs/models/envelopedeleteresponse.md @@ -0,0 +1,10 @@ +# EnvelopeDeleteResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedeleteunauthorizederror.md b/docs/models/envelopedeleteunauthorizederror.md new file mode 100644 index 0000000..283ac62 --- /dev/null +++ b/docs/models/envelopedeleteunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeDeleteUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeDeleteUnauthorizedIssue](../models/envelopedeleteunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedeleteunauthorizedissue.md b/docs/models/envelopedeleteunauthorizedissue.md new file mode 100644 index 0000000..e531c91 --- /dev/null +++ b/docs/models/envelopedeleteunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeDeleteUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributebadrequesterror.md b/docs/models/envelopedistributebadrequesterror.md new file mode 100644 index 0000000..2ce5cb5 --- /dev/null +++ b/docs/models/envelopedistributebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeDistributeBadRequestError + +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.EnvelopeDistributeBadRequestIssue](../models/envelopedistributebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributebadrequestissue.md b/docs/models/envelopedistributebadrequestissue.md new file mode 100644 index 0000000..4db353c --- /dev/null +++ b/docs/models/envelopedistributebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeDistributeBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributedateformat.md b/docs/models/envelopedistributedateformat.md new file mode 100644 index 0000000..daccae2 --- /dev/null +++ b/docs/models/envelopedistributedateformat.md @@ -0,0 +1,29 @@ +# EnvelopeDistributeDateFormat + + +## 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/envelopedistributedistributionmethod.md b/docs/models/envelopedistributedistributionmethod.md new file mode 100644 index 0000000..fba8ab4 --- /dev/null +++ b/docs/models/envelopedistributedistributionmethod.md @@ -0,0 +1,9 @@ +# EnvelopeDistributeDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/envelopedistributeemailsettings.md b/docs/models/envelopedistributeemailsettings.md new file mode 100644 index 0000000..de5d408 --- /dev/null +++ b/docs/models/envelopedistributeemailsettings.md @@ -0,0 +1,14 @@ +# EnvelopeDistributeEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributeforbiddenerror.md b/docs/models/envelopedistributeforbiddenerror.md new file mode 100644 index 0000000..918a211 --- /dev/null +++ b/docs/models/envelopedistributeforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeDistributeForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeDistributeForbiddenIssue](../models/envelopedistributeforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributeforbiddenissue.md b/docs/models/envelopedistributeforbiddenissue.md new file mode 100644 index 0000000..a504d81 --- /dev/null +++ b/docs/models/envelopedistributeforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeDistributeForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributeinternalservererror.md b/docs/models/envelopedistributeinternalservererror.md new file mode 100644 index 0000000..6a60ff5 --- /dev/null +++ b/docs/models/envelopedistributeinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeDistributeInternalServerError + +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.EnvelopeDistributeInternalServerErrorIssue](../models/envelopedistributeinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributeinternalservererrorissue.md b/docs/models/envelopedistributeinternalservererrorissue.md new file mode 100644 index 0000000..661e7f4 --- /dev/null +++ b/docs/models/envelopedistributeinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeDistributeInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributelanguage.md b/docs/models/envelopedistributelanguage.md new file mode 100644 index 0000000..ec38f8e --- /dev/null +++ b/docs/models/envelopedistributelanguage.md @@ -0,0 +1,13 @@ +# EnvelopeDistributeLanguage + + +## 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/envelopedistributemeta.md b/docs/models/envelopedistributemeta.md new file mode 100644 index 0000000..5640bf6 --- /dev/null +++ b/docs/models/envelopedistributemeta.md @@ -0,0 +1,17 @@ +# EnvelopeDistributeMeta + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.EnvelopeDistributeDateFormat]](../models/envelopedistributedateformat.md) | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.EnvelopeDistributeDistributionMethod]](../models/envelopedistributedistributionmethod.md) | :heavy_minus_sign: | N/A | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `language` | [Optional[models.EnvelopeDistributeLanguage]](../models/envelopedistributelanguage.md) | :heavy_minus_sign: | N/A | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [OptionalNullable[models.EnvelopeDistributeEmailSettings]](../models/envelopedistributeemailsettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributerequest.md b/docs/models/envelopedistributerequest.md new file mode 100644 index 0000000..3b0755a --- /dev/null +++ b/docs/models/envelopedistributerequest.md @@ -0,0 +1,9 @@ +# EnvelopeDistributeRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `meta` | [Optional[models.EnvelopeDistributeMeta]](../models/envelopedistributemeta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributeresponse.md b/docs/models/envelopedistributeresponse.md new file mode 100644 index 0000000..efe8f99 --- /dev/null +++ b/docs/models/envelopedistributeresponse.md @@ -0,0 +1,10 @@ +# EnvelopeDistributeResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributeunauthorizederror.md b/docs/models/envelopedistributeunauthorizederror.md new file mode 100644 index 0000000..8b0e3e7 --- /dev/null +++ b/docs/models/envelopedistributeunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeDistributeUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeDistributeUnauthorizedIssue](../models/envelopedistributeunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopedistributeunauthorizedissue.md b/docs/models/envelopedistributeunauthorizedissue.md new file mode 100644 index 0000000..a2ab79d --- /dev/null +++ b/docs/models/envelopedistributeunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeDistributeUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeduplicatebadrequesterror.md b/docs/models/envelopeduplicatebadrequesterror.md new file mode 100644 index 0000000..cbd70e5 --- /dev/null +++ b/docs/models/envelopeduplicatebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeDuplicateBadRequestError + +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.EnvelopeDuplicateBadRequestIssue](../models/envelopeduplicatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeduplicatebadrequestissue.md b/docs/models/envelopeduplicatebadrequestissue.md new file mode 100644 index 0000000..75052d4 --- /dev/null +++ b/docs/models/envelopeduplicatebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeDuplicateBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeduplicateforbiddenerror.md b/docs/models/envelopeduplicateforbiddenerror.md new file mode 100644 index 0000000..6aeb7e4 --- /dev/null +++ b/docs/models/envelopeduplicateforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeDuplicateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeDuplicateForbiddenIssue](../models/envelopeduplicateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeduplicateforbiddenissue.md b/docs/models/envelopeduplicateforbiddenissue.md new file mode 100644 index 0000000..f8b6e2b --- /dev/null +++ b/docs/models/envelopeduplicateforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeDuplicateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeduplicateinternalservererror.md b/docs/models/envelopeduplicateinternalservererror.md new file mode 100644 index 0000000..69be028 --- /dev/null +++ b/docs/models/envelopeduplicateinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeDuplicateInternalServerError + +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.EnvelopeDuplicateInternalServerErrorIssue](../models/envelopeduplicateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeduplicateinternalservererrorissue.md b/docs/models/envelopeduplicateinternalservererrorissue.md new file mode 100644 index 0000000..a612501 --- /dev/null +++ b/docs/models/envelopeduplicateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeDuplicateInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeduplicaterequest.md b/docs/models/envelopeduplicaterequest.md new file mode 100644 index 0000000..bef6ea8 --- /dev/null +++ b/docs/models/envelopeduplicaterequest.md @@ -0,0 +1,8 @@ +# EnvelopeDuplicateRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeduplicateresponse.md b/docs/models/envelopeduplicateresponse.md new file mode 100644 index 0000000..362d5ca --- /dev/null +++ b/docs/models/envelopeduplicateresponse.md @@ -0,0 +1,10 @@ +# EnvelopeDuplicateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeduplicateunauthorizederror.md b/docs/models/envelopeduplicateunauthorizederror.md new file mode 100644 index 0000000..ec99e81 --- /dev/null +++ b/docs/models/envelopeduplicateunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeDuplicateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeDuplicateUnauthorizedIssue](../models/envelopeduplicateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeduplicateunauthorizedissue.md b/docs/models/envelopeduplicateunauthorizedissue.md new file mode 100644 index 0000000..29f91d9 --- /dev/null +++ b/docs/models/envelopeduplicateunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeDuplicateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanybadrequesterror.md b/docs/models/envelopefieldcreatemanybadrequesterror.md new file mode 100644 index 0000000..c559f3b --- /dev/null +++ b/docs/models/envelopefieldcreatemanybadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldCreateManyBadRequestError + +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.EnvelopeFieldCreateManyBadRequestIssue](../models/envelopefieldcreatemanybadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanybadrequestissue.md b/docs/models/envelopefieldcreatemanybadrequestissue.md new file mode 100644 index 0000000..6f561b8 --- /dev/null +++ b/docs/models/envelopefieldcreatemanybadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydatacheckbox.md b/docs/models/envelopefieldcreatemanydatacheckbox.md new file mode 100644 index 0000000..53d13b0 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydatacheckbox.md @@ -0,0 +1,16 @@ +# EnvelopeFieldCreateManyDataCheckbox + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldCreateManyTypeCheckboxRequest1](../models/envelopefieldcreatemanytypecheckboxrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldCreateManyFieldMetaCheckboxRequest]](../models/envelopefieldcreatemanyfieldmetacheckboxrequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydatadate.md b/docs/models/envelopefieldcreatemanydatadate.md new file mode 100644 index 0000000..30fad9a --- /dev/null +++ b/docs/models/envelopefieldcreatemanydatadate.md @@ -0,0 +1,16 @@ +# EnvelopeFieldCreateManyDataDate + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeFieldCreateManyTypeDateRequest1](../models/envelopefieldcreatemanytypedaterequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldCreateManyFieldMetaDateRequest]](../models/envelopefieldcreatemanyfieldmetadaterequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydatadropdown.md b/docs/models/envelopefieldcreatemanydatadropdown.md new file mode 100644 index 0000000..5643a9c --- /dev/null +++ b/docs/models/envelopefieldcreatemanydatadropdown.md @@ -0,0 +1,16 @@ +# EnvelopeFieldCreateManyDataDropdown + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldCreateManyTypeDropdownRequest1](../models/envelopefieldcreatemanytypedropdownrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldCreateManyFieldMetaDropdownRequest]](../models/envelopefieldcreatemanyfieldmetadropdownrequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetadate.md b/docs/models/envelopefieldcreatemanydataemail.md similarity index 60% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetadate.md rename to docs/models/envelopefieldcreatemanydataemail.md index 75a8b42..81a9096 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetadate.md +++ b/docs/models/envelopefieldcreatemanydataemail.md @@ -1,14 +1,16 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaDate +# EnvelopeFieldCreateManyDataEmail ## 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 +| `type` | [models.EnvelopeFieldCreateManyTypeEmailRequest1](../models/envelopefieldcreatemanytypeemailrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldCreateManyFieldMetaEmailRequest]](../models/envelopefieldcreatemanyfieldmetaemailrequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydatafreesignature.md b/docs/models/envelopefieldcreatemanydatafreesignature.md new file mode 100644 index 0000000..5170f13 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydatafreesignature.md @@ -0,0 +1,15 @@ +# EnvelopeFieldCreateManyDataFreeSignature + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldCreateManyTypeFreeSignature](../models/envelopefieldcreatemanytypefreesignature.md) | :heavy_check_mark: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydatainitials.md b/docs/models/envelopefieldcreatemanydatainitials.md new file mode 100644 index 0000000..9ecec59 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydatainitials.md @@ -0,0 +1,16 @@ +# EnvelopeFieldCreateManyDataInitials + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldCreateManyTypeInitialsRequest1](../models/envelopefieldcreatemanytypeinitialsrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldCreateManyFieldMetaInitialsRequest]](../models/envelopefieldcreatemanyfieldmetainitialsrequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydataname.md b/docs/models/envelopefieldcreatemanydataname.md new file mode 100644 index 0000000..6cf442c --- /dev/null +++ b/docs/models/envelopefieldcreatemanydataname.md @@ -0,0 +1,16 @@ +# EnvelopeFieldCreateManyDataName + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeFieldCreateManyTypeNameRequest1](../models/envelopefieldcreatemanytypenamerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldCreateManyFieldMetaNameRequest]](../models/envelopefieldcreatemanyfieldmetanamerequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfolder.md b/docs/models/envelopefieldcreatemanydatanumber.md similarity index 71% rename from docs/models/documentgetdocumentwithdetailsbyidfolder.md rename to docs/models/envelopefieldcreatemanydatanumber.md index 226e017..386f354 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfolder.md +++ b/docs/models/envelopefieldcreatemanydatanumber.md @@ -1,17 +1,16 @@ -# DocumentGetDocumentWithDetailsByIDFolder +# EnvelopeFieldCreateManyDataNumber ## 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 +| `type` | [models.EnvelopeFieldCreateManyTypeNumberRequest1](../models/envelopefieldcreatemanytypenumberrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldCreateManyFieldMetaNumberRequest]](../models/envelopefieldcreatemanyfieldmetanumberrequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydataradio.md b/docs/models/envelopefieldcreatemanydataradio.md new file mode 100644 index 0000000..6aa9112 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydataradio.md @@ -0,0 +1,16 @@ +# EnvelopeFieldCreateManyDataRadio + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldCreateManyTypeRadioRequest1](../models/envelopefieldcreatemanytyperadiorequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldCreateManyFieldMetaRadioRequest]](../models/envelopefieldcreatemanyfieldmetaradiorequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydataresponse.md b/docs/models/envelopefieldcreatemanydataresponse.md new file mode 100644 index 0000000..2935868 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydataresponse.md @@ -0,0 +1,23 @@ +# EnvelopeFieldCreateManyDataResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeFieldCreateManyTypeResponse](../models/envelopefieldcreatemanytyperesponse.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: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | N/A | +| `custom_text` | *str* | :heavy_check_mark: | N/A | +| `inserted` | *bool* | :heavy_check_mark: | N/A | +| `field_meta` | [Nullable[models.EnvelopeFieldCreateManyFieldMetaUnion]](../models/envelopefieldcreatemanyfieldmetaunion.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/documentgetdocumentwithdetailsbyidfield.md b/docs/models/envelopefieldcreatemanydatasignature.md similarity index 61% rename from docs/models/documentgetdocumentwithdetailsbyidfield.md rename to docs/models/envelopefieldcreatemanydatasignature.md index 0f0a1f4..d9dd281 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfield.md +++ b/docs/models/envelopefieldcreatemanydatasignature.md @@ -1,21 +1,16 @@ -# DocumentGetDocumentWithDetailsByIDField +# EnvelopeFieldCreateManyDataSignature ## 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 | +| `type` | [models.EnvelopeFieldCreateManyTypeSignatureRequest1](../models/envelopefieldcreatemanytypesignaturerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldCreateManyFieldMetaSignatureRequest]](../models/envelopefieldcreatemanyfieldmetasignaturerequest.md) | :heavy_minus_sign: | 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 +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydatatext.md b/docs/models/envelopefieldcreatemanydatatext.md new file mode 100644 index 0000000..3910359 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydatatext.md @@ -0,0 +1,16 @@ +# EnvelopeFieldCreateManyDataText + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeFieldCreateManyTypeTextRequest1](../models/envelopefieldcreatemanytypetextrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldCreateManyFieldMetaTextRequest]](../models/envelopefieldcreatemanyfieldmetatextrequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *float* | :heavy_check_mark: | N/A | +| `position_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydataunion.md b/docs/models/envelopefieldcreatemanydataunion.md new file mode 100644 index 0000000..5cfc585 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydataunion.md @@ -0,0 +1,71 @@ +# EnvelopeFieldCreateManyDataUnion + + +## Supported Types + +### `models.EnvelopeFieldCreateManyDataSignature` + +```python +value: models.EnvelopeFieldCreateManyDataSignature = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyDataFreeSignature` + +```python +value: models.EnvelopeFieldCreateManyDataFreeSignature = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyDataInitials` + +```python +value: models.EnvelopeFieldCreateManyDataInitials = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyDataName` + +```python +value: models.EnvelopeFieldCreateManyDataName = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyDataEmail` + +```python +value: models.EnvelopeFieldCreateManyDataEmail = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyDataDate` + +```python +value: models.EnvelopeFieldCreateManyDataDate = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyDataText` + +```python +value: models.EnvelopeFieldCreateManyDataText = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyDataNumber` + +```python +value: models.EnvelopeFieldCreateManyDataNumber = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyDataRadio` + +```python +value: models.EnvelopeFieldCreateManyDataRadio = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyDataCheckbox` + +```python +value: models.EnvelopeFieldCreateManyDataCheckbox = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyDataDropdown` + +```python +value: models.EnvelopeFieldCreateManyDataDropdown = /* values here */ +``` + diff --git a/docs/models/envelopefieldcreatemanydirectioncheckbox.md b/docs/models/envelopefieldcreatemanydirectioncheckbox.md new file mode 100644 index 0000000..4da4af4 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydirectioncheckbox.md @@ -0,0 +1,9 @@ +# EnvelopeFieldCreateManyDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydirectionradio.md b/docs/models/envelopefieldcreatemanydirectionradio.md new file mode 100644 index 0000000..a886559 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydirectionradio.md @@ -0,0 +1,9 @@ +# EnvelopeFieldCreateManyDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydirectionresponse1.md b/docs/models/envelopefieldcreatemanydirectionresponse1.md new file mode 100644 index 0000000..747f202 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydirectionresponse1.md @@ -0,0 +1,9 @@ +# EnvelopeFieldCreateManyDirectionResponse1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanydirectionresponse2.md b/docs/models/envelopefieldcreatemanydirectionresponse2.md new file mode 100644 index 0000000..f788d60 --- /dev/null +++ b/docs/models/envelopefieldcreatemanydirectionresponse2.md @@ -0,0 +1,9 @@ +# EnvelopeFieldCreateManyDirectionResponse2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetacheckboxrequest.md b/docs/models/envelopefieldcreatemanyfieldmetacheckboxrequest.md new file mode 100644 index 0000000..0ff7b8a --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetacheckboxrequest.md @@ -0,0 +1,17 @@ +# EnvelopeFieldCreateManyFieldMetaCheckboxRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyTypeCheckboxRequest2](../models/envelopefieldcreatemanytypecheckboxrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldCreateManyValueCheckbox](../models/envelopefieldcreatemanyvaluecheckbox.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.EnvelopeFieldCreateManyDirectionCheckbox]](../models/envelopefieldcreatemanydirectioncheckbox.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetacheckboxresponse.md b/docs/models/envelopefieldcreatemanyfieldmetacheckboxresponse.md new file mode 100644 index 0000000..07e59da --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetacheckboxresponse.md @@ -0,0 +1,17 @@ +# EnvelopeFieldCreateManyFieldMetaCheckboxResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyFieldMetaTypeCheckbox](../models/envelopefieldcreatemanyfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldCreateManyValueResponse2](../models/envelopefieldcreatemanyvalueresponse2.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.EnvelopeFieldCreateManyDirectionResponse2]](../models/envelopefieldcreatemanydirectionresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetadaterequest.md b/docs/models/envelopefieldcreatemanyfieldmetadaterequest.md new file mode 100644 index 0000000..5ea50d4 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetadaterequest.md @@ -0,0 +1,14 @@ +# EnvelopeFieldCreateManyFieldMetaDateRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyTypeDateRequest2](../models/envelopefieldcreatemanytypedaterequest2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignDate]](../models/envelopefieldcreatemanytextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetadropdown.md b/docs/models/envelopefieldcreatemanyfieldmetadateresponse.md similarity index 87% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetadropdown.md rename to docs/models/envelopefieldcreatemanyfieldmetadateresponse.md index b0adae8..a153be2 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetadropdown.md +++ b/docs/models/envelopefieldcreatemanyfieldmetadateresponse.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaDropdown +# EnvelopeFieldCreateManyFieldMetaDateResponse ## 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 +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyFieldMetaTypeDate](../models/envelopefieldcreatemanyfieldmetatypedate.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignResponse4]](../models/envelopefieldcreatemanytextalignresponse4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaradio.md b/docs/models/envelopefieldcreatemanyfieldmetadropdownrequest.md similarity index 72% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetaradio.md rename to docs/models/envelopefieldcreatemanyfieldmetadropdownrequest.md index b01c606..af64bcf 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaradio.md +++ b/docs/models/envelopefieldcreatemanyfieldmetadropdownrequest.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaRadio +# EnvelopeFieldCreateManyFieldMetaDropdownRequest ## Fields @@ -9,5 +9,7 @@ | `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 +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyTypeDropdownRequest2](../models/envelopefieldcreatemanytypedropdownrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldCreateManyValueDropdown](../models/envelopefieldcreatemanyvaluedropdown.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/envelopefieldcreatemanyfieldmetadropdownresponse.md b/docs/models/envelopefieldcreatemanyfieldmetadropdownresponse.md new file mode 100644 index 0000000..707873d --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetadropdownresponse.md @@ -0,0 +1,15 @@ +# EnvelopeFieldCreateManyFieldMetaDropdownResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyFieldMetaTypeDropdown](../models/envelopefieldcreatemanyfieldmetatypedropdown.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldCreateManyValueResponse3](../models/envelopefieldcreatemanyvalueresponse3.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/envelopefieldcreatemanyfieldmetaemailrequest.md b/docs/models/envelopefieldcreatemanyfieldmetaemailrequest.md new file mode 100644 index 0000000..b49b1ef --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetaemailrequest.md @@ -0,0 +1,14 @@ +# EnvelopeFieldCreateManyFieldMetaEmailRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyTypeEmailRequest2](../models/envelopefieldcreatemanytypeemailrequest2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignEmail]](../models/envelopefieldcreatemanytextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetaemailresponse.md b/docs/models/envelopefieldcreatemanyfieldmetaemailresponse.md new file mode 100644 index 0000000..6b4ce6f --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetaemailresponse.md @@ -0,0 +1,14 @@ +# EnvelopeFieldCreateManyFieldMetaEmailResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyFieldMetaTypeEmail](../models/envelopefieldcreatemanyfieldmetatypeemail.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignResponse3]](../models/envelopefieldcreatemanytextalignresponse3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetainitialsrequest.md b/docs/models/envelopefieldcreatemanyfieldmetainitialsrequest.md new file mode 100644 index 0000000..49b27c4 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetainitialsrequest.md @@ -0,0 +1,14 @@ +# EnvelopeFieldCreateManyFieldMetaInitialsRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyTypeInitialsRequest2](../models/envelopefieldcreatemanytypeinitialsrequest2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignInitials]](../models/envelopefieldcreatemanytextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetainitialsresponse.md b/docs/models/envelopefieldcreatemanyfieldmetainitialsresponse.md new file mode 100644 index 0000000..cfc09ee --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetainitialsresponse.md @@ -0,0 +1,14 @@ +# EnvelopeFieldCreateManyFieldMetaInitialsResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyFieldMetaTypeInitials](../models/envelopefieldcreatemanyfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignResponse1]](../models/envelopefieldcreatemanytextalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetanamerequest.md b/docs/models/envelopefieldcreatemanyfieldmetanamerequest.md new file mode 100644 index 0000000..2044fe4 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetanamerequest.md @@ -0,0 +1,14 @@ +# EnvelopeFieldCreateManyFieldMetaNameRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyTypeNameRequest2](../models/envelopefieldcreatemanytypenamerequest2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignName]](../models/envelopefieldcreatemanytextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetanameresponse.md b/docs/models/envelopefieldcreatemanyfieldmetanameresponse.md new file mode 100644 index 0000000..77d59a6 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetanameresponse.md @@ -0,0 +1,14 @@ +# EnvelopeFieldCreateManyFieldMetaNameResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyFieldMetaTypeName](../models/envelopefieldcreatemanyfieldmetatypename.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignResponse2]](../models/envelopefieldcreatemanytextalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetanumberrequest.md b/docs/models/envelopefieldcreatemanyfieldmetanumberrequest.md new file mode 100644 index 0000000..2be5deb --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetanumberrequest.md @@ -0,0 +1,21 @@ +# EnvelopeFieldCreateManyFieldMetaNumberRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyTypeNumberRequest2](../models/envelopefieldcreatemanytypenumberrequest2.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 | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignNumber]](../models/envelopefieldcreatemanytextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeFieldCreateManyVerticalAlignNumber]](../models/envelopefieldcreatemanyverticalalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetanumberresponse.md b/docs/models/envelopefieldcreatemanyfieldmetanumberresponse.md new file mode 100644 index 0000000..4fb60e4 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetanumberresponse.md @@ -0,0 +1,21 @@ +# EnvelopeFieldCreateManyFieldMetaNumberResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyFieldMetaTypeNumber](../models/envelopefieldcreatemanyfieldmetatypenumber.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 | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignResponse6]](../models/envelopefieldcreatemanytextalignresponse6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeFieldCreateManyVerticalAlignResponse2]](../models/envelopefieldcreatemanyverticalalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetaradiorequest.md b/docs/models/envelopefieldcreatemanyfieldmetaradiorequest.md new file mode 100644 index 0000000..91af215 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetaradiorequest.md @@ -0,0 +1,15 @@ +# EnvelopeFieldCreateManyFieldMetaRadioRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyTypeRadioRequest2](../models/envelopefieldcreatemanytyperadiorequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldCreateManyValueRadio](../models/envelopefieldcreatemanyvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.EnvelopeFieldCreateManyDirectionRadio]](../models/envelopefieldcreatemanydirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetacheckbox.md b/docs/models/envelopefieldcreatemanyfieldmetaradioresponse.md similarity index 86% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetacheckbox.md rename to docs/models/envelopefieldcreatemanyfieldmetaradioresponse.md index 767b5af..68537ca 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetacheckbox.md +++ b/docs/models/envelopefieldcreatemanyfieldmetaradioresponse.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox +# EnvelopeFieldCreateManyFieldMetaRadioResponse ## Fields @@ -9,7 +9,7 @@ | `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 +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyFieldMetaTypeRadio](../models/envelopefieldcreatemanyfieldmetatyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldCreateManyValueResponse1](../models/envelopefieldcreatemanyvalueresponse1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.EnvelopeFieldCreateManyDirectionResponse1]](../models/envelopefieldcreatemanydirectionresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetasignaturerequest.md b/docs/models/envelopefieldcreatemanyfieldmetasignaturerequest.md new file mode 100644 index 0000000..2f6b3da --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetasignaturerequest.md @@ -0,0 +1,13 @@ +# EnvelopeFieldCreateManyFieldMetaSignatureRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyTypeSignatureRequest2](../models/envelopefieldcreatemanytypesignaturerequest2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetasignatureresponse.md b/docs/models/envelopefieldcreatemanyfieldmetasignatureresponse.md new file mode 100644 index 0000000..dcbd4ac --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetasignatureresponse.md @@ -0,0 +1,13 @@ +# EnvelopeFieldCreateManyFieldMetaSignatureResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyFieldMetaTypeSignature](../models/envelopefieldcreatemanyfieldmetatypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetanumber.md b/docs/models/envelopefieldcreatemanyfieldmetatextrequest.md similarity index 83% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetanumber.md rename to docs/models/envelopefieldcreatemanyfieldmetatextrequest.md index 369aa84..a0fca49 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetanumber.md +++ b/docs/models/envelopefieldcreatemanyfieldmetatextrequest.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaNumber +# EnvelopeFieldCreateManyFieldMetaTextRequest ## Fields @@ -9,10 +9,11 @@ | `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 +| `type` | [models.EnvelopeFieldCreateManyTypeTextRequest2](../models/envelopefieldcreatemanytypetextrequest2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignText]](../models/envelopefieldcreatemanytextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeFieldCreateManyVerticalAlignText]](../models/envelopefieldcreatemanyverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatextresponse.md b/docs/models/envelopefieldcreatemanyfieldmetatextresponse.md new file mode 100644 index 0000000..493e189 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatextresponse.md @@ -0,0 +1,19 @@ +# EnvelopeFieldCreateManyFieldMetaTextResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldCreateManyFieldMetaTypeText](../models/envelopefieldcreatemanyfieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldCreateManyTextAlignResponse5]](../models/envelopefieldcreatemanytextalignresponse5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeFieldCreateManyVerticalAlignResponse1]](../models/envelopefieldcreatemanyverticalalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatypecheckbox.md b/docs/models/envelopefieldcreatemanyfieldmetatypecheckbox.md new file mode 100644 index 0000000..12e8b2e --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatypecheckbox.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyFieldMetaTypeCheckbox + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatypedate.md b/docs/models/envelopefieldcreatemanyfieldmetatypedate.md new file mode 100644 index 0000000..d7444f7 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatypedate.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyFieldMetaTypeDate + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatypedropdown.md b/docs/models/envelopefieldcreatemanyfieldmetatypedropdown.md new file mode 100644 index 0000000..094fe27 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatypedropdown.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyFieldMetaTypeDropdown + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatypeemail.md b/docs/models/envelopefieldcreatemanyfieldmetatypeemail.md new file mode 100644 index 0000000..3ed2362 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatypeemail.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyFieldMetaTypeEmail + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | email | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatypeinitials.md b/docs/models/envelopefieldcreatemanyfieldmetatypeinitials.md new file mode 100644 index 0000000..dedb210 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatypeinitials.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyFieldMetaTypeInitials + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | initials | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatypename.md b/docs/models/envelopefieldcreatemanyfieldmetatypename.md new file mode 100644 index 0000000..fb1c5e6 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatypename.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyFieldMetaTypeName + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | name | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatypenumber.md b/docs/models/envelopefieldcreatemanyfieldmetatypenumber.md new file mode 100644 index 0000000..71694ab --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatypenumber.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyFieldMetaTypeNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatyperadio.md b/docs/models/envelopefieldcreatemanyfieldmetatyperadio.md new file mode 100644 index 0000000..979740c --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatyperadio.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyFieldMetaTypeRadio + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatypesignature.md b/docs/models/envelopefieldcreatemanyfieldmetatypesignature.md new file mode 100644 index 0000000..8552b17 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatypesignature.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyFieldMetaTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetatypetext.md b/docs/models/envelopefieldcreatemanyfieldmetatypetext.md new file mode 100644 index 0000000..900d2dd --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetatypetext.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyFieldMetaTypeText + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyfieldmetaunion.md b/docs/models/envelopefieldcreatemanyfieldmetaunion.md new file mode 100644 index 0000000..88f1fd8 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyfieldmetaunion.md @@ -0,0 +1,65 @@ +# EnvelopeFieldCreateManyFieldMetaUnion + + +## Supported Types + +### `models.EnvelopeFieldCreateManyFieldMetaSignatureResponse` + +```python +value: models.EnvelopeFieldCreateManyFieldMetaSignatureResponse = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyFieldMetaInitialsResponse` + +```python +value: models.EnvelopeFieldCreateManyFieldMetaInitialsResponse = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyFieldMetaNameResponse` + +```python +value: models.EnvelopeFieldCreateManyFieldMetaNameResponse = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyFieldMetaEmailResponse` + +```python +value: models.EnvelopeFieldCreateManyFieldMetaEmailResponse = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyFieldMetaDateResponse` + +```python +value: models.EnvelopeFieldCreateManyFieldMetaDateResponse = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyFieldMetaTextResponse` + +```python +value: models.EnvelopeFieldCreateManyFieldMetaTextResponse = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyFieldMetaNumberResponse` + +```python +value: models.EnvelopeFieldCreateManyFieldMetaNumberResponse = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyFieldMetaRadioResponse` + +```python +value: models.EnvelopeFieldCreateManyFieldMetaRadioResponse = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyFieldMetaCheckboxResponse` + +```python +value: models.EnvelopeFieldCreateManyFieldMetaCheckboxResponse = /* values here */ +``` + +### `models.EnvelopeFieldCreateManyFieldMetaDropdownResponse` + +```python +value: models.EnvelopeFieldCreateManyFieldMetaDropdownResponse = /* values here */ +``` + diff --git a/docs/models/envelopefieldcreatemanyforbiddenerror.md b/docs/models/envelopefieldcreatemanyforbiddenerror.md new file mode 100644 index 0000000..e51ecbe --- /dev/null +++ b/docs/models/envelopefieldcreatemanyforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldCreateManyForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeFieldCreateManyForbiddenIssue](../models/envelopefieldcreatemanyforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyforbiddenissue.md b/docs/models/envelopefieldcreatemanyforbiddenissue.md new file mode 100644 index 0000000..f172d06 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyForbiddenIssue + + +## 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/envelopefieldcreatemanyinternalservererror.md similarity index 92% rename from docs/models/documentgetdocumentwithdetailsbyidnotfounderror.md rename to docs/models/envelopefieldcreatemanyinternalservererror.md index 4778e7d..2d1f4f3 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidnotfounderror.md +++ b/docs/models/envelopefieldcreatemanyinternalservererror.md @@ -1,6 +1,6 @@ -# DocumentGetDocumentWithDetailsByIDNotFoundError +# EnvelopeFieldCreateManyInternalServerError -Not found +Internal server error ## Fields @@ -9,4 +9,4 @@ Not found | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `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 +| `issues` | List[[models.EnvelopeFieldCreateManyInternalServerErrorIssue](../models/envelopefieldcreatemanyinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyinternalservererrorissue.md b/docs/models/envelopefieldcreatemanyinternalservererrorissue.md new file mode 100644 index 0000000..11e9837 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyrequest.md b/docs/models/envelopefieldcreatemanyrequest.md new file mode 100644 index 0000000..ca62d95 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyrequest.md @@ -0,0 +1,9 @@ +# EnvelopeFieldCreateManyRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | List[[models.EnvelopeFieldCreateManyDataUnion](../models/envelopefieldcreatemanydataunion.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyresponse.md b/docs/models/envelopefieldcreatemanyresponse.md new file mode 100644 index 0000000..33d2f1e --- /dev/null +++ b/docs/models/envelopefieldcreatemanyresponse.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `data` | List[[models.EnvelopeFieldCreateManyDataResponse](../models/envelopefieldcreatemanydataresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextaligndate.md b/docs/models/envelopefieldcreatemanytextaligndate.md new file mode 100644 index 0000000..67668f7 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextaligndate.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignDate + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextalignemail.md b/docs/models/envelopefieldcreatemanytextalignemail.md new file mode 100644 index 0000000..a68a528 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextalignemail.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignEmail + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextaligninitials.md b/docs/models/envelopefieldcreatemanytextaligninitials.md new file mode 100644 index 0000000..8c1a0a2 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextaligninitials.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignInitials + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextalignname.md b/docs/models/envelopefieldcreatemanytextalignname.md new file mode 100644 index 0000000..5d644e1 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextalignname.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignName + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextalignnumber.md b/docs/models/envelopefieldcreatemanytextalignnumber.md new file mode 100644 index 0000000..713dd72 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextalignnumber.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextalignresponse1.md b/docs/models/envelopefieldcreatemanytextalignresponse1.md new file mode 100644 index 0000000..974049e --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextalignresponse1.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextalignresponse2.md b/docs/models/envelopefieldcreatemanytextalignresponse2.md new file mode 100644 index 0000000..75eac68 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextalignresponse2.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextalignresponse3.md b/docs/models/envelopefieldcreatemanytextalignresponse3.md new file mode 100644 index 0000000..cccf35f --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextalignresponse3.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignResponse3 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextalignresponse4.md b/docs/models/envelopefieldcreatemanytextalignresponse4.md new file mode 100644 index 0000000..0096b9a --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextalignresponse4.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignResponse4 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextalignresponse5.md b/docs/models/envelopefieldcreatemanytextalignresponse5.md new file mode 100644 index 0000000..3ab265b --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextalignresponse5.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignResponse5 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextalignresponse6.md b/docs/models/envelopefieldcreatemanytextalignresponse6.md new file mode 100644 index 0000000..93da92d --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextalignresponse6.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignResponse6 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytextaligntext.md b/docs/models/envelopefieldcreatemanytextaligntext.md new file mode 100644 index 0000000..670b6d0 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytextaligntext.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyTextAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypecheckboxrequest1.md b/docs/models/envelopefieldcreatemanytypecheckboxrequest1.md new file mode 100644 index 0000000..ba77e46 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypecheckboxrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeCheckboxRequest1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | CHECKBOX | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypecheckboxrequest2.md b/docs/models/envelopefieldcreatemanytypecheckboxrequest2.md new file mode 100644 index 0000000..c561218 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypecheckboxrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeCheckboxRequest2 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypedaterequest1.md b/docs/models/envelopefieldcreatemanytypedaterequest1.md new file mode 100644 index 0000000..392f866 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypedaterequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeDateRequest1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | DATE | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypedaterequest2.md b/docs/models/envelopefieldcreatemanytypedaterequest2.md new file mode 100644 index 0000000..45834ed --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypedaterequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeDateRequest2 + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypedropdownrequest1.md b/docs/models/envelopefieldcreatemanytypedropdownrequest1.md new file mode 100644 index 0000000..f680654 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypedropdownrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeDropdownRequest1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | DROPDOWN | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypedropdownrequest2.md b/docs/models/envelopefieldcreatemanytypedropdownrequest2.md new file mode 100644 index 0000000..a6d54ba --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypedropdownrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeDropdownRequest2 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypeemailrequest1.md b/docs/models/envelopefieldcreatemanytypeemailrequest1.md new file mode 100644 index 0000000..f4b55a5 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypeemailrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeEmailRequest1 + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypeemailrequest2.md b/docs/models/envelopefieldcreatemanytypeemailrequest2.md new file mode 100644 index 0000000..c14ce99 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypeemailrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeEmailRequest2 + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | email | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypefreesignature.md b/docs/models/envelopefieldcreatemanytypefreesignature.md new file mode 100644 index 0000000..46c57b9 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypefreesignature.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeFreeSignature + + +## Values + +| Name | Value | +| ---------------- | ---------------- | +| `FREE_SIGNATURE` | FREE_SIGNATURE | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypeinitialsrequest1.md b/docs/models/envelopefieldcreatemanytypeinitialsrequest1.md new file mode 100644 index 0000000..b7746c6 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypeinitialsrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeInitialsRequest1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | INITIALS | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypeinitialsrequest2.md b/docs/models/envelopefieldcreatemanytypeinitialsrequest2.md new file mode 100644 index 0000000..56eb506 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypeinitialsrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeInitialsRequest2 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | initials | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypenamerequest1.md b/docs/models/envelopefieldcreatemanytypenamerequest1.md new file mode 100644 index 0000000..18f4504 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypenamerequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeNameRequest1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | NAME | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypenamerequest2.md b/docs/models/envelopefieldcreatemanytypenamerequest2.md new file mode 100644 index 0000000..5fe62ad --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypenamerequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeNameRequest2 + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | name | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypenumberrequest1.md b/docs/models/envelopefieldcreatemanytypenumberrequest1.md new file mode 100644 index 0000000..043f69d --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypenumberrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeNumberRequest1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | NUMBER | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypenumberrequest2.md b/docs/models/envelopefieldcreatemanytypenumberrequest2.md new file mode 100644 index 0000000..c2d87fc --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypenumberrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeNumberRequest2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytyperadiorequest1.md b/docs/models/envelopefieldcreatemanytyperadiorequest1.md new file mode 100644 index 0000000..1fbf24e --- /dev/null +++ b/docs/models/envelopefieldcreatemanytyperadiorequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeRadioRequest1 + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | RADIO | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytyperadiorequest2.md b/docs/models/envelopefieldcreatemanytyperadiorequest2.md new file mode 100644 index 0000000..cbc3c39 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytyperadiorequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeRadioRequest2 + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytyperesponse.md b/docs/models/envelopefieldcreatemanytyperesponse.md new file mode 100644 index 0000000..7637637 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytyperesponse.md @@ -0,0 +1,18 @@ +# EnvelopeFieldCreateManyTypeResponse + + +## 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/fieldcreatetemplatefieldstypesignature.md b/docs/models/envelopefieldcreatemanytypesignaturerequest1.md similarity index 68% rename from docs/models/fieldcreatetemplatefieldstypesignature.md rename to docs/models/envelopefieldcreatemanytypesignaturerequest1.md index 52b6607..aa3cc4d 100644 --- a/docs/models/fieldcreatetemplatefieldstypesignature.md +++ b/docs/models/envelopefieldcreatemanytypesignaturerequest1.md @@ -1,4 +1,4 @@ -# FieldCreateTemplateFieldsTypeSignature +# EnvelopeFieldCreateManyTypeSignatureRequest1 ## Values diff --git a/docs/models/envelopefieldcreatemanytypesignaturerequest2.md b/docs/models/envelopefieldcreatemanytypesignaturerequest2.md new file mode 100644 index 0000000..6e973b0 --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypesignaturerequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeSignatureRequest2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypetextrequest1.md b/docs/models/envelopefieldcreatemanytypetextrequest1.md new file mode 100644 index 0000000..d66b98e --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypetextrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeTextRequest1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | TEXT | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanytypetextrequest2.md b/docs/models/envelopefieldcreatemanytypetextrequest2.md new file mode 100644 index 0000000..1eda1bd --- /dev/null +++ b/docs/models/envelopefieldcreatemanytypetextrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyTypeTextRequest2 + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyunauthorizederror.md b/docs/models/envelopefieldcreatemanyunauthorizederror.md new file mode 100644 index 0000000..009643f --- /dev/null +++ b/docs/models/envelopefieldcreatemanyunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldCreateManyUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeFieldCreateManyUnauthorizedIssue](../models/envelopefieldcreatemanyunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyunauthorizedissue.md b/docs/models/envelopefieldcreatemanyunauthorizedissue.md new file mode 100644 index 0000000..2322bb1 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyvaluecheckbox.md b/docs/models/envelopefieldcreatemanyvaluecheckbox.md new file mode 100644 index 0000000..ca5b264 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyvaluecheckbox.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyValueCheckbox + + +## 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/envelopefieldcreatemanyvaluedropdown.md b/docs/models/envelopefieldcreatemanyvaluedropdown.md new file mode 100644 index 0000000..a93fb56 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyvaluedropdown.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyValueDropdown + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyvalueradio.md b/docs/models/envelopefieldcreatemanyvalueradio.md new file mode 100644 index 0000000..a4d4a91 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyvalueradio.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyValueRadio + + +## 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/envelopefieldcreatemanyvalueresponse1.md b/docs/models/envelopefieldcreatemanyvalueresponse1.md new file mode 100644 index 0000000..3134859 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyvalueresponse1.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyValueResponse1 + + +## 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/envelopefieldcreatemanyvalueresponse2.md b/docs/models/envelopefieldcreatemanyvalueresponse2.md new file mode 100644 index 0000000..c47765e --- /dev/null +++ b/docs/models/envelopefieldcreatemanyvalueresponse2.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyValueResponse2 + + +## 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/envelopefieldcreatemanyvalueresponse3.md b/docs/models/envelopefieldcreatemanyvalueresponse3.md new file mode 100644 index 0000000..548c475 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyvalueresponse3.md @@ -0,0 +1,8 @@ +# EnvelopeFieldCreateManyValueResponse3 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyverticalalignnumber.md b/docs/models/envelopefieldcreatemanyverticalalignnumber.md new file mode 100644 index 0000000..4bf327f --- /dev/null +++ b/docs/models/envelopefieldcreatemanyverticalalignnumber.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyverticalalignresponse1.md b/docs/models/envelopefieldcreatemanyverticalalignresponse1.md new file mode 100644 index 0000000..30fa2a8 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyverticalalignresponse1.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyVerticalAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyverticalalignresponse2.md b/docs/models/envelopefieldcreatemanyverticalalignresponse2.md new file mode 100644 index 0000000..25534e1 --- /dev/null +++ b/docs/models/envelopefieldcreatemanyverticalalignresponse2.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyVerticalAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopefieldcreatemanyverticalaligntext.md b/docs/models/envelopefieldcreatemanyverticalaligntext.md new file mode 100644 index 0000000..ad756ee --- /dev/null +++ b/docs/models/envelopefieldcreatemanyverticalaligntext.md @@ -0,0 +1,10 @@ +# EnvelopeFieldCreateManyVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/documentfinddocumentsnotfounderror.md b/docs/models/envelopefielddeletebadrequesterror.md similarity index 91% rename from docs/models/documentfinddocumentsnotfounderror.md rename to docs/models/envelopefielddeletebadrequesterror.md index 06f1f36..4a42ccc 100644 --- a/docs/models/documentfinddocumentsnotfounderror.md +++ b/docs/models/envelopefielddeletebadrequesterror.md @@ -1,6 +1,6 @@ -# DocumentFindDocumentsNotFoundError +# EnvelopeFieldDeleteBadRequestError -Not found +Invalid input data ## Fields @@ -9,4 +9,4 @@ Not found | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `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 +| `issues` | List[[models.EnvelopeFieldDeleteBadRequestIssue](../models/envelopefielddeletebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefielddeletebadrequestissue.md b/docs/models/envelopefielddeletebadrequestissue.md new file mode 100644 index 0000000..55ffae8 --- /dev/null +++ b/docs/models/envelopefielddeletebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldDeleteBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefielddeleteforbiddenerror.md b/docs/models/envelopefielddeleteforbiddenerror.md new file mode 100644 index 0000000..23d4835 --- /dev/null +++ b/docs/models/envelopefielddeleteforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldDeleteForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeFieldDeleteForbiddenIssue](../models/envelopefielddeleteforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefielddeleteforbiddenissue.md b/docs/models/envelopefielddeleteforbiddenissue.md new file mode 100644 index 0000000..de78568 --- /dev/null +++ b/docs/models/envelopefielddeleteforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldDeleteForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefielddeleteinternalservererror.md b/docs/models/envelopefielddeleteinternalservererror.md new file mode 100644 index 0000000..c046d28 --- /dev/null +++ b/docs/models/envelopefielddeleteinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldDeleteInternalServerError + +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.EnvelopeFieldDeleteInternalServerErrorIssue](../models/envelopefielddeleteinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefielddeleteinternalservererrorissue.md b/docs/models/envelopefielddeleteinternalservererrorissue.md new file mode 100644 index 0000000..0768a61 --- /dev/null +++ b/docs/models/envelopefielddeleteinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldDeleteInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefielddeleterequest.md b/docs/models/envelopefielddeleterequest.md new file mode 100644 index 0000000..9e99e4e --- /dev/null +++ b/docs/models/envelopefielddeleterequest.md @@ -0,0 +1,8 @@ +# EnvelopeFieldDeleteRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `field_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefielddeleteresponse.md b/docs/models/envelopefielddeleteresponse.md new file mode 100644 index 0000000..4b037c5 --- /dev/null +++ b/docs/models/envelopefielddeleteresponse.md @@ -0,0 +1,10 @@ +# EnvelopeFieldDeleteResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefielddeleteunauthorizederror.md b/docs/models/envelopefielddeleteunauthorizederror.md new file mode 100644 index 0000000..1a7e795 --- /dev/null +++ b/docs/models/envelopefielddeleteunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldDeleteUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeFieldDeleteUnauthorizedIssue](../models/envelopefielddeleteunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefielddeleteunauthorizedissue.md b/docs/models/envelopefielddeleteunauthorizedissue.md new file mode 100644 index 0000000..af0c380 --- /dev/null +++ b/docs/models/envelopefielddeleteunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldDeleteUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetbadrequesterror.md b/docs/models/envelopefieldgetbadrequesterror.md new file mode 100644 index 0000000..ba1cd95 --- /dev/null +++ b/docs/models/envelopefieldgetbadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldGetBadRequestError + +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.EnvelopeFieldGetBadRequestIssue](../models/envelopefieldgetbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetbadrequestissue.md b/docs/models/envelopefieldgetbadrequestissue.md new file mode 100644 index 0000000..2f72505 --- /dev/null +++ b/docs/models/envelopefieldgetbadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetdirection1.md b/docs/models/envelopefieldgetdirection1.md new file mode 100644 index 0000000..94b6967 --- /dev/null +++ b/docs/models/envelopefieldgetdirection1.md @@ -0,0 +1,9 @@ +# EnvelopeFieldGetDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopefieldgetdirection2.md b/docs/models/envelopefieldgetdirection2.md new file mode 100644 index 0000000..2fdcd87 --- /dev/null +++ b/docs/models/envelopefieldgetdirection2.md @@ -0,0 +1,9 @@ +# EnvelopeFieldGetDirection2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopefieldgetfieldmetacheckbox.md b/docs/models/envelopefieldgetfieldmetacheckbox.md new file mode 100644 index 0000000..c975d6b --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetacheckbox.md @@ -0,0 +1,17 @@ +# EnvelopeFieldGetFieldMetaCheckbox + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldGetTypeCheckbox](../models/envelopefieldgettypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldGetValue2](../models/envelopefieldgetvalue2.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.EnvelopeFieldGetDirection2]](../models/envelopefieldgetdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetfieldmetadate.md b/docs/models/envelopefieldgetfieldmetadate.md new file mode 100644 index 0000000..2bd4dcc --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetadate.md @@ -0,0 +1,14 @@ +# EnvelopeFieldGetFieldMetaDate + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldGetTypeDate](../models/envelopefieldgettypedate.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldGetTextAlign4]](../models/envelopefieldgettextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetfieldmetadropdown.md b/docs/models/envelopefieldgetfieldmetadropdown.md new file mode 100644 index 0000000..14a480f --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetadropdown.md @@ -0,0 +1,15 @@ +# EnvelopeFieldGetFieldMetaDropdown + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldGetTypeDropdown](../models/envelopefieldgettypedropdown.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldGetValue3](../models/envelopefieldgetvalue3.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/envelopefieldgetfieldmetaemail.md b/docs/models/envelopefieldgetfieldmetaemail.md new file mode 100644 index 0000000..fe827b0 --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetaemail.md @@ -0,0 +1,14 @@ +# EnvelopeFieldGetFieldMetaEmail + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldGetTypeEmail](../models/envelopefieldgettypeemail.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldGetTextAlign3]](../models/envelopefieldgettextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetfieldmetainitials.md b/docs/models/envelopefieldgetfieldmetainitials.md new file mode 100644 index 0000000..33891ef --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetainitials.md @@ -0,0 +1,14 @@ +# EnvelopeFieldGetFieldMetaInitials + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldGetTypeInitials](../models/envelopefieldgettypeinitials.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldGetTextAlign1]](../models/envelopefieldgettextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetfieldmetaname.md b/docs/models/envelopefieldgetfieldmetaname.md new file mode 100644 index 0000000..c4d8c72 --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetaname.md @@ -0,0 +1,14 @@ +# EnvelopeFieldGetFieldMetaName + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldGetTypeName](../models/envelopefieldgettypename.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldGetTextAlign2]](../models/envelopefieldgettextalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetfieldmetanumber.md b/docs/models/envelopefieldgetfieldmetanumber.md new file mode 100644 index 0000000..b2da157 --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetanumber.md @@ -0,0 +1,21 @@ +# EnvelopeFieldGetFieldMetaNumber + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldGetTypeNumber](../models/envelopefieldgettypenumber.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 | +| `text_align` | [Optional[models.EnvelopeFieldGetTextAlign6]](../models/envelopefieldgettextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeFieldGetVerticalAlign2]](../models/envelopefieldgetverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetfieldmetaradio.md b/docs/models/envelopefieldgetfieldmetaradio.md new file mode 100644 index 0000000..9e6d2ec --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetaradio.md @@ -0,0 +1,15 @@ +# EnvelopeFieldGetFieldMetaRadio + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldGetTypeRadio](../models/envelopefieldgettyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldGetValue1](../models/envelopefieldgetvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.EnvelopeFieldGetDirection1]](../models/envelopefieldgetdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetfieldmetasignature.md b/docs/models/envelopefieldgetfieldmetasignature.md new file mode 100644 index 0000000..b93d3d0 --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetasignature.md @@ -0,0 +1,13 @@ +# EnvelopeFieldGetFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldGetTypeSignature](../models/envelopefieldgettypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetfieldmetatext.md b/docs/models/envelopefieldgetfieldmetatext.md new file mode 100644 index 0000000..bae7020 --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetatext.md @@ -0,0 +1,19 @@ +# EnvelopeFieldGetFieldMetaText + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldGetTypeText](../models/envelopefieldgettypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldGetTextAlign5]](../models/envelopefieldgettextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeFieldGetVerticalAlign1]](../models/envelopefieldgetverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetfieldmetaunion.md b/docs/models/envelopefieldgetfieldmetaunion.md new file mode 100644 index 0000000..098e9e4 --- /dev/null +++ b/docs/models/envelopefieldgetfieldmetaunion.md @@ -0,0 +1,65 @@ +# EnvelopeFieldGetFieldMetaUnion + + +## Supported Types + +### `models.EnvelopeFieldGetFieldMetaSignature` + +```python +value: models.EnvelopeFieldGetFieldMetaSignature = /* values here */ +``` + +### `models.EnvelopeFieldGetFieldMetaInitials` + +```python +value: models.EnvelopeFieldGetFieldMetaInitials = /* values here */ +``` + +### `models.EnvelopeFieldGetFieldMetaName` + +```python +value: models.EnvelopeFieldGetFieldMetaName = /* values here */ +``` + +### `models.EnvelopeFieldGetFieldMetaEmail` + +```python +value: models.EnvelopeFieldGetFieldMetaEmail = /* values here */ +``` + +### `models.EnvelopeFieldGetFieldMetaDate` + +```python +value: models.EnvelopeFieldGetFieldMetaDate = /* values here */ +``` + +### `models.EnvelopeFieldGetFieldMetaText` + +```python +value: models.EnvelopeFieldGetFieldMetaText = /* values here */ +``` + +### `models.EnvelopeFieldGetFieldMetaNumber` + +```python +value: models.EnvelopeFieldGetFieldMetaNumber = /* values here */ +``` + +### `models.EnvelopeFieldGetFieldMetaRadio` + +```python +value: models.EnvelopeFieldGetFieldMetaRadio = /* values here */ +``` + +### `models.EnvelopeFieldGetFieldMetaCheckbox` + +```python +value: models.EnvelopeFieldGetFieldMetaCheckbox = /* values here */ +``` + +### `models.EnvelopeFieldGetFieldMetaDropdown` + +```python +value: models.EnvelopeFieldGetFieldMetaDropdown = /* values here */ +``` + diff --git a/docs/models/envelopefieldgetforbiddenerror.md b/docs/models/envelopefieldgetforbiddenerror.md new file mode 100644 index 0000000..54a1d9d --- /dev/null +++ b/docs/models/envelopefieldgetforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldGetForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeFieldGetForbiddenIssue](../models/envelopefieldgetforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetforbiddenissue.md b/docs/models/envelopefieldgetforbiddenissue.md new file mode 100644 index 0000000..f470610 --- /dev/null +++ b/docs/models/envelopefieldgetforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetinternalservererror.md b/docs/models/envelopefieldgetinternalservererror.md new file mode 100644 index 0000000..d6b39d6 --- /dev/null +++ b/docs/models/envelopefieldgetinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldGetInternalServerError + +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.EnvelopeFieldGetInternalServerErrorIssue](../models/envelopefieldgetinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetinternalservererrorissue.md b/docs/models/envelopefieldgetinternalservererrorissue.md new file mode 100644 index 0000000..e616cdb --- /dev/null +++ b/docs/models/envelopefieldgetinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetnotfounderror.md b/docs/models/envelopefieldgetnotfounderror.md new file mode 100644 index 0000000..bdae9dc --- /dev/null +++ b/docs/models/envelopefieldgetnotfounderror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldGetNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeFieldGetNotFoundIssue](../models/envelopefieldgetnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetnotfoundissue.md b/docs/models/envelopefieldgetnotfoundissue.md new file mode 100644 index 0000000..390d294 --- /dev/null +++ b/docs/models/envelopefieldgetnotfoundissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetNotFoundIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetrequest.md b/docs/models/envelopefieldgetrequest.md new file mode 100644 index 0000000..d6ec4b8 --- /dev/null +++ b/docs/models/envelopefieldgetrequest.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `field_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetresponse.md b/docs/models/envelopefieldgetresponse.md new file mode 100644 index 0000000..b43fd30 --- /dev/null +++ b/docs/models/envelopefieldgetresponse.md @@ -0,0 +1,23 @@ +# EnvelopeFieldGetResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeFieldGetType](../models/envelopefieldgettype.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: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | N/A | +| `custom_text` | *str* | :heavy_check_mark: | N/A | +| `inserted` | *bool* | :heavy_check_mark: | N/A | +| `field_meta` | [Nullable[models.EnvelopeFieldGetFieldMetaUnion]](../models/envelopefieldgetfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgettextalign1.md b/docs/models/envelopefieldgettextalign1.md new file mode 100644 index 0000000..0b14232 --- /dev/null +++ b/docs/models/envelopefieldgettextalign1.md @@ -0,0 +1,10 @@ +# EnvelopeFieldGetTextAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldgettextalign2.md b/docs/models/envelopefieldgettextalign2.md new file mode 100644 index 0000000..b313c2d --- /dev/null +++ b/docs/models/envelopefieldgettextalign2.md @@ -0,0 +1,10 @@ +# EnvelopeFieldGetTextAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldgettextalign3.md b/docs/models/envelopefieldgettextalign3.md new file mode 100644 index 0000000..c571851 --- /dev/null +++ b/docs/models/envelopefieldgettextalign3.md @@ -0,0 +1,10 @@ +# EnvelopeFieldGetTextAlign3 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldgettextalign4.md b/docs/models/envelopefieldgettextalign4.md new file mode 100644 index 0000000..8e0d489 --- /dev/null +++ b/docs/models/envelopefieldgettextalign4.md @@ -0,0 +1,10 @@ +# EnvelopeFieldGetTextAlign4 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldgettextalign5.md b/docs/models/envelopefieldgettextalign5.md new file mode 100644 index 0000000..8636ab8 --- /dev/null +++ b/docs/models/envelopefieldgettextalign5.md @@ -0,0 +1,10 @@ +# EnvelopeFieldGetTextAlign5 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldgettextalign6.md b/docs/models/envelopefieldgettextalign6.md new file mode 100644 index 0000000..4aed02d --- /dev/null +++ b/docs/models/envelopefieldgettextalign6.md @@ -0,0 +1,10 @@ +# EnvelopeFieldGetTextAlign6 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldgettype.md b/docs/models/envelopefieldgettype.md new file mode 100644 index 0000000..4a42e8c --- /dev/null +++ b/docs/models/envelopefieldgettype.md @@ -0,0 +1,18 @@ +# EnvelopeFieldGetType + + +## 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/envelopefieldgettypecheckbox.md b/docs/models/envelopefieldgettypecheckbox.md new file mode 100644 index 0000000..e4c15be --- /dev/null +++ b/docs/models/envelopefieldgettypecheckbox.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetTypeCheckbox + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/envelopefieldgettypedate.md b/docs/models/envelopefieldgettypedate.md new file mode 100644 index 0000000..a2f202a --- /dev/null +++ b/docs/models/envelopefieldgettypedate.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetTypeDate + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/envelopefieldgettypedropdown.md b/docs/models/envelopefieldgettypedropdown.md new file mode 100644 index 0000000..96ab39d --- /dev/null +++ b/docs/models/envelopefieldgettypedropdown.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetTypeDropdown + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/envelopefieldgettypeemail.md b/docs/models/envelopefieldgettypeemail.md new file mode 100644 index 0000000..c49f956 --- /dev/null +++ b/docs/models/envelopefieldgettypeemail.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetTypeEmail + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | email | \ No newline at end of file diff --git a/docs/models/envelopefieldgettypeinitials.md b/docs/models/envelopefieldgettypeinitials.md new file mode 100644 index 0000000..7140958 --- /dev/null +++ b/docs/models/envelopefieldgettypeinitials.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetTypeInitials + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | initials | \ No newline at end of file diff --git a/docs/models/envelopefieldgettypename.md b/docs/models/envelopefieldgettypename.md new file mode 100644 index 0000000..b10f480 --- /dev/null +++ b/docs/models/envelopefieldgettypename.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetTypeName + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | name | \ No newline at end of file diff --git a/docs/models/envelopefieldgettypenumber.md b/docs/models/envelopefieldgettypenumber.md new file mode 100644 index 0000000..2e59eb8 --- /dev/null +++ b/docs/models/envelopefieldgettypenumber.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetTypeNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/envelopefieldgettyperadio.md b/docs/models/envelopefieldgettyperadio.md new file mode 100644 index 0000000..3e6ed82 --- /dev/null +++ b/docs/models/envelopefieldgettyperadio.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetTypeRadio + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/envelopefieldgettypesignature.md b/docs/models/envelopefieldgettypesignature.md new file mode 100644 index 0000000..a5f3d7f --- /dev/null +++ b/docs/models/envelopefieldgettypesignature.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/envelopefieldgettypetext.md b/docs/models/envelopefieldgettypetext.md new file mode 100644 index 0000000..c18e867 --- /dev/null +++ b/docs/models/envelopefieldgettypetext.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetTypeText + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/envelopefieldgetunauthorizederror.md b/docs/models/envelopefieldgetunauthorizederror.md new file mode 100644 index 0000000..7ba6cb1 --- /dev/null +++ b/docs/models/envelopefieldgetunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldGetUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeFieldGetUnauthorizedIssue](../models/envelopefieldgetunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetunauthorizedissue.md b/docs/models/envelopefieldgetunauthorizedissue.md new file mode 100644 index 0000000..731fef3 --- /dev/null +++ b/docs/models/envelopefieldgetunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetvalue1.md b/docs/models/envelopefieldgetvalue1.md new file mode 100644 index 0000000..74e901b --- /dev/null +++ b/docs/models/envelopefieldgetvalue1.md @@ -0,0 +1,10 @@ +# EnvelopeFieldGetValue1 + + +## 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/envelopefieldgetvalue2.md b/docs/models/envelopefieldgetvalue2.md new file mode 100644 index 0000000..12e0224 --- /dev/null +++ b/docs/models/envelopefieldgetvalue2.md @@ -0,0 +1,10 @@ +# EnvelopeFieldGetValue2 + + +## 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/envelopefieldgetvalue3.md b/docs/models/envelopefieldgetvalue3.md new file mode 100644 index 0000000..e2afdba --- /dev/null +++ b/docs/models/envelopefieldgetvalue3.md @@ -0,0 +1,8 @@ +# EnvelopeFieldGetValue3 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldgetverticalalign1.md b/docs/models/envelopefieldgetverticalalign1.md new file mode 100644 index 0000000..aa133a9 --- /dev/null +++ b/docs/models/envelopefieldgetverticalalign1.md @@ -0,0 +1,10 @@ +# EnvelopeFieldGetVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopefieldgetverticalalign2.md b/docs/models/envelopefieldgetverticalalign2.md new file mode 100644 index 0000000..0d64415 --- /dev/null +++ b/docs/models/envelopefieldgetverticalalign2.md @@ -0,0 +1,10 @@ +# EnvelopeFieldGetVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanybadrequesterror.md b/docs/models/envelopefieldupdatemanybadrequesterror.md new file mode 100644 index 0000000..c7a5b5b --- /dev/null +++ b/docs/models/envelopefieldupdatemanybadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldUpdateManyBadRequestError + +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.EnvelopeFieldUpdateManyBadRequestIssue](../models/envelopefieldupdatemanybadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanybadrequestissue.md b/docs/models/envelopefieldupdatemanybadrequestissue.md new file mode 100644 index 0000000..fcc63a4 --- /dev/null +++ b/docs/models/envelopefieldupdatemanybadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydatacheckbox.md b/docs/models/envelopefieldupdatemanydatacheckbox.md new file mode 100644 index 0000000..2db0ac3 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydatacheckbox.md @@ -0,0 +1,16 @@ +# EnvelopeFieldUpdateManyDataCheckbox + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldUpdateManyTypeCheckboxRequest1](../models/envelopefieldupdatemanytypecheckboxrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldUpdateManyFieldMetaCheckboxRequest]](../models/envelopefieldupdatemanyfieldmetacheckboxrequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydatadate.md b/docs/models/envelopefieldupdatemanydatadate.md new file mode 100644 index 0000000..7d8430e --- /dev/null +++ b/docs/models/envelopefieldupdatemanydatadate.md @@ -0,0 +1,16 @@ +# EnvelopeFieldUpdateManyDataDate + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeFieldUpdateManyTypeDateRequest1](../models/envelopefieldupdatemanytypedaterequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldUpdateManyFieldMetaDateRequest]](../models/envelopefieldupdatemanyfieldmetadaterequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydatadropdown.md b/docs/models/envelopefieldupdatemanydatadropdown.md new file mode 100644 index 0000000..e390890 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydatadropdown.md @@ -0,0 +1,16 @@ +# EnvelopeFieldUpdateManyDataDropdown + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldUpdateManyTypeDropdownRequest1](../models/envelopefieldupdatemanytypedropdownrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldUpdateManyFieldMetaDropdownRequest]](../models/envelopefieldupdatemanyfieldmetadropdownrequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetatext.md b/docs/models/envelopefieldupdatemanydataemail.md similarity index 79% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetatext.md rename to docs/models/envelopefieldupdatemanydataemail.md index 9bb8610..3cdc984 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetatext.md +++ b/docs/models/envelopefieldupdatemanydataemail.md @@ -1,16 +1,16 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaText +# EnvelopeFieldUpdateManyDataEmail ## 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 +| `type` | [models.EnvelopeFieldUpdateManyTypeEmailRequest1](../models/envelopefieldupdatemanytypeemailrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldUpdateManyFieldMetaEmailRequest]](../models/envelopefieldupdatemanyfieldmetaemailrequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydatafreesignature.md b/docs/models/envelopefieldupdatemanydatafreesignature.md new file mode 100644 index 0000000..ba17349 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydatafreesignature.md @@ -0,0 +1,15 @@ +# EnvelopeFieldUpdateManyDataFreeSignature + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldUpdateManyTypeFreeSignature](../models/envelopefieldupdatemanytypefreesignature.md) | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydatainitials.md b/docs/models/envelopefieldupdatemanydatainitials.md new file mode 100644 index 0000000..c53e813 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydatainitials.md @@ -0,0 +1,16 @@ +# EnvelopeFieldUpdateManyDataInitials + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldUpdateManyTypeInitialsRequest1](../models/envelopefieldupdatemanytypeinitialsrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldUpdateManyFieldMetaInitialsRequest]](../models/envelopefieldupdatemanyfieldmetainitialsrequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydataname.md b/docs/models/envelopefieldupdatemanydataname.md new file mode 100644 index 0000000..9ee2564 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydataname.md @@ -0,0 +1,16 @@ +# EnvelopeFieldUpdateManyDataName + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeFieldUpdateManyTypeNameRequest1](../models/envelopefieldupdatemanytypenamerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldUpdateManyFieldMetaNameRequest]](../models/envelopefieldupdatemanyfieldmetanamerequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydatanumber.md b/docs/models/envelopefieldupdatemanydatanumber.md new file mode 100644 index 0000000..d41f3f7 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydatanumber.md @@ -0,0 +1,16 @@ +# EnvelopeFieldUpdateManyDataNumber + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldUpdateManyTypeNumberRequest1](../models/envelopefieldupdatemanytypenumberrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldUpdateManyFieldMetaNumberRequest]](../models/envelopefieldupdatemanyfieldmetanumberrequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaname.md b/docs/models/envelopefieldupdatemanydataradio.md similarity index 66% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetaname.md rename to docs/models/envelopefieldupdatemanydataradio.md index d394d3d..da608b4 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetaname.md +++ b/docs/models/envelopefieldupdatemanydataradio.md @@ -1,14 +1,16 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaName +# EnvelopeFieldUpdateManyDataRadio ## 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 +| `type` | [models.EnvelopeFieldUpdateManyTypeRadioRequest1](../models/envelopefieldupdatemanytyperadiorequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldUpdateManyFieldMetaRadioRequest]](../models/envelopefieldupdatemanyfieldmetaradiorequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydataresponse.md b/docs/models/envelopefieldupdatemanydataresponse.md new file mode 100644 index 0000000..f5c03d1 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydataresponse.md @@ -0,0 +1,23 @@ +# EnvelopeFieldUpdateManyDataResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyTypeResponse](../models/envelopefieldupdatemanytyperesponse.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: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | N/A | +| `custom_text` | *str* | :heavy_check_mark: | N/A | +| `inserted` | *bool* | :heavy_check_mark: | N/A | +| `field_meta` | [Nullable[models.EnvelopeFieldUpdateManyFieldMetaUnion]](../models/envelopefieldupdatemanyfieldmetaunion.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/envelopefieldupdatemanydatasignature.md b/docs/models/envelopefieldupdatemanydatasignature.md new file mode 100644 index 0000000..1c0cc42 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydatasignature.md @@ -0,0 +1,16 @@ +# EnvelopeFieldUpdateManyDataSignature + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.EnvelopeFieldUpdateManyTypeSignatureRequest1](../models/envelopefieldupdatemanytypesignaturerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldUpdateManyFieldMetaSignatureRequest]](../models/envelopefieldupdatemanyfieldmetasignaturerequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydatatext.md b/docs/models/envelopefieldupdatemanydatatext.md new file mode 100644 index 0000000..2b601f0 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydatatext.md @@ -0,0 +1,16 @@ +# EnvelopeFieldUpdateManyDataText + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.EnvelopeFieldUpdateManyTypeTextRequest1](../models/envelopefieldupdatemanytypetextrequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.EnvelopeFieldUpdateManyFieldMetaTextRequest]](../models/envelopefieldupdatemanyfieldmetatextrequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `page` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `position_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydataunion.md b/docs/models/envelopefieldupdatemanydataunion.md new file mode 100644 index 0000000..04474df --- /dev/null +++ b/docs/models/envelopefieldupdatemanydataunion.md @@ -0,0 +1,71 @@ +# EnvelopeFieldUpdateManyDataUnion + + +## Supported Types + +### `models.EnvelopeFieldUpdateManyDataSignature` + +```python +value: models.EnvelopeFieldUpdateManyDataSignature = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyDataFreeSignature` + +```python +value: models.EnvelopeFieldUpdateManyDataFreeSignature = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyDataInitials` + +```python +value: models.EnvelopeFieldUpdateManyDataInitials = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyDataName` + +```python +value: models.EnvelopeFieldUpdateManyDataName = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyDataEmail` + +```python +value: models.EnvelopeFieldUpdateManyDataEmail = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyDataDate` + +```python +value: models.EnvelopeFieldUpdateManyDataDate = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyDataText` + +```python +value: models.EnvelopeFieldUpdateManyDataText = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyDataNumber` + +```python +value: models.EnvelopeFieldUpdateManyDataNumber = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyDataRadio` + +```python +value: models.EnvelopeFieldUpdateManyDataRadio = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyDataCheckbox` + +```python +value: models.EnvelopeFieldUpdateManyDataCheckbox = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyDataDropdown` + +```python +value: models.EnvelopeFieldUpdateManyDataDropdown = /* values here */ +``` + diff --git a/docs/models/envelopefieldupdatemanydirectioncheckbox.md b/docs/models/envelopefieldupdatemanydirectioncheckbox.md new file mode 100644 index 0000000..d1b20b8 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydirectioncheckbox.md @@ -0,0 +1,9 @@ +# EnvelopeFieldUpdateManyDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydirectionradio.md b/docs/models/envelopefieldupdatemanydirectionradio.md new file mode 100644 index 0000000..50be63b --- /dev/null +++ b/docs/models/envelopefieldupdatemanydirectionradio.md @@ -0,0 +1,9 @@ +# EnvelopeFieldUpdateManyDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydirectionresponse1.md b/docs/models/envelopefieldupdatemanydirectionresponse1.md new file mode 100644 index 0000000..e94ae67 --- /dev/null +++ b/docs/models/envelopefieldupdatemanydirectionresponse1.md @@ -0,0 +1,9 @@ +# EnvelopeFieldUpdateManyDirectionResponse1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanydirectionresponse2.md b/docs/models/envelopefieldupdatemanydirectionresponse2.md new file mode 100644 index 0000000..895f6ec --- /dev/null +++ b/docs/models/envelopefieldupdatemanydirectionresponse2.md @@ -0,0 +1,9 @@ +# EnvelopeFieldUpdateManyDirectionResponse2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetacheckboxrequest.md b/docs/models/envelopefieldupdatemanyfieldmetacheckboxrequest.md new file mode 100644 index 0000000..21025c5 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetacheckboxrequest.md @@ -0,0 +1,17 @@ +# EnvelopeFieldUpdateManyFieldMetaCheckboxRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyTypeCheckboxRequest2](../models/envelopefieldupdatemanytypecheckboxrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldUpdateManyValueCheckbox](../models/envelopefieldupdatemanyvaluecheckbox.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.EnvelopeFieldUpdateManyDirectionCheckbox]](../models/envelopefieldupdatemanydirectioncheckbox.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetacheckboxresponse.md b/docs/models/envelopefieldupdatemanyfieldmetacheckboxresponse.md new file mode 100644 index 0000000..6f344a5 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetacheckboxresponse.md @@ -0,0 +1,17 @@ +# EnvelopeFieldUpdateManyFieldMetaCheckboxResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyFieldMetaTypeCheckbox](../models/envelopefieldupdatemanyfieldmetatypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldUpdateManyValueResponse2](../models/envelopefieldupdatemanyvalueresponse2.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.EnvelopeFieldUpdateManyDirectionResponse2]](../models/envelopefieldupdatemanydirectionresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetadaterequest.md b/docs/models/envelopefieldupdatemanyfieldmetadaterequest.md new file mode 100644 index 0000000..0502598 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetadaterequest.md @@ -0,0 +1,14 @@ +# EnvelopeFieldUpdateManyFieldMetaDateRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyTypeDateRequest2](../models/envelopefieldupdatemanytypedaterequest2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignDate]](../models/envelopefieldupdatemanytextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetadateresponse.md b/docs/models/envelopefieldupdatemanyfieldmetadateresponse.md new file mode 100644 index 0000000..1a4220d --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetadateresponse.md @@ -0,0 +1,14 @@ +# EnvelopeFieldUpdateManyFieldMetaDateResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyFieldMetaTypeDate](../models/envelopefieldupdatemanyfieldmetatypedate.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignResponse4]](../models/envelopefieldupdatemanytextalignresponse4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetadropdownrequest.md b/docs/models/envelopefieldupdatemanyfieldmetadropdownrequest.md new file mode 100644 index 0000000..f5d93da --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetadropdownrequest.md @@ -0,0 +1,15 @@ +# EnvelopeFieldUpdateManyFieldMetaDropdownRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyTypeDropdownRequest2](../models/envelopefieldupdatemanytypedropdownrequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldUpdateManyValueDropdown](../models/envelopefieldupdatemanyvaluedropdown.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/envelopefieldupdatemanyfieldmetadropdownresponse.md b/docs/models/envelopefieldupdatemanyfieldmetadropdownresponse.md new file mode 100644 index 0000000..475dedc --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetadropdownresponse.md @@ -0,0 +1,15 @@ +# EnvelopeFieldUpdateManyFieldMetaDropdownResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyFieldMetaTypeDropdown](../models/envelopefieldupdatemanyfieldmetatypedropdown.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldUpdateManyValueResponse3](../models/envelopefieldupdatemanyvalueresponse3.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/envelopefieldupdatemanyfieldmetaemailrequest.md b/docs/models/envelopefieldupdatemanyfieldmetaemailrequest.md new file mode 100644 index 0000000..e44478f --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetaemailrequest.md @@ -0,0 +1,14 @@ +# EnvelopeFieldUpdateManyFieldMetaEmailRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyTypeEmailRequest2](../models/envelopefieldupdatemanytypeemailrequest2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignEmail]](../models/envelopefieldupdatemanytextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetaemailresponse.md b/docs/models/envelopefieldupdatemanyfieldmetaemailresponse.md new file mode 100644 index 0000000..3cd7c2c --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetaemailresponse.md @@ -0,0 +1,14 @@ +# EnvelopeFieldUpdateManyFieldMetaEmailResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyFieldMetaTypeEmail](../models/envelopefieldupdatemanyfieldmetatypeemail.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignResponse3]](../models/envelopefieldupdatemanytextalignresponse3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetainitialsrequest.md b/docs/models/envelopefieldupdatemanyfieldmetainitialsrequest.md new file mode 100644 index 0000000..d062f42 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetainitialsrequest.md @@ -0,0 +1,14 @@ +# EnvelopeFieldUpdateManyFieldMetaInitialsRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyTypeInitialsRequest2](../models/envelopefieldupdatemanytypeinitialsrequest2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignInitials]](../models/envelopefieldupdatemanytextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetainitialsresponse.md b/docs/models/envelopefieldupdatemanyfieldmetainitialsresponse.md new file mode 100644 index 0000000..63ba2a9 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetainitialsresponse.md @@ -0,0 +1,14 @@ +# EnvelopeFieldUpdateManyFieldMetaInitialsResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyFieldMetaTypeInitials](../models/envelopefieldupdatemanyfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignResponse1]](../models/envelopefieldupdatemanytextalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetanamerequest.md b/docs/models/envelopefieldupdatemanyfieldmetanamerequest.md new file mode 100644 index 0000000..5a2fb6a --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetanamerequest.md @@ -0,0 +1,14 @@ +# EnvelopeFieldUpdateManyFieldMetaNameRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyTypeNameRequest2](../models/envelopefieldupdatemanytypenamerequest2.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignName]](../models/envelopefieldupdatemanytextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetanameresponse.md b/docs/models/envelopefieldupdatemanyfieldmetanameresponse.md new file mode 100644 index 0000000..88cd8d3 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetanameresponse.md @@ -0,0 +1,14 @@ +# EnvelopeFieldUpdateManyFieldMetaNameResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyFieldMetaTypeName](../models/envelopefieldupdatemanyfieldmetatypename.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignResponse2]](../models/envelopefieldupdatemanytextalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetanumberrequest.md b/docs/models/envelopefieldupdatemanyfieldmetanumberrequest.md new file mode 100644 index 0000000..c95e894 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetanumberrequest.md @@ -0,0 +1,21 @@ +# EnvelopeFieldUpdateManyFieldMetaNumberRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyTypeNumberRequest2](../models/envelopefieldupdatemanytypenumberrequest2.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 | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignNumber]](../models/envelopefieldupdatemanytextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeFieldUpdateManyVerticalAlignNumber]](../models/envelopefieldupdatemanyverticalalignnumber.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetanumberresponse.md b/docs/models/envelopefieldupdatemanyfieldmetanumberresponse.md new file mode 100644 index 0000000..0c1c00a --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetanumberresponse.md @@ -0,0 +1,21 @@ +# EnvelopeFieldUpdateManyFieldMetaNumberResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyFieldMetaTypeNumber](../models/envelopefieldupdatemanyfieldmetatypenumber.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 | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignResponse6]](../models/envelopefieldupdatemanytextalignresponse6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeFieldUpdateManyVerticalAlignResponse2]](../models/envelopefieldupdatemanyverticalalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetaradiorequest.md b/docs/models/envelopefieldupdatemanyfieldmetaradiorequest.md new file mode 100644 index 0000000..55756b5 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetaradiorequest.md @@ -0,0 +1,15 @@ +# EnvelopeFieldUpdateManyFieldMetaRadioRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyTypeRadioRequest2](../models/envelopefieldupdatemanytyperadiorequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldUpdateManyValueRadio](../models/envelopefieldupdatemanyvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.EnvelopeFieldUpdateManyDirectionRadio]](../models/envelopefieldupdatemanydirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetaradioresponse.md b/docs/models/envelopefieldupdatemanyfieldmetaradioresponse.md new file mode 100644 index 0000000..4744313 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetaradioresponse.md @@ -0,0 +1,15 @@ +# EnvelopeFieldUpdateManyFieldMetaRadioResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyFieldMetaTypeRadio](../models/envelopefieldupdatemanyfieldmetatyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeFieldUpdateManyValueResponse1](../models/envelopefieldupdatemanyvalueresponse1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.EnvelopeFieldUpdateManyDirectionResponse1]](../models/envelopefieldupdatemanydirectionresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetasignaturerequest.md b/docs/models/envelopefieldupdatemanyfieldmetasignaturerequest.md new file mode 100644 index 0000000..d1e1137 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetasignaturerequest.md @@ -0,0 +1,13 @@ +# EnvelopeFieldUpdateManyFieldMetaSignatureRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyTypeSignatureRequest2](../models/envelopefieldupdatemanytypesignaturerequest2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetasignatureresponse.md b/docs/models/envelopefieldupdatemanyfieldmetasignatureresponse.md new file mode 100644 index 0000000..ae8cfaf --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetasignatureresponse.md @@ -0,0 +1,13 @@ +# EnvelopeFieldUpdateManyFieldMetaSignatureResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyFieldMetaTypeSignature](../models/envelopefieldupdatemanyfieldmetatypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidfieldmetainitials.md b/docs/models/envelopefieldupdatemanyfieldmetatextrequest.md similarity index 60% rename from docs/models/documentgetdocumentwithdetailsbyidfieldmetainitials.md rename to docs/models/envelopefieldupdatemanyfieldmetatextrequest.md index b080691..3fa2c56 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidfieldmetainitials.md +++ b/docs/models/envelopefieldupdatemanyfieldmetatextrequest.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDFieldMetaInitials +# EnvelopeFieldUpdateManyFieldMetaTextRequest ## Fields @@ -9,6 +9,11 @@ | `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 +| `type` | [models.EnvelopeFieldUpdateManyTypeTextRequest2](../models/envelopefieldupdatemanytypetextrequest2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignText]](../models/envelopefieldupdatemanytextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeFieldUpdateManyVerticalAlignText]](../models/envelopefieldupdatemanyverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatextresponse.md b/docs/models/envelopefieldupdatemanyfieldmetatextresponse.md new file mode 100644 index 0000000..1b91924 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatextresponse.md @@ -0,0 +1,19 @@ +# EnvelopeFieldUpdateManyFieldMetaTextResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeFieldUpdateManyFieldMetaTypeText](../models/envelopefieldupdatemanyfieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.EnvelopeFieldUpdateManyTextAlignResponse5]](../models/envelopefieldupdatemanytextalignresponse5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeFieldUpdateManyVerticalAlignResponse1]](../models/envelopefieldupdatemanyverticalalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatypecheckbox.md b/docs/models/envelopefieldupdatemanyfieldmetatypecheckbox.md new file mode 100644 index 0000000..75ba925 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatypecheckbox.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyFieldMetaTypeCheckbox + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatypedate.md b/docs/models/envelopefieldupdatemanyfieldmetatypedate.md new file mode 100644 index 0000000..84858a5 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatypedate.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyFieldMetaTypeDate + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatypedropdown.md b/docs/models/envelopefieldupdatemanyfieldmetatypedropdown.md new file mode 100644 index 0000000..6b0ccf0 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatypedropdown.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyFieldMetaTypeDropdown + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatypeemail.md b/docs/models/envelopefieldupdatemanyfieldmetatypeemail.md new file mode 100644 index 0000000..791a8d6 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatypeemail.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyFieldMetaTypeEmail + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | email | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatypeinitials.md b/docs/models/envelopefieldupdatemanyfieldmetatypeinitials.md new file mode 100644 index 0000000..010bb5f --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatypeinitials.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyFieldMetaTypeInitials + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | initials | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatypename.md b/docs/models/envelopefieldupdatemanyfieldmetatypename.md new file mode 100644 index 0000000..8755777 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatypename.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyFieldMetaTypeName + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | name | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatypenumber.md b/docs/models/envelopefieldupdatemanyfieldmetatypenumber.md new file mode 100644 index 0000000..13e2822 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatypenumber.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyFieldMetaTypeNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatyperadio.md b/docs/models/envelopefieldupdatemanyfieldmetatyperadio.md new file mode 100644 index 0000000..798062c --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatyperadio.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyFieldMetaTypeRadio + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatypesignature.md b/docs/models/envelopefieldupdatemanyfieldmetatypesignature.md new file mode 100644 index 0000000..19d346f --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatypesignature.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyFieldMetaTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetatypetext.md b/docs/models/envelopefieldupdatemanyfieldmetatypetext.md new file mode 100644 index 0000000..860a488 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetatypetext.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyFieldMetaTypeText + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyfieldmetaunion.md b/docs/models/envelopefieldupdatemanyfieldmetaunion.md new file mode 100644 index 0000000..9138c86 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyfieldmetaunion.md @@ -0,0 +1,65 @@ +# EnvelopeFieldUpdateManyFieldMetaUnion + + +## Supported Types + +### `models.EnvelopeFieldUpdateManyFieldMetaSignatureResponse` + +```python +value: models.EnvelopeFieldUpdateManyFieldMetaSignatureResponse = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyFieldMetaInitialsResponse` + +```python +value: models.EnvelopeFieldUpdateManyFieldMetaInitialsResponse = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyFieldMetaNameResponse` + +```python +value: models.EnvelopeFieldUpdateManyFieldMetaNameResponse = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyFieldMetaEmailResponse` + +```python +value: models.EnvelopeFieldUpdateManyFieldMetaEmailResponse = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyFieldMetaDateResponse` + +```python +value: models.EnvelopeFieldUpdateManyFieldMetaDateResponse = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyFieldMetaTextResponse` + +```python +value: models.EnvelopeFieldUpdateManyFieldMetaTextResponse = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyFieldMetaNumberResponse` + +```python +value: models.EnvelopeFieldUpdateManyFieldMetaNumberResponse = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyFieldMetaRadioResponse` + +```python +value: models.EnvelopeFieldUpdateManyFieldMetaRadioResponse = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyFieldMetaCheckboxResponse` + +```python +value: models.EnvelopeFieldUpdateManyFieldMetaCheckboxResponse = /* values here */ +``` + +### `models.EnvelopeFieldUpdateManyFieldMetaDropdownResponse` + +```python +value: models.EnvelopeFieldUpdateManyFieldMetaDropdownResponse = /* values here */ +``` + diff --git a/docs/models/envelopefieldupdatemanyforbiddenerror.md b/docs/models/envelopefieldupdatemanyforbiddenerror.md new file mode 100644 index 0000000..0b57247 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldUpdateManyForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeFieldUpdateManyForbiddenIssue](../models/envelopefieldupdatemanyforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyforbiddenissue.md b/docs/models/envelopefieldupdatemanyforbiddenissue.md new file mode 100644 index 0000000..feaa13e --- /dev/null +++ b/docs/models/envelopefieldupdatemanyforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyForbiddenIssue + + +## 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/envelopefieldupdatemanyinternalservererror.md similarity index 69% rename from docs/models/documentgetdocumentwithdetailsbyiddocumentdata.md rename to docs/models/envelopefieldupdatemanyinternalservererror.md index 5e6eb55..66fad61 100644 --- a/docs/models/documentgetdocumentwithdetailsbyiddocumentdata.md +++ b/docs/models/envelopefieldupdatemanyinternalservererror.md @@ -1,11 +1,12 @@ -# DocumentGetDocumentWithDetailsByIDDocumentData +# EnvelopeFieldUpdateManyInternalServerError + +Internal server error ## 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 +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeFieldUpdateManyInternalServerErrorIssue](../models/envelopefieldupdatemanyinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyinternalservererrorissue.md b/docs/models/envelopefieldupdatemanyinternalservererrorissue.md new file mode 100644 index 0000000..d416e11 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyrequest.md b/docs/models/envelopefieldupdatemanyrequest.md new file mode 100644 index 0000000..8b4e68f --- /dev/null +++ b/docs/models/envelopefieldupdatemanyrequest.md @@ -0,0 +1,9 @@ +# EnvelopeFieldUpdateManyRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | List[[models.EnvelopeFieldUpdateManyDataUnion](../models/envelopefieldupdatemanydataunion.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyresponse.md b/docs/models/envelopefieldupdatemanyresponse.md new file mode 100644 index 0000000..c6bb9bb --- /dev/null +++ b/docs/models/envelopefieldupdatemanyresponse.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `data` | List[[models.EnvelopeFieldUpdateManyDataResponse](../models/envelopefieldupdatemanydataresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextaligndate.md b/docs/models/envelopefieldupdatemanytextaligndate.md new file mode 100644 index 0000000..15f792b --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextaligndate.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignDate + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextalignemail.md b/docs/models/envelopefieldupdatemanytextalignemail.md new file mode 100644 index 0000000..13321af --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextalignemail.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignEmail + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextaligninitials.md b/docs/models/envelopefieldupdatemanytextaligninitials.md new file mode 100644 index 0000000..75d143b --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextaligninitials.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignInitials + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextalignname.md b/docs/models/envelopefieldupdatemanytextalignname.md new file mode 100644 index 0000000..40d85a9 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextalignname.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignName + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextalignnumber.md b/docs/models/envelopefieldupdatemanytextalignnumber.md new file mode 100644 index 0000000..eac6115 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextalignnumber.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextalignresponse1.md b/docs/models/envelopefieldupdatemanytextalignresponse1.md new file mode 100644 index 0000000..9813f0b --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextalignresponse1.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextalignresponse2.md b/docs/models/envelopefieldupdatemanytextalignresponse2.md new file mode 100644 index 0000000..ef75d6f --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextalignresponse2.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextalignresponse3.md b/docs/models/envelopefieldupdatemanytextalignresponse3.md new file mode 100644 index 0000000..403fefd --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextalignresponse3.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignResponse3 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextalignresponse4.md b/docs/models/envelopefieldupdatemanytextalignresponse4.md new file mode 100644 index 0000000..78d2317 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextalignresponse4.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignResponse4 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextalignresponse5.md b/docs/models/envelopefieldupdatemanytextalignresponse5.md new file mode 100644 index 0000000..93d0ba1 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextalignresponse5.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignResponse5 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextalignresponse6.md b/docs/models/envelopefieldupdatemanytextalignresponse6.md new file mode 100644 index 0000000..9924dfb --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextalignresponse6.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignResponse6 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytextaligntext.md b/docs/models/envelopefieldupdatemanytextaligntext.md new file mode 100644 index 0000000..bffccd8 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytextaligntext.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyTextAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypecheckboxrequest1.md b/docs/models/envelopefieldupdatemanytypecheckboxrequest1.md new file mode 100644 index 0000000..2c70fb0 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypecheckboxrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeCheckboxRequest1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | CHECKBOX | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypecheckboxrequest2.md b/docs/models/envelopefieldupdatemanytypecheckboxrequest2.md new file mode 100644 index 0000000..4072685 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypecheckboxrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeCheckboxRequest2 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypedaterequest1.md b/docs/models/envelopefieldupdatemanytypedaterequest1.md new file mode 100644 index 0000000..6925c33 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypedaterequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeDateRequest1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | DATE | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypedaterequest2.md b/docs/models/envelopefieldupdatemanytypedaterequest2.md new file mode 100644 index 0000000..dcc19d1 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypedaterequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeDateRequest2 + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypedropdownrequest1.md b/docs/models/envelopefieldupdatemanytypedropdownrequest1.md new file mode 100644 index 0000000..11c98e4 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypedropdownrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeDropdownRequest1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | DROPDOWN | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypedropdownrequest2.md b/docs/models/envelopefieldupdatemanytypedropdownrequest2.md new file mode 100644 index 0000000..76cf8b0 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypedropdownrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeDropdownRequest2 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypeemailrequest1.md b/docs/models/envelopefieldupdatemanytypeemailrequest1.md new file mode 100644 index 0000000..ab72bc1 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypeemailrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeEmailRequest1 + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypeemailrequest2.md b/docs/models/envelopefieldupdatemanytypeemailrequest2.md new file mode 100644 index 0000000..716104d --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypeemailrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeEmailRequest2 + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | email | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypefreesignature.md b/docs/models/envelopefieldupdatemanytypefreesignature.md new file mode 100644 index 0000000..e31b867 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypefreesignature.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeFreeSignature + + +## Values + +| Name | Value | +| ---------------- | ---------------- | +| `FREE_SIGNATURE` | FREE_SIGNATURE | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypeinitialsrequest1.md b/docs/models/envelopefieldupdatemanytypeinitialsrequest1.md new file mode 100644 index 0000000..e76bf7e --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypeinitialsrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeInitialsRequest1 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | INITIALS | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypeinitialsrequest2.md b/docs/models/envelopefieldupdatemanytypeinitialsrequest2.md new file mode 100644 index 0000000..8fa8cb1 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypeinitialsrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeInitialsRequest2 + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | initials | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypenamerequest1.md b/docs/models/envelopefieldupdatemanytypenamerequest1.md new file mode 100644 index 0000000..0dabb00 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypenamerequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeNameRequest1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | NAME | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypenamerequest2.md b/docs/models/envelopefieldupdatemanytypenamerequest2.md new file mode 100644 index 0000000..26e4844 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypenamerequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeNameRequest2 + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | name | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypenumberrequest1.md b/docs/models/envelopefieldupdatemanytypenumberrequest1.md new file mode 100644 index 0000000..4e0361e --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypenumberrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeNumberRequest1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | NUMBER | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypenumberrequest2.md b/docs/models/envelopefieldupdatemanytypenumberrequest2.md new file mode 100644 index 0000000..ac95ccf --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypenumberrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeNumberRequest2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytyperadiorequest1.md b/docs/models/envelopefieldupdatemanytyperadiorequest1.md new file mode 100644 index 0000000..51b07a4 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytyperadiorequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeRadioRequest1 + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | RADIO | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytyperadiorequest2.md b/docs/models/envelopefieldupdatemanytyperadiorequest2.md new file mode 100644 index 0000000..7a6555a --- /dev/null +++ b/docs/models/envelopefieldupdatemanytyperadiorequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeRadioRequest2 + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytyperesponse.md b/docs/models/envelopefieldupdatemanytyperesponse.md new file mode 100644 index 0000000..2e6590e --- /dev/null +++ b/docs/models/envelopefieldupdatemanytyperesponse.md @@ -0,0 +1,18 @@ +# EnvelopeFieldUpdateManyTypeResponse + + +## 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/fieldcreatedocumentfieldstypesignature.md b/docs/models/envelopefieldupdatemanytypesignaturerequest1.md similarity index 68% rename from docs/models/fieldcreatedocumentfieldstypesignature.md rename to docs/models/envelopefieldupdatemanytypesignaturerequest1.md index 92f8748..73cd603 100644 --- a/docs/models/fieldcreatedocumentfieldstypesignature.md +++ b/docs/models/envelopefieldupdatemanytypesignaturerequest1.md @@ -1,4 +1,4 @@ -# FieldCreateDocumentFieldsTypeSignature +# EnvelopeFieldUpdateManyTypeSignatureRequest1 ## Values diff --git a/docs/models/envelopefieldupdatemanytypesignaturerequest2.md b/docs/models/envelopefieldupdatemanytypesignaturerequest2.md new file mode 100644 index 0000000..a2689dc --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypesignaturerequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeSignatureRequest2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypetextrequest1.md b/docs/models/envelopefieldupdatemanytypetextrequest1.md new file mode 100644 index 0000000..157b16c --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypetextrequest1.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeTextRequest1 + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | TEXT | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanytypetextrequest2.md b/docs/models/envelopefieldupdatemanytypetextrequest2.md new file mode 100644 index 0000000..efd83b3 --- /dev/null +++ b/docs/models/envelopefieldupdatemanytypetextrequest2.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyTypeTextRequest2 + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyunauthorizederror.md b/docs/models/envelopefieldupdatemanyunauthorizederror.md new file mode 100644 index 0000000..52869d9 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeFieldUpdateManyUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeFieldUpdateManyUnauthorizedIssue](../models/envelopefieldupdatemanyunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyunauthorizedissue.md b/docs/models/envelopefieldupdatemanyunauthorizedissue.md new file mode 100644 index 0000000..5961820 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyvaluecheckbox.md b/docs/models/envelopefieldupdatemanyvaluecheckbox.md new file mode 100644 index 0000000..a7052a0 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyvaluecheckbox.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyValueCheckbox + + +## 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/envelopefieldupdatemanyvaluedropdown.md b/docs/models/envelopefieldupdatemanyvaluedropdown.md new file mode 100644 index 0000000..e9907a8 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyvaluedropdown.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyValueDropdown + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyvalueradio.md b/docs/models/envelopefieldupdatemanyvalueradio.md new file mode 100644 index 0000000..b4f9acd --- /dev/null +++ b/docs/models/envelopefieldupdatemanyvalueradio.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyValueRadio + + +## 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/envelopefieldupdatemanyvalueresponse1.md b/docs/models/envelopefieldupdatemanyvalueresponse1.md new file mode 100644 index 0000000..7ba9ce5 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyvalueresponse1.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyValueResponse1 + + +## 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/envelopefieldupdatemanyvalueresponse2.md b/docs/models/envelopefieldupdatemanyvalueresponse2.md new file mode 100644 index 0000000..860f1d0 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyvalueresponse2.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyValueResponse2 + + +## 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/envelopefieldupdatemanyvalueresponse3.md b/docs/models/envelopefieldupdatemanyvalueresponse3.md new file mode 100644 index 0000000..1d6740a --- /dev/null +++ b/docs/models/envelopefieldupdatemanyvalueresponse3.md @@ -0,0 +1,8 @@ +# EnvelopeFieldUpdateManyValueResponse3 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyverticalalignnumber.md b/docs/models/envelopefieldupdatemanyverticalalignnumber.md new file mode 100644 index 0000000..a5e6a3b --- /dev/null +++ b/docs/models/envelopefieldupdatemanyverticalalignnumber.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyverticalalignresponse1.md b/docs/models/envelopefieldupdatemanyverticalalignresponse1.md new file mode 100644 index 0000000..eb15f45 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyverticalalignresponse1.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyVerticalAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyverticalalignresponse2.md b/docs/models/envelopefieldupdatemanyverticalalignresponse2.md new file mode 100644 index 0000000..8696955 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyverticalalignresponse2.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyVerticalAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopefieldupdatemanyverticalaligntext.md b/docs/models/envelopefieldupdatemanyverticalaligntext.md new file mode 100644 index 0000000..a1003a9 --- /dev/null +++ b/docs/models/envelopefieldupdatemanyverticalaligntext.md @@ -0,0 +1,10 @@ +# EnvelopeFieldUpdateManyVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopegetaccessauth.md b/docs/models/envelopegetaccessauth.md new file mode 100644 index 0000000..8ec8295 --- /dev/null +++ b/docs/models/envelopegetaccessauth.md @@ -0,0 +1,9 @@ +# EnvelopeGetAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/envelopegetactionauth.md b/docs/models/envelopegetactionauth.md new file mode 100644 index 0000000..437c268 --- /dev/null +++ b/docs/models/envelopegetactionauth.md @@ -0,0 +1,12 @@ +# EnvelopeGetActionAuth + + +## 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/envelopegetauthoptions.md b/docs/models/envelopegetauthoptions.md new file mode 100644 index 0000000..ada4bd1 --- /dev/null +++ b/docs/models/envelopegetauthoptions.md @@ -0,0 +1,9 @@ +# EnvelopeGetAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `global_access_auth` | List[[models.EnvelopeGetGlobalAccessAuth](../models/envelopegetglobalaccessauth.md)] | :heavy_check_mark: | N/A | +| `global_action_auth` | List[[models.EnvelopeGetGlobalActionAuth](../models/envelopegetglobalactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetbadrequesterror.md b/docs/models/envelopegetbadrequesterror.md new file mode 100644 index 0000000..00a12c4 --- /dev/null +++ b/docs/models/envelopegetbadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeGetBadRequestError + +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.EnvelopeGetBadRequestIssue](../models/envelopegetbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetbadrequestissue.md b/docs/models/envelopegetbadrequestissue.md new file mode 100644 index 0000000..5f5c6de --- /dev/null +++ b/docs/models/envelopegetbadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeGetBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetdirection1.md b/docs/models/envelopegetdirection1.md new file mode 100644 index 0000000..e88c463 --- /dev/null +++ b/docs/models/envelopegetdirection1.md @@ -0,0 +1,9 @@ +# EnvelopeGetDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopegetdirection2.md b/docs/models/envelopegetdirection2.md new file mode 100644 index 0000000..b8f2995 --- /dev/null +++ b/docs/models/envelopegetdirection2.md @@ -0,0 +1,9 @@ +# EnvelopeGetDirection2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/envelopegetdirectlink.md b/docs/models/envelopegetdirectlink.md new file mode 100644 index 0000000..a18a141 --- /dev/null +++ b/docs/models/envelopegetdirectlink.md @@ -0,0 +1,11 @@ +# EnvelopeGetDirectLink + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `direct_template_recipient_id` | *float* | :heavy_check_mark: | N/A | +| `enabled` | *bool* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetdistributionmethod.md b/docs/models/envelopegetdistributionmethod.md new file mode 100644 index 0000000..4503f4e --- /dev/null +++ b/docs/models/envelopegetdistributionmethod.md @@ -0,0 +1,9 @@ +# EnvelopeGetDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/envelopegetdocumentmeta.md b/docs/models/envelopegetdocumentmeta.md new file mode 100644 index 0000000..b3dd5b3 --- /dev/null +++ b/docs/models/envelopegetdocumentmeta.md @@ -0,0 +1,23 @@ +# EnvelopeGetDocumentMeta + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `signing_order` | [models.EnvelopeGetSigningOrder](../models/envelopegetsigningorder.md) | :heavy_check_mark: | N/A | +| `distribution_method` | [models.EnvelopeGetDistributionMethod](../models/envelopegetdistributionmethod.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.EnvelopeGetEmailSettings]](../models/envelopegetemailsettings.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 | \ No newline at end of file diff --git a/docs/models/envelopegetemailsettings.md b/docs/models/envelopegetemailsettings.md new file mode 100644 index 0000000..15a0ebb --- /dev/null +++ b/docs/models/envelopegetemailsettings.md @@ -0,0 +1,14 @@ +# EnvelopeGetEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetenvelopeitem.md b/docs/models/envelopegetenvelopeitem.md new file mode 100644 index 0000000..001bfab --- /dev/null +++ b/docs/models/envelopegetenvelopeitem.md @@ -0,0 +1,11 @@ +# EnvelopeGetEnvelopeItem + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `order` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetfield.md b/docs/models/envelopegetfield.md new file mode 100644 index 0000000..7cf5d02 --- /dev/null +++ b/docs/models/envelopegetfield.md @@ -0,0 +1,21 @@ +# EnvelopeGetField + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeGetFieldType](../models/envelopegetfieldtype.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: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | N/A | +| `custom_text` | *str* | :heavy_check_mark: | N/A | +| `inserted` | *bool* | :heavy_check_mark: | N/A | +| `field_meta` | [Nullable[models.EnvelopeGetFieldMetaUnion]](../models/envelopegetfieldmetaunion.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetfieldmetacheckbox.md b/docs/models/envelopegetfieldmetacheckbox.md new file mode 100644 index 0000000..5ed1b64 --- /dev/null +++ b/docs/models/envelopegetfieldmetacheckbox.md @@ -0,0 +1,17 @@ +# EnvelopeGetFieldMetaCheckbox + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeGetTypeCheckbox](../models/envelopegettypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeGetValue2](../models/envelopegetvalue2.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.EnvelopeGetDirection2]](../models/envelopegetdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetfieldmetadate.md b/docs/models/envelopegetfieldmetadate.md new file mode 100644 index 0000000..c559519 --- /dev/null +++ b/docs/models/envelopegetfieldmetadate.md @@ -0,0 +1,14 @@ +# EnvelopeGetFieldMetaDate + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeGetTypeDate](../models/envelopegettypedate.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeGetTextAlign4]](../models/envelopegettextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetfieldmetadropdown.md b/docs/models/envelopegetfieldmetadropdown.md new file mode 100644 index 0000000..b770220 --- /dev/null +++ b/docs/models/envelopegetfieldmetadropdown.md @@ -0,0 +1,15 @@ +# EnvelopeGetFieldMetaDropdown + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeGetTypeDropdown](../models/envelopegettypedropdown.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeGetValue3](../models/envelopegetvalue3.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/envelopegetfieldmetaemail.md b/docs/models/envelopegetfieldmetaemail.md new file mode 100644 index 0000000..b4a2063 --- /dev/null +++ b/docs/models/envelopegetfieldmetaemail.md @@ -0,0 +1,14 @@ +# EnvelopeGetFieldMetaEmail + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeGetTypeEmail](../models/envelopegettypeemail.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeGetTextAlign3]](../models/envelopegettextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetfieldmetainitials.md b/docs/models/envelopegetfieldmetainitials.md new file mode 100644 index 0000000..d8a6d95 --- /dev/null +++ b/docs/models/envelopegetfieldmetainitials.md @@ -0,0 +1,14 @@ +# EnvelopeGetFieldMetaInitials + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeGetTypeInitials](../models/envelopegettypeinitials.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeGetTextAlign1]](../models/envelopegettextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetfieldmetaname.md b/docs/models/envelopegetfieldmetaname.md new file mode 100644 index 0000000..238a85c --- /dev/null +++ b/docs/models/envelopegetfieldmetaname.md @@ -0,0 +1,14 @@ +# EnvelopeGetFieldMetaName + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeGetTypeName](../models/envelopegettypename.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeGetTextAlign2]](../models/envelopegettextalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetfieldmetanumber.md b/docs/models/envelopegetfieldmetanumber.md new file mode 100644 index 0000000..f9b1a38 --- /dev/null +++ b/docs/models/envelopegetfieldmetanumber.md @@ -0,0 +1,21 @@ +# EnvelopeGetFieldMetaNumber + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeGetTypeNumber](../models/envelopegettypenumber.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 | +| `text_align` | [Optional[models.EnvelopeGetTextAlign6]](../models/envelopegettextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeGetVerticalAlign2]](../models/envelopegetverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetfieldmetaradio.md b/docs/models/envelopegetfieldmetaradio.md new file mode 100644 index 0000000..1f062b3 --- /dev/null +++ b/docs/models/envelopegetfieldmetaradio.md @@ -0,0 +1,15 @@ +# EnvelopeGetFieldMetaRadio + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeGetTypeRadio](../models/envelopegettyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeGetValue1](../models/envelopegetvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.EnvelopeGetDirection1]](../models/envelopegetdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/prefillfieldcheckbox.md b/docs/models/envelopegetfieldmetasignature.md similarity index 55% rename from docs/models/prefillfieldcheckbox.md rename to docs/models/envelopegetfieldmetasignature.md index e38800f..106e976 100644 --- a/docs/models/prefillfieldcheckbox.md +++ b/docs/models/envelopegetfieldmetasignature.md @@ -1,11 +1,13 @@ -# PrefillFieldCheckbox +# EnvelopeGetFieldMetaSignature ## Fields | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [models.PrefillFieldTypeCheckbox](../models/prefillfieldtypecheckbox.md) | :heavy_check_mark: | N/A | | `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `value` | List[*str*] | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file +| `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeGetTypeSignature](../models/envelopegettypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetfieldmetatext.md b/docs/models/envelopegetfieldmetatext.md new file mode 100644 index 0000000..3d8a4e5 --- /dev/null +++ b/docs/models/envelopegetfieldmetatext.md @@ -0,0 +1,19 @@ +# EnvelopeGetFieldMetaText + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeGetTypeText](../models/envelopegettypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.EnvelopeGetTextAlign5]](../models/envelopegettextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeGetVerticalAlign1]](../models/envelopegetverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetfieldmetaunion.md b/docs/models/envelopegetfieldmetaunion.md new file mode 100644 index 0000000..68b4834 --- /dev/null +++ b/docs/models/envelopegetfieldmetaunion.md @@ -0,0 +1,65 @@ +# EnvelopeGetFieldMetaUnion + + +## Supported Types + +### `models.EnvelopeGetFieldMetaSignature` + +```python +value: models.EnvelopeGetFieldMetaSignature = /* values here */ +``` + +### `models.EnvelopeGetFieldMetaInitials` + +```python +value: models.EnvelopeGetFieldMetaInitials = /* values here */ +``` + +### `models.EnvelopeGetFieldMetaName` + +```python +value: models.EnvelopeGetFieldMetaName = /* values here */ +``` + +### `models.EnvelopeGetFieldMetaEmail` + +```python +value: models.EnvelopeGetFieldMetaEmail = /* values here */ +``` + +### `models.EnvelopeGetFieldMetaDate` + +```python +value: models.EnvelopeGetFieldMetaDate = /* values here */ +``` + +### `models.EnvelopeGetFieldMetaText` + +```python +value: models.EnvelopeGetFieldMetaText = /* values here */ +``` + +### `models.EnvelopeGetFieldMetaNumber` + +```python +value: models.EnvelopeGetFieldMetaNumber = /* values here */ +``` + +### `models.EnvelopeGetFieldMetaRadio` + +```python +value: models.EnvelopeGetFieldMetaRadio = /* values here */ +``` + +### `models.EnvelopeGetFieldMetaCheckbox` + +```python +value: models.EnvelopeGetFieldMetaCheckbox = /* values here */ +``` + +### `models.EnvelopeGetFieldMetaDropdown` + +```python +value: models.EnvelopeGetFieldMetaDropdown = /* values here */ +``` + diff --git a/docs/models/envelopegetfieldtype.md b/docs/models/envelopegetfieldtype.md new file mode 100644 index 0000000..6f9128c --- /dev/null +++ b/docs/models/envelopegetfieldtype.md @@ -0,0 +1,18 @@ +# EnvelopeGetFieldType + + +## 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/envelopegetforbiddenerror.md b/docs/models/envelopegetforbiddenerror.md new file mode 100644 index 0000000..a494455 --- /dev/null +++ b/docs/models/envelopegetforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeGetForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeGetForbiddenIssue](../models/envelopegetforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetforbiddenissue.md b/docs/models/envelopegetforbiddenissue.md new file mode 100644 index 0000000..9397d75 --- /dev/null +++ b/docs/models/envelopegetforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeGetForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetformvalues.md b/docs/models/envelopegetformvalues.md new file mode 100644 index 0000000..8e541fa --- /dev/null +++ b/docs/models/envelopegetformvalues.md @@ -0,0 +1,23 @@ +# EnvelopeGetFormValues + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `bool` + +```python +value: bool = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopegetglobalaccessauth.md b/docs/models/envelopegetglobalaccessauth.md new file mode 100644 index 0000000..b4e574f --- /dev/null +++ b/docs/models/envelopegetglobalaccessauth.md @@ -0,0 +1,9 @@ +# EnvelopeGetGlobalAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/envelopegetglobalactionauth.md b/docs/models/envelopegetglobalactionauth.md new file mode 100644 index 0000000..eb88398 --- /dev/null +++ b/docs/models/envelopegetglobalactionauth.md @@ -0,0 +1,11 @@ +# EnvelopeGetGlobalActionAuth + + +## 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/envelopegetinternalservererror.md b/docs/models/envelopegetinternalservererror.md new file mode 100644 index 0000000..444244c --- /dev/null +++ b/docs/models/envelopegetinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeGetInternalServerError + +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.EnvelopeGetInternalServerErrorIssue](../models/envelopegetinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetinternalservererrorissue.md b/docs/models/envelopegetinternalservererrorissue.md new file mode 100644 index 0000000..e04cc8a --- /dev/null +++ b/docs/models/envelopegetinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeGetInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetnotfounderror.md b/docs/models/envelopegetnotfounderror.md new file mode 100644 index 0000000..a830655 --- /dev/null +++ b/docs/models/envelopegetnotfounderror.md @@ -0,0 +1,12 @@ +# EnvelopeGetNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeGetNotFoundIssue](../models/envelopegetnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetnotfoundissue.md b/docs/models/envelopegetnotfoundissue.md new file mode 100644 index 0000000..458eda3 --- /dev/null +++ b/docs/models/envelopegetnotfoundissue.md @@ -0,0 +1,8 @@ +# EnvelopeGetNotFoundIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetreadstatus.md b/docs/models/envelopegetreadstatus.md new file mode 100644 index 0000000..74d4c3a --- /dev/null +++ b/docs/models/envelopegetreadstatus.md @@ -0,0 +1,9 @@ +# EnvelopeGetReadStatus + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `NOT_OPENED` | NOT_OPENED | +| `OPENED` | OPENED | \ No newline at end of file diff --git a/docs/models/envelopegetrecipient.md b/docs/models/envelopegetrecipient.md new file mode 100644 index 0000000..9d9d63e --- /dev/null +++ b/docs/models/envelopegetrecipient.md @@ -0,0 +1,22 @@ +# EnvelopeGetRecipient + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `role` | [models.EnvelopeGetRole](../models/envelopegetrole.md) | :heavy_check_mark: | N/A | +| `read_status` | [models.EnvelopeGetReadStatus](../models/envelopegetreadstatus.md) | :heavy_check_mark: | N/A | +| `signing_status` | [models.EnvelopeGetSigningStatus](../models/envelopegetsigningstatus.md) | :heavy_check_mark: | N/A | +| `send_status` | [models.EnvelopeGetSendStatus](../models/envelopegetsendstatus.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.EnvelopeGetRecipientAuthOptions]](../models/envelopegetrecipientauthoptions.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetrecipientauthoptions.md b/docs/models/envelopegetrecipientauthoptions.md new file mode 100644 index 0000000..5fd4f6b --- /dev/null +++ b/docs/models/envelopegetrecipientauthoptions.md @@ -0,0 +1,9 @@ +# EnvelopeGetRecipientAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `access_auth` | List[[models.EnvelopeGetAccessAuth](../models/envelopegetaccessauth.md)] | :heavy_check_mark: | N/A | +| `action_auth` | List[[models.EnvelopeGetActionAuth](../models/envelopegetactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetrequest.md b/docs/models/envelopegetrequest.md new file mode 100644 index 0000000..e3d6b42 --- /dev/null +++ b/docs/models/envelopegetrequest.md @@ -0,0 +1,8 @@ +# EnvelopeGetRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetresponse.md b/docs/models/envelopegetresponse.md new file mode 100644 index 0000000..2a5d57b --- /dev/null +++ b/docs/models/envelopegetresponse.md @@ -0,0 +1,38 @@ +# EnvelopeGetResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `internal_version` | *float* | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeGetType](../models/envelopegettype.md) | :heavy_check_mark: | N/A | +| `status` | [models.EnvelopeGetStatus](../models/envelopegetstatus.md) | :heavy_check_mark: | N/A | +| `source` | [models.EnvelopeGetSource](../models/envelopegetsource.md) | :heavy_check_mark: | N/A | +| `visibility` | [models.EnvelopeGetVisibility](../models/envelopegetvisibility.md) | :heavy_check_mark: | N/A | +| `template_type` | [models.EnvelopeGetTemplateType](../models/envelopegettemplatetype.md) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `secondary_id` | *str* | :heavy_check_mark: | N/A | +| `external_id` | *Nullable[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 | +| `title` | *str* | :heavy_check_mark: | N/A | +| `auth_options` | [Nullable[models.EnvelopeGetAuthOptions]](../models/envelopegetauthoptions.md) | :heavy_check_mark: | N/A | +| `form_values` | Dict[str, [models.EnvelopeGetFormValues](../models/envelopegetformvalues.md)] | :heavy_check_mark: | N/A | +| `public_title` | *str* | :heavy_check_mark: | N/A | +| `public_description` | *str* | :heavy_check_mark: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `document_meta` | [models.EnvelopeGetDocumentMeta](../models/envelopegetdocumentmeta.md) | :heavy_check_mark: | N/A | +| `recipients` | List[[models.EnvelopeGetRecipient](../models/envelopegetrecipient.md)] | :heavy_check_mark: | N/A | +| `fields` | List[[models.EnvelopeGetField](../models/envelopegetfield.md)] | :heavy_check_mark: | N/A | +| `envelope_items` | List[[models.EnvelopeGetEnvelopeItem](../models/envelopegetenvelopeitem.md)] | :heavy_check_mark: | N/A | +| `direct_link` | [Nullable[models.EnvelopeGetDirectLink]](../models/envelopegetdirectlink.md) | :heavy_check_mark: | N/A | +| `team` | [models.EnvelopeGetTeam](../models/envelopegetteam.md) | :heavy_check_mark: | N/A | +| `user` | [models.EnvelopeGetUser](../models/envelopegetuser.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetrole.md b/docs/models/envelopegetrole.md new file mode 100644 index 0000000..d58ab60 --- /dev/null +++ b/docs/models/envelopegetrole.md @@ -0,0 +1,12 @@ +# EnvelopeGetRole + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `CC` | CC | +| `SIGNER` | SIGNER | +| `VIEWER` | VIEWER | +| `APPROVER` | APPROVER | +| `ASSISTANT` | ASSISTANT | \ No newline at end of file diff --git a/docs/models/envelopegetsendstatus.md b/docs/models/envelopegetsendstatus.md new file mode 100644 index 0000000..b234351 --- /dev/null +++ b/docs/models/envelopegetsendstatus.md @@ -0,0 +1,9 @@ +# EnvelopeGetSendStatus + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `NOT_SENT` | NOT_SENT | +| `SENT` | SENT | \ No newline at end of file diff --git a/docs/models/envelopegetsigningorder.md b/docs/models/envelopegetsigningorder.md new file mode 100644 index 0000000..d3c942f --- /dev/null +++ b/docs/models/envelopegetsigningorder.md @@ -0,0 +1,9 @@ +# EnvelopeGetSigningOrder + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `PARALLEL` | PARALLEL | +| `SEQUENTIAL` | SEQUENTIAL | \ No newline at end of file diff --git a/docs/models/envelopegetsigningstatus.md b/docs/models/envelopegetsigningstatus.md new file mode 100644 index 0000000..ec7695f --- /dev/null +++ b/docs/models/envelopegetsigningstatus.md @@ -0,0 +1,10 @@ +# EnvelopeGetSigningStatus + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `NOT_SIGNED` | NOT_SIGNED | +| `SIGNED` | SIGNED | +| `REJECTED` | REJECTED | \ No newline at end of file diff --git a/docs/models/envelopegetsource.md b/docs/models/envelopegetsource.md new file mode 100644 index 0000000..e985b4a --- /dev/null +++ b/docs/models/envelopegetsource.md @@ -0,0 +1,10 @@ +# EnvelopeGetSource + + +## Values + +| Name | Value | +| ---------------------- | ---------------------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | +| `TEMPLATE_DIRECT_LINK` | TEMPLATE_DIRECT_LINK | \ No newline at end of file diff --git a/docs/models/envelopegetstatus.md b/docs/models/envelopegetstatus.md new file mode 100644 index 0000000..b94de1b --- /dev/null +++ b/docs/models/envelopegetstatus.md @@ -0,0 +1,11 @@ +# EnvelopeGetStatus + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `DRAFT` | DRAFT | +| `PENDING` | PENDING | +| `COMPLETED` | COMPLETED | +| `REJECTED` | REJECTED | \ No newline at end of file diff --git a/docs/models/envelopegetteam.md b/docs/models/envelopegetteam.md new file mode 100644 index 0000000..8bb0866 --- /dev/null +++ b/docs/models/envelopegetteam.md @@ -0,0 +1,9 @@ +# EnvelopeGetTeam + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *float* | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegettemplatetype.md b/docs/models/envelopegettemplatetype.md new file mode 100644 index 0000000..2c0cfc4 --- /dev/null +++ b/docs/models/envelopegettemplatetype.md @@ -0,0 +1,9 @@ +# EnvelopeGetTemplateType + + +## Values + +| Name | Value | +| --------- | --------- | +| `PUBLIC` | PUBLIC | +| `PRIVATE` | PRIVATE | \ No newline at end of file diff --git a/docs/models/envelopegettextalign1.md b/docs/models/envelopegettextalign1.md new file mode 100644 index 0000000..d2857e5 --- /dev/null +++ b/docs/models/envelopegettextalign1.md @@ -0,0 +1,10 @@ +# EnvelopeGetTextAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopegettextalign2.md b/docs/models/envelopegettextalign2.md new file mode 100644 index 0000000..fd205ba --- /dev/null +++ b/docs/models/envelopegettextalign2.md @@ -0,0 +1,10 @@ +# EnvelopeGetTextAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopegettextalign3.md b/docs/models/envelopegettextalign3.md new file mode 100644 index 0000000..247c8ef --- /dev/null +++ b/docs/models/envelopegettextalign3.md @@ -0,0 +1,10 @@ +# EnvelopeGetTextAlign3 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopegettextalign4.md b/docs/models/envelopegettextalign4.md new file mode 100644 index 0000000..006af9a --- /dev/null +++ b/docs/models/envelopegettextalign4.md @@ -0,0 +1,10 @@ +# EnvelopeGetTextAlign4 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopegettextalign5.md b/docs/models/envelopegettextalign5.md new file mode 100644 index 0000000..252bec8 --- /dev/null +++ b/docs/models/envelopegettextalign5.md @@ -0,0 +1,10 @@ +# EnvelopeGetTextAlign5 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopegettextalign6.md b/docs/models/envelopegettextalign6.md new file mode 100644 index 0000000..b8ef63e --- /dev/null +++ b/docs/models/envelopegettextalign6.md @@ -0,0 +1,10 @@ +# EnvelopeGetTextAlign6 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/envelopegettype.md b/docs/models/envelopegettype.md new file mode 100644 index 0000000..58fe8a3 --- /dev/null +++ b/docs/models/envelopegettype.md @@ -0,0 +1,9 @@ +# EnvelopeGetType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | \ No newline at end of file diff --git a/docs/models/envelopegettypecheckbox.md b/docs/models/envelopegettypecheckbox.md new file mode 100644 index 0000000..04f4cd7 --- /dev/null +++ b/docs/models/envelopegettypecheckbox.md @@ -0,0 +1,8 @@ +# EnvelopeGetTypeCheckbox + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/envelopegettypedate.md b/docs/models/envelopegettypedate.md new file mode 100644 index 0000000..a12cfc2 --- /dev/null +++ b/docs/models/envelopegettypedate.md @@ -0,0 +1,8 @@ +# EnvelopeGetTypeDate + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/envelopegettypedropdown.md b/docs/models/envelopegettypedropdown.md new file mode 100644 index 0000000..75e5696 --- /dev/null +++ b/docs/models/envelopegettypedropdown.md @@ -0,0 +1,8 @@ +# EnvelopeGetTypeDropdown + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/envelopegettypeemail.md b/docs/models/envelopegettypeemail.md new file mode 100644 index 0000000..69e2d60 --- /dev/null +++ b/docs/models/envelopegettypeemail.md @@ -0,0 +1,8 @@ +# EnvelopeGetTypeEmail + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | email | \ No newline at end of file diff --git a/docs/models/envelopegettypeinitials.md b/docs/models/envelopegettypeinitials.md new file mode 100644 index 0000000..e9fc933 --- /dev/null +++ b/docs/models/envelopegettypeinitials.md @@ -0,0 +1,8 @@ +# EnvelopeGetTypeInitials + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | initials | \ No newline at end of file diff --git a/docs/models/envelopegettypename.md b/docs/models/envelopegettypename.md new file mode 100644 index 0000000..83e292d --- /dev/null +++ b/docs/models/envelopegettypename.md @@ -0,0 +1,8 @@ +# EnvelopeGetTypeName + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | name | \ No newline at end of file diff --git a/docs/models/envelopegettypenumber.md b/docs/models/envelopegettypenumber.md new file mode 100644 index 0000000..c198b0b --- /dev/null +++ b/docs/models/envelopegettypenumber.md @@ -0,0 +1,8 @@ +# EnvelopeGetTypeNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/envelopegettyperadio.md b/docs/models/envelopegettyperadio.md new file mode 100644 index 0000000..1365c5b --- /dev/null +++ b/docs/models/envelopegettyperadio.md @@ -0,0 +1,8 @@ +# EnvelopeGetTypeRadio + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/envelopegettypesignature.md b/docs/models/envelopegettypesignature.md new file mode 100644 index 0000000..68c8e0b --- /dev/null +++ b/docs/models/envelopegettypesignature.md @@ -0,0 +1,8 @@ +# EnvelopeGetTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/envelopegettypetext.md b/docs/models/envelopegettypetext.md new file mode 100644 index 0000000..98aa911 --- /dev/null +++ b/docs/models/envelopegettypetext.md @@ -0,0 +1,8 @@ +# EnvelopeGetTypeText + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/envelopegetunauthorizederror.md b/docs/models/envelopegetunauthorizederror.md new file mode 100644 index 0000000..9a93dab --- /dev/null +++ b/docs/models/envelopegetunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeGetUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeGetUnauthorizedIssue](../models/envelopegetunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetunauthorizedissue.md b/docs/models/envelopegetunauthorizedissue.md new file mode 100644 index 0000000..21dcadc --- /dev/null +++ b/docs/models/envelopegetunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeGetUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetuser.md b/docs/models/envelopegetuser.md new file mode 100644 index 0000000..31c984f --- /dev/null +++ b/docs/models/envelopegetuser.md @@ -0,0 +1,10 @@ +# EnvelopeGetUser + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *float* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `email` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetvalue1.md b/docs/models/envelopegetvalue1.md new file mode 100644 index 0000000..d4a60bf --- /dev/null +++ b/docs/models/envelopegetvalue1.md @@ -0,0 +1,10 @@ +# EnvelopeGetValue1 + + +## 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/envelopegetvalue2.md b/docs/models/envelopegetvalue2.md new file mode 100644 index 0000000..e7d0bd1 --- /dev/null +++ b/docs/models/envelopegetvalue2.md @@ -0,0 +1,10 @@ +# EnvelopeGetValue2 + + +## 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/envelopegetvalue3.md b/docs/models/envelopegetvalue3.md new file mode 100644 index 0000000..0054131 --- /dev/null +++ b/docs/models/envelopegetvalue3.md @@ -0,0 +1,8 @@ +# EnvelopeGetValue3 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopegetverticalalign1.md b/docs/models/envelopegetverticalalign1.md new file mode 100644 index 0000000..2915f81 --- /dev/null +++ b/docs/models/envelopegetverticalalign1.md @@ -0,0 +1,10 @@ +# EnvelopeGetVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopegetverticalalign2.md b/docs/models/envelopegetverticalalign2.md new file mode 100644 index 0000000..397ed94 --- /dev/null +++ b/docs/models/envelopegetverticalalign2.md @@ -0,0 +1,10 @@ +# EnvelopeGetVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/envelopegetvisibility.md b/docs/models/envelopegetvisibility.md new file mode 100644 index 0000000..d6a18b4 --- /dev/null +++ b/docs/models/envelopegetvisibility.md @@ -0,0 +1,10 @@ +# EnvelopeGetVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanybadrequesterror.md b/docs/models/envelopeitemcreatemanybadrequesterror.md new file mode 100644 index 0000000..3587450 --- /dev/null +++ b/docs/models/envelopeitemcreatemanybadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeItemCreateManyBadRequestError + +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.EnvelopeItemCreateManyBadRequestIssue](../models/envelopeitemcreatemanybadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanybadrequestissue.md b/docs/models/envelopeitemcreatemanybadrequestissue.md new file mode 100644 index 0000000..0f65247 --- /dev/null +++ b/docs/models/envelopeitemcreatemanybadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemCreateManyBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanydata.md b/docs/models/envelopeitemcreatemanydata.md new file mode 100644 index 0000000..962a362 --- /dev/null +++ b/docs/models/envelopeitemcreatemanydata.md @@ -0,0 +1,11 @@ +# EnvelopeItemCreateManyData + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `order` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanyfile.md b/docs/models/envelopeitemcreatemanyfile.md new file mode 100644 index 0000000..80f84a9 --- /dev/null +++ b/docs/models/envelopeitemcreatemanyfile.md @@ -0,0 +1,10 @@ +# EnvelopeItemCreateManyFile + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `file_name` | *str* | :heavy_check_mark: | N/A | +| `content` | *Union[bytes, IO[bytes], io.BufferedReader]* | :heavy_check_mark: | N/A | +| `content_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanyforbiddenerror.md b/docs/models/envelopeitemcreatemanyforbiddenerror.md new file mode 100644 index 0000000..2e83698 --- /dev/null +++ b/docs/models/envelopeitemcreatemanyforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeItemCreateManyForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeItemCreateManyForbiddenIssue](../models/envelopeitemcreatemanyforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanyforbiddenissue.md b/docs/models/envelopeitemcreatemanyforbiddenissue.md new file mode 100644 index 0000000..652025c --- /dev/null +++ b/docs/models/envelopeitemcreatemanyforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemCreateManyForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentresenddocumentinternalservererror.md b/docs/models/envelopeitemcreatemanyinternalservererror.md similarity index 93% rename from docs/models/documentresenddocumentinternalservererror.md rename to docs/models/envelopeitemcreatemanyinternalservererror.md index 4c586ed..b9faf9f 100644 --- a/docs/models/documentresenddocumentinternalservererror.md +++ b/docs/models/envelopeitemcreatemanyinternalservererror.md @@ -1,4 +1,4 @@ -# DocumentResendDocumentInternalServerError +# EnvelopeItemCreateManyInternalServerError 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.DocumentResendDocumentInternalServerErrorIssue](../models/documentresenddocumentinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.EnvelopeItemCreateManyInternalServerErrorIssue](../models/envelopeitemcreatemanyinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanyinternalservererrorissue.md b/docs/models/envelopeitemcreatemanyinternalservererrorissue.md new file mode 100644 index 0000000..9b58828 --- /dev/null +++ b/docs/models/envelopeitemcreatemanyinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemCreateManyInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanypayload.md b/docs/models/envelopeitemcreatemanypayload.md new file mode 100644 index 0000000..9877dc4 --- /dev/null +++ b/docs/models/envelopeitemcreatemanypayload.md @@ -0,0 +1,8 @@ +# EnvelopeItemCreateManyPayload + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentsenddocumentrequest.md b/docs/models/envelopeitemcreatemanyrequest.md similarity index 66% rename from docs/models/documentsenddocumentrequest.md rename to docs/models/envelopeitemcreatemanyrequest.md index e76017b..8d326a4 100644 --- a/docs/models/documentsenddocumentrequest.md +++ b/docs/models/envelopeitemcreatemanyrequest.md @@ -1,9 +1,9 @@ -# DocumentSendDocumentRequest +# EnvelopeItemCreateManyRequest ## 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 +| `payload` | [models.EnvelopeItemCreateManyPayload](../models/envelopeitemcreatemanypayload.md) | :heavy_check_mark: | N/A | +| `files` | List[[models.EnvelopeItemCreateManyFile](../models/envelopeitemcreatemanyfile.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanyresponse.md b/docs/models/envelopeitemcreatemanyresponse.md new file mode 100644 index 0000000..ab57be6 --- /dev/null +++ b/docs/models/envelopeitemcreatemanyresponse.md @@ -0,0 +1,10 @@ +# EnvelopeItemCreateManyResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `data` | List[[models.EnvelopeItemCreateManyData](../models/envelopeitemcreatemanydata.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanyunauthorizederror.md b/docs/models/envelopeitemcreatemanyunauthorizederror.md new file mode 100644 index 0000000..f2a0723 --- /dev/null +++ b/docs/models/envelopeitemcreatemanyunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeItemCreateManyUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeItemCreateManyUnauthorizedIssue](../models/envelopeitemcreatemanyunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemcreatemanyunauthorizedissue.md b/docs/models/envelopeitemcreatemanyunauthorizedissue.md new file mode 100644 index 0000000..bb52ae9 --- /dev/null +++ b/docs/models/envelopeitemcreatemanyunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemCreateManyUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdeletebadrequesterror.md b/docs/models/envelopeitemdeletebadrequesterror.md new file mode 100644 index 0000000..24fd493 --- /dev/null +++ b/docs/models/envelopeitemdeletebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeItemDeleteBadRequestError + +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.EnvelopeItemDeleteBadRequestIssue](../models/envelopeitemdeletebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdeletebadrequestissue.md b/docs/models/envelopeitemdeletebadrequestissue.md new file mode 100644 index 0000000..8879535 --- /dev/null +++ b/docs/models/envelopeitemdeletebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemDeleteBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdeleteforbiddenerror.md b/docs/models/envelopeitemdeleteforbiddenerror.md new file mode 100644 index 0000000..b6d4cfe --- /dev/null +++ b/docs/models/envelopeitemdeleteforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeItemDeleteForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeItemDeleteForbiddenIssue](../models/envelopeitemdeleteforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdeleteforbiddenissue.md b/docs/models/envelopeitemdeleteforbiddenissue.md new file mode 100644 index 0000000..f27d5d5 --- /dev/null +++ b/docs/models/envelopeitemdeleteforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemDeleteForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdeleteinternalservererror.md b/docs/models/envelopeitemdeleteinternalservererror.md new file mode 100644 index 0000000..cf14f62 --- /dev/null +++ b/docs/models/envelopeitemdeleteinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeItemDeleteInternalServerError + +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.EnvelopeItemDeleteInternalServerErrorIssue](../models/envelopeitemdeleteinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdeleteinternalservererrorissue.md b/docs/models/envelopeitemdeleteinternalservererrorissue.md new file mode 100644 index 0000000..416c43b --- /dev/null +++ b/docs/models/envelopeitemdeleteinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemDeleteInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdeleterequest.md b/docs/models/envelopeitemdeleterequest.md new file mode 100644 index 0000000..5fab0e6 --- /dev/null +++ b/docs/models/envelopeitemdeleterequest.md @@ -0,0 +1,9 @@ +# EnvelopeItemDeleteRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_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/envelopeitemdeleteresponse.md b/docs/models/envelopeitemdeleteresponse.md new file mode 100644 index 0000000..8fd3750 --- /dev/null +++ b/docs/models/envelopeitemdeleteresponse.md @@ -0,0 +1,10 @@ +# EnvelopeItemDeleteResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdeleteunauthorizederror.md b/docs/models/envelopeitemdeleteunauthorizederror.md new file mode 100644 index 0000000..04c8d04 --- /dev/null +++ b/docs/models/envelopeitemdeleteunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeItemDeleteUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeItemDeleteUnauthorizedIssue](../models/envelopeitemdeleteunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdeleteunauthorizedissue.md b/docs/models/envelopeitemdeleteunauthorizedissue.md new file mode 100644 index 0000000..c0a84ef --- /dev/null +++ b/docs/models/envelopeitemdeleteunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemDeleteUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadbadrequesterror.md b/docs/models/envelopeitemdownloadbadrequesterror.md new file mode 100644 index 0000000..a522110 --- /dev/null +++ b/docs/models/envelopeitemdownloadbadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeItemDownloadBadRequestError + +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.EnvelopeItemDownloadBadRequestIssue](../models/envelopeitemdownloadbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadbadrequestissue.md b/docs/models/envelopeitemdownloadbadrequestissue.md new file mode 100644 index 0000000..9b2ee7b --- /dev/null +++ b/docs/models/envelopeitemdownloadbadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemDownloadBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadforbiddenerror.md b/docs/models/envelopeitemdownloadforbiddenerror.md new file mode 100644 index 0000000..79834aa --- /dev/null +++ b/docs/models/envelopeitemdownloadforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeItemDownloadForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeItemDownloadForbiddenIssue](../models/envelopeitemdownloadforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadforbiddenissue.md b/docs/models/envelopeitemdownloadforbiddenissue.md new file mode 100644 index 0000000..6e42b7b --- /dev/null +++ b/docs/models/envelopeitemdownloadforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemDownloadForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadinternalservererror.md b/docs/models/envelopeitemdownloadinternalservererror.md new file mode 100644 index 0000000..606288b --- /dev/null +++ b/docs/models/envelopeitemdownloadinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeItemDownloadInternalServerError + +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.EnvelopeItemDownloadInternalServerErrorIssue](../models/envelopeitemdownloadinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadinternalservererrorissue.md b/docs/models/envelopeitemdownloadinternalservererrorissue.md new file mode 100644 index 0000000..7f222ce --- /dev/null +++ b/docs/models/envelopeitemdownloadinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemDownloadInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadnotfounderror.md b/docs/models/envelopeitemdownloadnotfounderror.md new file mode 100644 index 0000000..d394cf7 --- /dev/null +++ b/docs/models/envelopeitemdownloadnotfounderror.md @@ -0,0 +1,12 @@ +# EnvelopeItemDownloadNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeItemDownloadNotFoundIssue](../models/envelopeitemdownloadnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadnotfoundissue.md b/docs/models/envelopeitemdownloadnotfoundissue.md new file mode 100644 index 0000000..3e07fbb --- /dev/null +++ b/docs/models/envelopeitemdownloadnotfoundissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemDownloadNotFoundIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadrequest.md b/docs/models/envelopeitemdownloadrequest.md new file mode 100644 index 0000000..3ba94f9 --- /dev/null +++ b/docs/models/envelopeitemdownloadrequest.md @@ -0,0 +1,9 @@ +# EnvelopeItemDownloadRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `envelope_item_id` | *str* | :heavy_check_mark: | The ID of the envelope item to download. | +| `version` | [Optional[models.EnvelopeItemDownloadVersion]](../models/envelopeitemdownloadversion.md) | :heavy_minus_sign: | The version of the envelope item 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/envelopeitemdownloadresponse.md b/docs/models/envelopeitemdownloadresponse.md new file mode 100644 index 0000000..c3437cf --- /dev/null +++ b/docs/models/envelopeitemdownloadresponse.md @@ -0,0 +1,9 @@ +# EnvelopeItemDownloadResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------- | ---------------------- | ---------------------- | ---------------------- | +| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | +| `result` | *Any* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadunauthorizederror.md b/docs/models/envelopeitemdownloadunauthorizederror.md new file mode 100644 index 0000000..4bba1d9 --- /dev/null +++ b/docs/models/envelopeitemdownloadunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeItemDownloadUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeItemDownloadUnauthorizedIssue](../models/envelopeitemdownloadunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadunauthorizedissue.md b/docs/models/envelopeitemdownloadunauthorizedissue.md new file mode 100644 index 0000000..9d956b6 --- /dev/null +++ b/docs/models/envelopeitemdownloadunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemDownloadUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemdownloadversion.md b/docs/models/envelopeitemdownloadversion.md new file mode 100644 index 0000000..3c5b930 --- /dev/null +++ b/docs/models/envelopeitemdownloadversion.md @@ -0,0 +1,11 @@ +# EnvelopeItemDownloadVersion + +The version of the envelope item 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/models/envelopeitemupdatemanybadrequesterror.md b/docs/models/envelopeitemupdatemanybadrequesterror.md new file mode 100644 index 0000000..97802a5 --- /dev/null +++ b/docs/models/envelopeitemupdatemanybadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeItemUpdateManyBadRequestError + +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.EnvelopeItemUpdateManyBadRequestIssue](../models/envelopeitemupdatemanybadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemupdatemanybadrequestissue.md b/docs/models/envelopeitemupdatemanybadrequestissue.md new file mode 100644 index 0000000..44e81d2 --- /dev/null +++ b/docs/models/envelopeitemupdatemanybadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemUpdateManyBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemupdatemanydatarequest.md b/docs/models/envelopeitemupdatemanydatarequest.md new file mode 100644 index 0000000..1f47082 --- /dev/null +++ b/docs/models/envelopeitemupdatemanydatarequest.md @@ -0,0 +1,10 @@ +# EnvelopeItemUpdateManyDataRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | +| `order` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemupdatemanydataresponse.md b/docs/models/envelopeitemupdatemanydataresponse.md new file mode 100644 index 0000000..da43e41 --- /dev/null +++ b/docs/models/envelopeitemupdatemanydataresponse.md @@ -0,0 +1,11 @@ +# EnvelopeItemUpdateManyDataResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `order` | *float* | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemupdatemanyforbiddenerror.md b/docs/models/envelopeitemupdatemanyforbiddenerror.md new file mode 100644 index 0000000..6d631a2 --- /dev/null +++ b/docs/models/envelopeitemupdatemanyforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeItemUpdateManyForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeItemUpdateManyForbiddenIssue](../models/envelopeitemupdatemanyforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemupdatemanyforbiddenissue.md b/docs/models/envelopeitemupdatemanyforbiddenissue.md new file mode 100644 index 0000000..82ffc44 --- /dev/null +++ b/docs/models/envelopeitemupdatemanyforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemUpdateManyForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentupdatedocumentauthoptions.md b/docs/models/envelopeitemupdatemanyinternalservererror.md similarity index 60% rename from docs/models/documentupdatedocumentauthoptions.md rename to docs/models/envelopeitemupdatemanyinternalservererror.md index c849633..3788c04 100644 --- a/docs/models/documentupdatedocumentauthoptions.md +++ b/docs/models/envelopeitemupdatemanyinternalservererror.md @@ -1,9 +1,12 @@ -# DocumentUpdateDocumentAuthOptions +# EnvelopeItemUpdateManyInternalServerError + +Internal server error ## 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 +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeItemUpdateManyInternalServerErrorIssue](../models/envelopeitemupdatemanyinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemupdatemanyinternalservererrorissue.md b/docs/models/envelopeitemupdatemanyinternalservererrorissue.md new file mode 100644 index 0000000..0ea6cbf --- /dev/null +++ b/docs/models/envelopeitemupdatemanyinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemUpdateManyInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemupdatemanyrequest.md b/docs/models/envelopeitemupdatemanyrequest.md new file mode 100644 index 0000000..aac30c1 --- /dev/null +++ b/docs/models/envelopeitemupdatemanyrequest.md @@ -0,0 +1,9 @@ +# EnvelopeItemUpdateManyRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | List[[models.EnvelopeItemUpdateManyDataRequest](../models/envelopeitemupdatemanydatarequest.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemupdatemanyresponse.md b/docs/models/envelopeitemupdatemanyresponse.md new file mode 100644 index 0000000..25167f0 --- /dev/null +++ b/docs/models/envelopeitemupdatemanyresponse.md @@ -0,0 +1,10 @@ +# EnvelopeItemUpdateManyResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `data` | List[[models.EnvelopeItemUpdateManyDataResponse](../models/envelopeitemupdatemanydataresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemupdatemanyunauthorizederror.md b/docs/models/envelopeitemupdatemanyunauthorizederror.md new file mode 100644 index 0000000..f2b8f8e --- /dev/null +++ b/docs/models/envelopeitemupdatemanyunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeItemUpdateManyUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeItemUpdateManyUnauthorizedIssue](../models/envelopeitemupdatemanyunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeitemupdatemanyunauthorizedissue.md b/docs/models/envelopeitemupdatemanyunauthorizedissue.md new file mode 100644 index 0000000..4f48195 --- /dev/null +++ b/docs/models/envelopeitemupdatemanyunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeItemUpdateManyUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyaccessauthrequest.md b/docs/models/enveloperecipientcreatemanyaccessauthrequest.md new file mode 100644 index 0000000..f8b525c --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyaccessauthrequest.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientCreateManyAccessAuthRequest + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyaccessauthresponse.md b/docs/models/enveloperecipientcreatemanyaccessauthresponse.md new file mode 100644 index 0000000..453652f --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyaccessauthresponse.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientCreateManyAccessAuthResponse + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyactionauthrequest.md b/docs/models/enveloperecipientcreatemanyactionauthrequest.md new file mode 100644 index 0000000..faa6b8d --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyactionauthrequest.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientCreateManyActionAuthRequest + + +## 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/enveloperecipientcreatemanyactionauthresponse.md b/docs/models/enveloperecipientcreatemanyactionauthresponse.md new file mode 100644 index 0000000..a9b0bed --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyactionauthresponse.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientCreateManyActionAuthResponse + + +## 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/enveloperecipientcreatemanyauthoptions.md b/docs/models/enveloperecipientcreatemanyauthoptions.md new file mode 100644 index 0000000..449f698 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyauthoptions.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientCreateManyAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `access_auth` | List[[models.EnvelopeRecipientCreateManyAccessAuthResponse](../models/enveloperecipientcreatemanyaccessauthresponse.md)] | :heavy_check_mark: | N/A | +| `action_auth` | List[[models.EnvelopeRecipientCreateManyActionAuthResponse](../models/enveloperecipientcreatemanyactionauthresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanybadrequesterror.md b/docs/models/enveloperecipientcreatemanybadrequesterror.md new file mode 100644 index 0000000..92d8c7e --- /dev/null +++ b/docs/models/enveloperecipientcreatemanybadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientCreateManyBadRequestError + +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.EnvelopeRecipientCreateManyBadRequestIssue](../models/enveloperecipientcreatemanybadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanybadrequestissue.md b/docs/models/enveloperecipientcreatemanybadrequestissue.md new file mode 100644 index 0000000..57f3936 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanybadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientCreateManyBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanydatarequest.md b/docs/models/enveloperecipientcreatemanydatarequest.md new file mode 100644 index 0000000..dfa302f --- /dev/null +++ b/docs/models/enveloperecipientcreatemanydatarequest.md @@ -0,0 +1,13 @@ +# EnvelopeRecipientCreateManyDataRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `email` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `role` | [models.EnvelopeRecipientCreateManyRoleRequest](../models/enveloperecipientcreatemanyrolerequest.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `access_auth` | List[[models.EnvelopeRecipientCreateManyAccessAuthRequest](../models/enveloperecipientcreatemanyaccessauthrequest.md)] | :heavy_minus_sign: | N/A | +| `action_auth` | List[[models.EnvelopeRecipientCreateManyActionAuthRequest](../models/enveloperecipientcreatemanyactionauthrequest.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanydataresponse.md b/docs/models/enveloperecipientcreatemanydataresponse.md new file mode 100644 index 0000000..c6de118 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanydataresponse.md @@ -0,0 +1,22 @@ +# EnvelopeRecipientCreateManyDataResponse + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `role` | [models.EnvelopeRecipientCreateManyRoleResponse](../models/enveloperecipientcreatemanyroleresponse.md) | :heavy_check_mark: | N/A | +| `read_status` | [models.EnvelopeRecipientCreateManyReadStatus](../models/enveloperecipientcreatemanyreadstatus.md) | :heavy_check_mark: | N/A | +| `signing_status` | [models.EnvelopeRecipientCreateManySigningStatus](../models/enveloperecipientcreatemanysigningstatus.md) | :heavy_check_mark: | N/A | +| `send_status` | [models.EnvelopeRecipientCreateManySendStatus](../models/enveloperecipientcreatemanysendstatus.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.EnvelopeRecipientCreateManyAuthOptions]](../models/enveloperecipientcreatemanyauthoptions.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyforbiddenerror.md b/docs/models/enveloperecipientcreatemanyforbiddenerror.md new file mode 100644 index 0000000..c269b6f --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientCreateManyForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRecipientCreateManyForbiddenIssue](../models/enveloperecipientcreatemanyforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyforbiddenissue.md b/docs/models/enveloperecipientcreatemanyforbiddenissue.md new file mode 100644 index 0000000..45c5e33 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientCreateManyForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyinternalservererror.md b/docs/models/enveloperecipientcreatemanyinternalservererror.md new file mode 100644 index 0000000..38c60d2 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientCreateManyInternalServerError + +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.EnvelopeRecipientCreateManyInternalServerErrorIssue](../models/enveloperecipientcreatemanyinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyinternalservererrorissue.md b/docs/models/enveloperecipientcreatemanyinternalservererrorissue.md new file mode 100644 index 0000000..3d5958b --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientCreateManyInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyreadstatus.md b/docs/models/enveloperecipientcreatemanyreadstatus.md new file mode 100644 index 0000000..90a37bf --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyreadstatus.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientCreateManyReadStatus + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `NOT_OPENED` | NOT_OPENED | +| `OPENED` | OPENED | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyrequest.md b/docs/models/enveloperecipientcreatemanyrequest.md new file mode 100644 index 0000000..1471d70 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyrequest.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientCreateManyRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | List[[models.EnvelopeRecipientCreateManyDataRequest](../models/enveloperecipientcreatemanydatarequest.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyresponse.md b/docs/models/enveloperecipientcreatemanyresponse.md new file mode 100644 index 0000000..2978ae1 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyresponse.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientCreateManyResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `data` | List[[models.EnvelopeRecipientCreateManyDataResponse](../models/enveloperecipientcreatemanydataresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyrolerequest.md b/docs/models/enveloperecipientcreatemanyrolerequest.md new file mode 100644 index 0000000..a745b5c --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyrolerequest.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientCreateManyRoleRequest + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `CC` | CC | +| `SIGNER` | SIGNER | +| `VIEWER` | VIEWER | +| `APPROVER` | APPROVER | +| `ASSISTANT` | ASSISTANT | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyroleresponse.md b/docs/models/enveloperecipientcreatemanyroleresponse.md new file mode 100644 index 0000000..521d862 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyroleresponse.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientCreateManyRoleResponse + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `CC` | CC | +| `SIGNER` | SIGNER | +| `VIEWER` | VIEWER | +| `APPROVER` | APPROVER | +| `ASSISTANT` | ASSISTANT | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanysendstatus.md b/docs/models/enveloperecipientcreatemanysendstatus.md new file mode 100644 index 0000000..4df04e9 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanysendstatus.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientCreateManySendStatus + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `NOT_SENT` | NOT_SENT | +| `SENT` | SENT | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanysigningstatus.md b/docs/models/enveloperecipientcreatemanysigningstatus.md new file mode 100644 index 0000000..9ca6106 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanysigningstatus.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientCreateManySigningStatus + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `NOT_SIGNED` | NOT_SIGNED | +| `SIGNED` | SIGNED | +| `REJECTED` | REJECTED | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyunauthorizederror.md b/docs/models/enveloperecipientcreatemanyunauthorizederror.md new file mode 100644 index 0000000..860ab98 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientCreateManyUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRecipientCreateManyUnauthorizedIssue](../models/enveloperecipientcreatemanyunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientcreatemanyunauthorizedissue.md b/docs/models/enveloperecipientcreatemanyunauthorizedissue.md new file mode 100644 index 0000000..45db609 --- /dev/null +++ b/docs/models/enveloperecipientcreatemanyunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientCreateManyUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientdeletebadrequesterror.md b/docs/models/enveloperecipientdeletebadrequesterror.md new file mode 100644 index 0000000..7c488ec --- /dev/null +++ b/docs/models/enveloperecipientdeletebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientDeleteBadRequestError + +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.EnvelopeRecipientDeleteBadRequestIssue](../models/enveloperecipientdeletebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientdeletebadrequestissue.md b/docs/models/enveloperecipientdeletebadrequestissue.md new file mode 100644 index 0000000..c213c1b --- /dev/null +++ b/docs/models/enveloperecipientdeletebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientDeleteBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientdeleteforbiddenerror.md b/docs/models/enveloperecipientdeleteforbiddenerror.md new file mode 100644 index 0000000..a74f3ed --- /dev/null +++ b/docs/models/enveloperecipientdeleteforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientDeleteForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRecipientDeleteForbiddenIssue](../models/enveloperecipientdeleteforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientdeleteforbiddenissue.md b/docs/models/enveloperecipientdeleteforbiddenissue.md new file mode 100644 index 0000000..b3ad818 --- /dev/null +++ b/docs/models/enveloperecipientdeleteforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientDeleteForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientdeleteinternalservererror.md b/docs/models/enveloperecipientdeleteinternalservererror.md new file mode 100644 index 0000000..2dc37f6 --- /dev/null +++ b/docs/models/enveloperecipientdeleteinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientDeleteInternalServerError + +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.EnvelopeRecipientDeleteInternalServerErrorIssue](../models/enveloperecipientdeleteinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientdeleteinternalservererrorissue.md b/docs/models/enveloperecipientdeleteinternalservererrorissue.md new file mode 100644 index 0000000..43bb5cf --- /dev/null +++ b/docs/models/enveloperecipientdeleteinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientDeleteInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientdeleterequest.md b/docs/models/enveloperecipientdeleterequest.md new file mode 100644 index 0000000..13e7131 --- /dev/null +++ b/docs/models/enveloperecipientdeleterequest.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientDeleteRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientdeleteresponse.md b/docs/models/enveloperecipientdeleteresponse.md new file mode 100644 index 0000000..563f747 --- /dev/null +++ b/docs/models/enveloperecipientdeleteresponse.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientDeleteResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientdeleteunauthorizederror.md b/docs/models/enveloperecipientdeleteunauthorizederror.md new file mode 100644 index 0000000..00f4b14 --- /dev/null +++ b/docs/models/enveloperecipientdeleteunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientDeleteUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRecipientDeleteUnauthorizedIssue](../models/enveloperecipientdeleteunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientdeleteunauthorizedissue.md b/docs/models/enveloperecipientdeleteunauthorizedissue.md new file mode 100644 index 0000000..38942ab --- /dev/null +++ b/docs/models/enveloperecipientdeleteunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientDeleteUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetaccessauth.md b/docs/models/enveloperecipientgetaccessauth.md new file mode 100644 index 0000000..8224076 --- /dev/null +++ b/docs/models/enveloperecipientgetaccessauth.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientGetAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetactionauth.md b/docs/models/enveloperecipientgetactionauth.md new file mode 100644 index 0000000..3edc440 --- /dev/null +++ b/docs/models/enveloperecipientgetactionauth.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientGetActionAuth + + +## 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/enveloperecipientgetauthoptions.md b/docs/models/enveloperecipientgetauthoptions.md new file mode 100644 index 0000000..a62c39c --- /dev/null +++ b/docs/models/enveloperecipientgetauthoptions.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientGetAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `access_auth` | List[[models.EnvelopeRecipientGetAccessAuth](../models/enveloperecipientgetaccessauth.md)] | :heavy_check_mark: | N/A | +| `action_auth` | List[[models.EnvelopeRecipientGetActionAuth](../models/enveloperecipientgetactionauth.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetbadrequesterror.md b/docs/models/enveloperecipientgetbadrequesterror.md new file mode 100644 index 0000000..86af84a --- /dev/null +++ b/docs/models/enveloperecipientgetbadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientGetBadRequestError + +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.EnvelopeRecipientGetBadRequestIssue](../models/enveloperecipientgetbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetbadrequestissue.md b/docs/models/enveloperecipientgetbadrequestissue.md new file mode 100644 index 0000000..76ce22e --- /dev/null +++ b/docs/models/enveloperecipientgetbadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetdirection1.md b/docs/models/enveloperecipientgetdirection1.md new file mode 100644 index 0000000..affe5d1 --- /dev/null +++ b/docs/models/enveloperecipientgetdirection1.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientGetDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetdirection2.md b/docs/models/enveloperecipientgetdirection2.md new file mode 100644 index 0000000..28ae0ea --- /dev/null +++ b/docs/models/enveloperecipientgetdirection2.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientGetDirection2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetfield.md b/docs/models/enveloperecipientgetfield.md new file mode 100644 index 0000000..be8868f --- /dev/null +++ b/docs/models/enveloperecipientgetfield.md @@ -0,0 +1,23 @@ +# EnvelopeRecipientGetField + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeRecipientGetType](../models/enveloperecipientgettype.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: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | N/A | +| `custom_text` | *str* | :heavy_check_mark: | N/A | +| `inserted` | *bool* | :heavy_check_mark: | N/A | +| `field_meta` | [Nullable[models.EnvelopeRecipientGetFieldMetaUnion]](../models/enveloperecipientgetfieldmetaunion.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/enveloperecipientgetfieldmetacheckbox.md b/docs/models/enveloperecipientgetfieldmetacheckbox.md new file mode 100644 index 0000000..6cae962 --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetacheckbox.md @@ -0,0 +1,17 @@ +# EnvelopeRecipientGetFieldMetaCheckbox + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeRecipientGetTypeCheckbox](../models/enveloperecipientgettypecheckbox.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeRecipientGetValue2](../models/enveloperecipientgetvalue2.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.EnvelopeRecipientGetDirection2]](../models/enveloperecipientgetdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetfieldmetadate.md b/docs/models/enveloperecipientgetfieldmetadate.md new file mode 100644 index 0000000..ab98ebc --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetadate.md @@ -0,0 +1,14 @@ +# EnvelopeRecipientGetFieldMetaDate + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeRecipientGetTypeDate](../models/enveloperecipientgettypedate.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeRecipientGetTextAlign4]](../models/enveloperecipientgettextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetfieldmetadropdown.md b/docs/models/enveloperecipientgetfieldmetadropdown.md new file mode 100644 index 0000000..9957873 --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetadropdown.md @@ -0,0 +1,15 @@ +# EnvelopeRecipientGetFieldMetaDropdown + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeRecipientGetTypeDropdown](../models/enveloperecipientgettypedropdown.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeRecipientGetValue3](../models/enveloperecipientgetvalue3.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/enveloperecipientgetfieldmetaemail.md b/docs/models/enveloperecipientgetfieldmetaemail.md new file mode 100644 index 0000000..6903e59 --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetaemail.md @@ -0,0 +1,14 @@ +# EnvelopeRecipientGetFieldMetaEmail + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeRecipientGetTypeEmail](../models/enveloperecipientgettypeemail.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeRecipientGetTextAlign3]](../models/enveloperecipientgettextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetfieldmetainitials.md b/docs/models/enveloperecipientgetfieldmetainitials.md new file mode 100644 index 0000000..2a85351 --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetainitials.md @@ -0,0 +1,14 @@ +# EnvelopeRecipientGetFieldMetaInitials + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeRecipientGetTypeInitials](../models/enveloperecipientgettypeinitials.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeRecipientGetTextAlign1]](../models/enveloperecipientgettextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetfieldmetaname.md b/docs/models/enveloperecipientgetfieldmetaname.md new file mode 100644 index 0000000..4bfcfa6 --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetaname.md @@ -0,0 +1,14 @@ +# EnvelopeRecipientGetFieldMetaName + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeRecipientGetTypeName](../models/enveloperecipientgettypename.md) | :heavy_check_mark: | N/A | +| `text_align` | [Optional[models.EnvelopeRecipientGetTextAlign2]](../models/enveloperecipientgettextalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetfieldmetanumber.md b/docs/models/enveloperecipientgetfieldmetanumber.md new file mode 100644 index 0000000..ff67567 --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetanumber.md @@ -0,0 +1,21 @@ +# EnvelopeRecipientGetFieldMetaNumber + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeRecipientGetTypeNumber](../models/enveloperecipientgettypenumber.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 | +| `text_align` | [Optional[models.EnvelopeRecipientGetTextAlign6]](../models/enveloperecipientgettextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeRecipientGetVerticalAlign2]](../models/enveloperecipientgetverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetfieldmetaradio.md b/docs/models/enveloperecipientgetfieldmetaradio.md new file mode 100644 index 0000000..68dc321 --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetaradio.md @@ -0,0 +1,15 @@ +# EnvelopeRecipientGetFieldMetaRadio + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeRecipientGetTypeRadio](../models/enveloperecipientgettyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.EnvelopeRecipientGetValue1](../models/enveloperecipientgetvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.EnvelopeRecipientGetDirection1]](../models/enveloperecipientgetdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetfieldmetasignature.md b/docs/models/enveloperecipientgetfieldmetasignature.md new file mode 100644 index 0000000..938ab59 --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetasignature.md @@ -0,0 +1,13 @@ +# EnvelopeRecipientGetFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeRecipientGetTypeSignature](../models/enveloperecipientgettypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetfieldmetatext.md b/docs/models/enveloperecipientgetfieldmetatext.md new file mode 100644 index 0000000..7a5f12c --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetatext.md @@ -0,0 +1,19 @@ +# EnvelopeRecipientGetFieldMetaText + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.EnvelopeRecipientGetTypeText](../models/enveloperecipientgettypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.EnvelopeRecipientGetTextAlign5]](../models/enveloperecipientgettextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.EnvelopeRecipientGetVerticalAlign1]](../models/enveloperecipientgetverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetfieldmetaunion.md b/docs/models/enveloperecipientgetfieldmetaunion.md new file mode 100644 index 0000000..600feef --- /dev/null +++ b/docs/models/enveloperecipientgetfieldmetaunion.md @@ -0,0 +1,65 @@ +# EnvelopeRecipientGetFieldMetaUnion + + +## Supported Types + +### `models.EnvelopeRecipientGetFieldMetaSignature` + +```python +value: models.EnvelopeRecipientGetFieldMetaSignature = /* values here */ +``` + +### `models.EnvelopeRecipientGetFieldMetaInitials` + +```python +value: models.EnvelopeRecipientGetFieldMetaInitials = /* values here */ +``` + +### `models.EnvelopeRecipientGetFieldMetaName` + +```python +value: models.EnvelopeRecipientGetFieldMetaName = /* values here */ +``` + +### `models.EnvelopeRecipientGetFieldMetaEmail` + +```python +value: models.EnvelopeRecipientGetFieldMetaEmail = /* values here */ +``` + +### `models.EnvelopeRecipientGetFieldMetaDate` + +```python +value: models.EnvelopeRecipientGetFieldMetaDate = /* values here */ +``` + +### `models.EnvelopeRecipientGetFieldMetaText` + +```python +value: models.EnvelopeRecipientGetFieldMetaText = /* values here */ +``` + +### `models.EnvelopeRecipientGetFieldMetaNumber` + +```python +value: models.EnvelopeRecipientGetFieldMetaNumber = /* values here */ +``` + +### `models.EnvelopeRecipientGetFieldMetaRadio` + +```python +value: models.EnvelopeRecipientGetFieldMetaRadio = /* values here */ +``` + +### `models.EnvelopeRecipientGetFieldMetaCheckbox` + +```python +value: models.EnvelopeRecipientGetFieldMetaCheckbox = /* values here */ +``` + +### `models.EnvelopeRecipientGetFieldMetaDropdown` + +```python +value: models.EnvelopeRecipientGetFieldMetaDropdown = /* values here */ +``` + diff --git a/docs/models/enveloperecipientgetforbiddenerror.md b/docs/models/enveloperecipientgetforbiddenerror.md new file mode 100644 index 0000000..ed911e2 --- /dev/null +++ b/docs/models/enveloperecipientgetforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientGetForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRecipientGetForbiddenIssue](../models/enveloperecipientgetforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetforbiddenissue.md b/docs/models/enveloperecipientgetforbiddenissue.md new file mode 100644 index 0000000..b27df3c --- /dev/null +++ b/docs/models/enveloperecipientgetforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetinternalservererror.md b/docs/models/enveloperecipientgetinternalservererror.md new file mode 100644 index 0000000..fba1ac8 --- /dev/null +++ b/docs/models/enveloperecipientgetinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientGetInternalServerError + +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.EnvelopeRecipientGetInternalServerErrorIssue](../models/enveloperecipientgetinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetinternalservererrorissue.md b/docs/models/enveloperecipientgetinternalservererrorissue.md new file mode 100644 index 0000000..67f8f47 --- /dev/null +++ b/docs/models/enveloperecipientgetinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetnotfounderror.md b/docs/models/enveloperecipientgetnotfounderror.md new file mode 100644 index 0000000..de05f96 --- /dev/null +++ b/docs/models/enveloperecipientgetnotfounderror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientGetNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRecipientGetNotFoundIssue](../models/enveloperecipientgetnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetnotfoundissue.md b/docs/models/enveloperecipientgetnotfoundissue.md new file mode 100644 index 0000000..99268cb --- /dev/null +++ b/docs/models/enveloperecipientgetnotfoundissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetNotFoundIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetreadstatus.md b/docs/models/enveloperecipientgetreadstatus.md new file mode 100644 index 0000000..8a9f132 --- /dev/null +++ b/docs/models/enveloperecipientgetreadstatus.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientGetReadStatus + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `NOT_OPENED` | NOT_OPENED | +| `OPENED` | OPENED | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetrequest.md b/docs/models/enveloperecipientgetrequest.md new file mode 100644 index 0000000..a803c9b --- /dev/null +++ b/docs/models/enveloperecipientgetrequest.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetresponse.md b/docs/models/enveloperecipientgetresponse.md new file mode 100644 index 0000000..fc8f3e7 --- /dev/null +++ b/docs/models/enveloperecipientgetresponse.md @@ -0,0 +1,25 @@ +# EnvelopeRecipientGetResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `role` | [models.EnvelopeRecipientGetRole](../models/enveloperecipientgetrole.md) | :heavy_check_mark: | N/A | +| `read_status` | [models.EnvelopeRecipientGetReadStatus](../models/enveloperecipientgetreadstatus.md) | :heavy_check_mark: | N/A | +| `signing_status` | [models.EnvelopeRecipientGetSigningStatus](../models/enveloperecipientgetsigningstatus.md) | :heavy_check_mark: | N/A | +| `send_status` | [models.EnvelopeRecipientGetSendStatus](../models/enveloperecipientgetsendstatus.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.EnvelopeRecipientGetAuthOptions]](../models/enveloperecipientgetauthoptions.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `fields` | List[[models.EnvelopeRecipientGetField](../models/enveloperecipientgetfield.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetrole.md b/docs/models/enveloperecipientgetrole.md new file mode 100644 index 0000000..2584001 --- /dev/null +++ b/docs/models/enveloperecipientgetrole.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientGetRole + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `CC` | CC | +| `SIGNER` | SIGNER | +| `VIEWER` | VIEWER | +| `APPROVER` | APPROVER | +| `ASSISTANT` | ASSISTANT | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetsendstatus.md b/docs/models/enveloperecipientgetsendstatus.md new file mode 100644 index 0000000..356fae9 --- /dev/null +++ b/docs/models/enveloperecipientgetsendstatus.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientGetSendStatus + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `NOT_SENT` | NOT_SENT | +| `SENT` | SENT | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetsigningstatus.md b/docs/models/enveloperecipientgetsigningstatus.md new file mode 100644 index 0000000..d61b010 --- /dev/null +++ b/docs/models/enveloperecipientgetsigningstatus.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetSigningStatus + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `NOT_SIGNED` | NOT_SIGNED | +| `SIGNED` | SIGNED | +| `REJECTED` | REJECTED | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettextalign1.md b/docs/models/enveloperecipientgettextalign1.md new file mode 100644 index 0000000..f0a31b6 --- /dev/null +++ b/docs/models/enveloperecipientgettextalign1.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetTextAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettextalign2.md b/docs/models/enveloperecipientgettextalign2.md new file mode 100644 index 0000000..6463719 --- /dev/null +++ b/docs/models/enveloperecipientgettextalign2.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetTextAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettextalign3.md b/docs/models/enveloperecipientgettextalign3.md new file mode 100644 index 0000000..3c74954 --- /dev/null +++ b/docs/models/enveloperecipientgettextalign3.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetTextAlign3 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettextalign4.md b/docs/models/enveloperecipientgettextalign4.md new file mode 100644 index 0000000..ee67758 --- /dev/null +++ b/docs/models/enveloperecipientgettextalign4.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetTextAlign4 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettextalign5.md b/docs/models/enveloperecipientgettextalign5.md new file mode 100644 index 0000000..0844bea --- /dev/null +++ b/docs/models/enveloperecipientgettextalign5.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetTextAlign5 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettextalign6.md b/docs/models/enveloperecipientgettextalign6.md new file mode 100644 index 0000000..2479e69 --- /dev/null +++ b/docs/models/enveloperecipientgettextalign6.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetTextAlign6 + + +## Values + +| Name | Value | +| -------- | -------- | +| `LEFT` | left | +| `CENTER` | center | +| `RIGHT` | right | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettype.md b/docs/models/enveloperecipientgettype.md new file mode 100644 index 0000000..7814648 --- /dev/null +++ b/docs/models/enveloperecipientgettype.md @@ -0,0 +1,18 @@ +# EnvelopeRecipientGetType + + +## 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/enveloperecipientgettypecheckbox.md b/docs/models/enveloperecipientgettypecheckbox.md new file mode 100644 index 0000000..ccb9fa6 --- /dev/null +++ b/docs/models/enveloperecipientgettypecheckbox.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetTypeCheckbox + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettypedate.md b/docs/models/enveloperecipientgettypedate.md new file mode 100644 index 0000000..d078109 --- /dev/null +++ b/docs/models/enveloperecipientgettypedate.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetTypeDate + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettypedropdown.md b/docs/models/enveloperecipientgettypedropdown.md new file mode 100644 index 0000000..b3a7ca0 --- /dev/null +++ b/docs/models/enveloperecipientgettypedropdown.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetTypeDropdown + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettypeemail.md b/docs/models/enveloperecipientgettypeemail.md new file mode 100644 index 0000000..c168dbc --- /dev/null +++ b/docs/models/enveloperecipientgettypeemail.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetTypeEmail + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | email | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettypeinitials.md b/docs/models/enveloperecipientgettypeinitials.md new file mode 100644 index 0000000..47fba21 --- /dev/null +++ b/docs/models/enveloperecipientgettypeinitials.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetTypeInitials + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INITIALS` | initials | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettypename.md b/docs/models/enveloperecipientgettypename.md new file mode 100644 index 0000000..c9463ad --- /dev/null +++ b/docs/models/enveloperecipientgettypename.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetTypeName + + +## Values + +| Name | Value | +| ------ | ------ | +| `NAME` | name | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettypenumber.md b/docs/models/enveloperecipientgettypenumber.md new file mode 100644 index 0000000..48c6e79 --- /dev/null +++ b/docs/models/enveloperecipientgettypenumber.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetTypeNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettyperadio.md b/docs/models/enveloperecipientgettyperadio.md new file mode 100644 index 0000000..bca8977 --- /dev/null +++ b/docs/models/enveloperecipientgettyperadio.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetTypeRadio + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettypesignature.md b/docs/models/enveloperecipientgettypesignature.md new file mode 100644 index 0000000..56c0849 --- /dev/null +++ b/docs/models/enveloperecipientgettypesignature.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/enveloperecipientgettypetext.md b/docs/models/enveloperecipientgettypetext.md new file mode 100644 index 0000000..5c562ea --- /dev/null +++ b/docs/models/enveloperecipientgettypetext.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetTypeText + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetunauthorizederror.md b/docs/models/enveloperecipientgetunauthorizederror.md new file mode 100644 index 0000000..7d0a39a --- /dev/null +++ b/docs/models/enveloperecipientgetunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientGetUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRecipientGetUnauthorizedIssue](../models/enveloperecipientgetunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetunauthorizedissue.md b/docs/models/enveloperecipientgetunauthorizedissue.md new file mode 100644 index 0000000..e12df68 --- /dev/null +++ b/docs/models/enveloperecipientgetunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetvalue1.md b/docs/models/enveloperecipientgetvalue1.md new file mode 100644 index 0000000..03dfe6f --- /dev/null +++ b/docs/models/enveloperecipientgetvalue1.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetValue1 + + +## 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/enveloperecipientgetvalue2.md b/docs/models/enveloperecipientgetvalue2.md new file mode 100644 index 0000000..f745b8c --- /dev/null +++ b/docs/models/enveloperecipientgetvalue2.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetValue2 + + +## 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/enveloperecipientgetvalue3.md b/docs/models/enveloperecipientgetvalue3.md new file mode 100644 index 0000000..98acdac --- /dev/null +++ b/docs/models/enveloperecipientgetvalue3.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientGetValue3 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetverticalalign1.md b/docs/models/enveloperecipientgetverticalalign1.md new file mode 100644 index 0000000..33774b9 --- /dev/null +++ b/docs/models/enveloperecipientgetverticalalign1.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/enveloperecipientgetverticalalign2.md b/docs/models/enveloperecipientgetverticalalign2.md new file mode 100644 index 0000000..187fa6f --- /dev/null +++ b/docs/models/enveloperecipientgetverticalalign2.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientGetVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyaccessauthrequest.md b/docs/models/enveloperecipientupdatemanyaccessauthrequest.md new file mode 100644 index 0000000..efb7d68 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyaccessauthrequest.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientUpdateManyAccessAuthRequest + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyaccessauthresponse.md b/docs/models/enveloperecipientupdatemanyaccessauthresponse.md new file mode 100644 index 0000000..f17f931 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyaccessauthresponse.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientUpdateManyAccessAuthResponse + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyactionauthrequest.md b/docs/models/enveloperecipientupdatemanyactionauthrequest.md new file mode 100644 index 0000000..0a68341 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyactionauthrequest.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientUpdateManyActionAuthRequest + + +## 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/enveloperecipientupdatemanyactionauthresponse.md b/docs/models/enveloperecipientupdatemanyactionauthresponse.md new file mode 100644 index 0000000..c43eed6 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyactionauthresponse.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientUpdateManyActionAuthResponse + + +## 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/enveloperecipientupdatemanyauthoptions.md b/docs/models/enveloperecipientupdatemanyauthoptions.md new file mode 100644 index 0000000..fa3c826 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyauthoptions.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientUpdateManyAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `access_auth` | List[[models.EnvelopeRecipientUpdateManyAccessAuthResponse](../models/enveloperecipientupdatemanyaccessauthresponse.md)] | :heavy_check_mark: | N/A | +| `action_auth` | List[[models.EnvelopeRecipientUpdateManyActionAuthResponse](../models/enveloperecipientupdatemanyactionauthresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanybadrequesterror.md b/docs/models/enveloperecipientupdatemanybadrequesterror.md new file mode 100644 index 0000000..26fb2c8 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanybadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientUpdateManyBadRequestError + +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.EnvelopeRecipientUpdateManyBadRequestIssue](../models/enveloperecipientupdatemanybadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanybadrequestissue.md b/docs/models/enveloperecipientupdatemanybadrequestissue.md new file mode 100644 index 0000000..7b2092c --- /dev/null +++ b/docs/models/enveloperecipientupdatemanybadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientUpdateManyBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanydatarequest.md b/docs/models/enveloperecipientupdatemanydatarequest.md new file mode 100644 index 0000000..e77f525 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanydatarequest.md @@ -0,0 +1,14 @@ +# EnvelopeRecipientUpdateManyDataRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `id` | *float* | :heavy_check_mark: | N/A | +| `email` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `role` | [Optional[models.EnvelopeRecipientUpdateManyRoleRequest]](../models/enveloperecipientupdatemanyrolerequest.md) | :heavy_minus_sign: | N/A | +| `signing_order` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `access_auth` | List[[models.EnvelopeRecipientUpdateManyAccessAuthRequest](../models/enveloperecipientupdatemanyaccessauthrequest.md)] | :heavy_minus_sign: | N/A | +| `action_auth` | List[[models.EnvelopeRecipientUpdateManyActionAuthRequest](../models/enveloperecipientupdatemanyactionauthrequest.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanydataresponse.md b/docs/models/enveloperecipientupdatemanydataresponse.md new file mode 100644 index 0000000..32b0c9c --- /dev/null +++ b/docs/models/enveloperecipientupdatemanydataresponse.md @@ -0,0 +1,24 @@ +# EnvelopeRecipientUpdateManyDataResponse + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `role` | [models.EnvelopeRecipientUpdateManyRoleResponse](../models/enveloperecipientupdatemanyroleresponse.md) | :heavy_check_mark: | N/A | +| `read_status` | [models.EnvelopeRecipientUpdateManyReadStatus](../models/enveloperecipientupdatemanyreadstatus.md) | :heavy_check_mark: | N/A | +| `signing_status` | [models.EnvelopeRecipientUpdateManySigningStatus](../models/enveloperecipientupdatemanysigningstatus.md) | :heavy_check_mark: | N/A | +| `send_status` | [models.EnvelopeRecipientUpdateManySendStatus](../models/enveloperecipientupdatemanysendstatus.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.EnvelopeRecipientUpdateManyAuthOptions]](../models/enveloperecipientupdatemanyauthoptions.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `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/enveloperecipientupdatemanyforbiddenerror.md b/docs/models/enveloperecipientupdatemanyforbiddenerror.md new file mode 100644 index 0000000..788e1b8 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientUpdateManyForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRecipientUpdateManyForbiddenIssue](../models/enveloperecipientupdatemanyforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyforbiddenissue.md b/docs/models/enveloperecipientupdatemanyforbiddenissue.md new file mode 100644 index 0000000..70fc2ad --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientUpdateManyForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyinternalservererror.md b/docs/models/enveloperecipientupdatemanyinternalservererror.md new file mode 100644 index 0000000..3a229d2 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientUpdateManyInternalServerError + +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.EnvelopeRecipientUpdateManyInternalServerErrorIssue](../models/enveloperecipientupdatemanyinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyinternalservererrorissue.md b/docs/models/enveloperecipientupdatemanyinternalservererrorissue.md new file mode 100644 index 0000000..9545662 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientUpdateManyInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyreadstatus.md b/docs/models/enveloperecipientupdatemanyreadstatus.md new file mode 100644 index 0000000..93358a8 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyreadstatus.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientUpdateManyReadStatus + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `NOT_OPENED` | NOT_OPENED | +| `OPENED` | OPENED | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyrequest.md b/docs/models/enveloperecipientupdatemanyrequest.md new file mode 100644 index 0000000..231c0d2 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyrequest.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientUpdateManyRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | List[[models.EnvelopeRecipientUpdateManyDataRequest](../models/enveloperecipientupdatemanydatarequest.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyresponse.md b/docs/models/enveloperecipientupdatemanyresponse.md new file mode 100644 index 0000000..431f97e --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyresponse.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientUpdateManyResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `data` | List[[models.EnvelopeRecipientUpdateManyDataResponse](../models/enveloperecipientupdatemanydataresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyrolerequest.md b/docs/models/enveloperecipientupdatemanyrolerequest.md new file mode 100644 index 0000000..b9cdfd3 --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyrolerequest.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientUpdateManyRoleRequest + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `CC` | CC | +| `SIGNER` | SIGNER | +| `VIEWER` | VIEWER | +| `APPROVER` | APPROVER | +| `ASSISTANT` | ASSISTANT | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyroleresponse.md b/docs/models/enveloperecipientupdatemanyroleresponse.md new file mode 100644 index 0000000..f58f8eb --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyroleresponse.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientUpdateManyRoleResponse + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `CC` | CC | +| `SIGNER` | SIGNER | +| `VIEWER` | VIEWER | +| `APPROVER` | APPROVER | +| `ASSISTANT` | ASSISTANT | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanysendstatus.md b/docs/models/enveloperecipientupdatemanysendstatus.md new file mode 100644 index 0000000..11c3ebe --- /dev/null +++ b/docs/models/enveloperecipientupdatemanysendstatus.md @@ -0,0 +1,9 @@ +# EnvelopeRecipientUpdateManySendStatus + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `NOT_SENT` | NOT_SENT | +| `SENT` | SENT | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanysigningstatus.md b/docs/models/enveloperecipientupdatemanysigningstatus.md new file mode 100644 index 0000000..db1265e --- /dev/null +++ b/docs/models/enveloperecipientupdatemanysigningstatus.md @@ -0,0 +1,10 @@ +# EnvelopeRecipientUpdateManySigningStatus + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `NOT_SIGNED` | NOT_SIGNED | +| `SIGNED` | SIGNED | +| `REJECTED` | REJECTED | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyunauthorizederror.md b/docs/models/enveloperecipientupdatemanyunauthorizederror.md new file mode 100644 index 0000000..b53792c --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeRecipientUpdateManyUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRecipientUpdateManyUnauthorizedIssue](../models/enveloperecipientupdatemanyunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperecipientupdatemanyunauthorizedissue.md b/docs/models/enveloperecipientupdatemanyunauthorizedissue.md new file mode 100644 index 0000000..6e6128a --- /dev/null +++ b/docs/models/enveloperecipientupdatemanyunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeRecipientUpdateManyUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperedistributebadrequesterror.md b/docs/models/enveloperedistributebadrequesterror.md new file mode 100644 index 0000000..6806fc5 --- /dev/null +++ b/docs/models/enveloperedistributebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeRedistributeBadRequestError + +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.EnvelopeRedistributeBadRequestIssue](../models/enveloperedistributebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperedistributebadrequestissue.md b/docs/models/enveloperedistributebadrequestissue.md new file mode 100644 index 0000000..0f3410e --- /dev/null +++ b/docs/models/enveloperedistributebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeRedistributeBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperedistributeforbiddenerror.md b/docs/models/enveloperedistributeforbiddenerror.md new file mode 100644 index 0000000..39bdb34 --- /dev/null +++ b/docs/models/enveloperedistributeforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeRedistributeForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRedistributeForbiddenIssue](../models/enveloperedistributeforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperedistributeforbiddenissue.md b/docs/models/enveloperedistributeforbiddenissue.md new file mode 100644 index 0000000..8fdca6c --- /dev/null +++ b/docs/models/enveloperedistributeforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeRedistributeForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperedistributeinternalservererror.md b/docs/models/enveloperedistributeinternalservererror.md new file mode 100644 index 0000000..72aa8dd --- /dev/null +++ b/docs/models/enveloperedistributeinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeRedistributeInternalServerError + +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.EnvelopeRedistributeInternalServerErrorIssue](../models/enveloperedistributeinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperedistributeinternalservererrorissue.md b/docs/models/enveloperedistributeinternalservererrorissue.md new file mode 100644 index 0000000..0177821 --- /dev/null +++ b/docs/models/enveloperedistributeinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeRedistributeInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperedistributerequest.md b/docs/models/enveloperedistributerequest.md new file mode 100644 index 0000000..8d5287a --- /dev/null +++ b/docs/models/enveloperedistributerequest.md @@ -0,0 +1,9 @@ +# EnvelopeRedistributeRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `recipients` | List[*float*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperedistributeresponse.md b/docs/models/enveloperedistributeresponse.md new file mode 100644 index 0000000..33fa0c2 --- /dev/null +++ b/docs/models/enveloperedistributeresponse.md @@ -0,0 +1,10 @@ +# EnvelopeRedistributeResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperedistributeunauthorizederror.md b/docs/models/enveloperedistributeunauthorizederror.md new file mode 100644 index 0000000..864bb39 --- /dev/null +++ b/docs/models/enveloperedistributeunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeRedistributeUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeRedistributeUnauthorizedIssue](../models/enveloperedistributeunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/enveloperedistributeunauthorizedissue.md b/docs/models/enveloperedistributeunauthorizedissue.md new file mode 100644 index 0000000..547b37c --- /dev/null +++ b/docs/models/enveloperedistributeunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeRedistributeUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdateauthoptions.md b/docs/models/envelopeupdateauthoptions.md new file mode 100644 index 0000000..4aecd16 --- /dev/null +++ b/docs/models/envelopeupdateauthoptions.md @@ -0,0 +1,9 @@ +# EnvelopeUpdateAuthOptions + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `global_access_auth` | List[[models.EnvelopeUpdateGlobalAccessAuthResponse](../models/envelopeupdateglobalaccessauthresponse.md)] | :heavy_check_mark: | N/A | +| `global_action_auth` | List[[models.EnvelopeUpdateGlobalActionAuthResponse](../models/envelopeupdateglobalactionauthresponse.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdatebadrequesterror.md b/docs/models/envelopeupdatebadrequesterror.md new file mode 100644 index 0000000..4eaba6e --- /dev/null +++ b/docs/models/envelopeupdatebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeUpdateBadRequestError + +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.EnvelopeUpdateBadRequestIssue](../models/envelopeupdatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdatebadrequestissue.md b/docs/models/envelopeupdatebadrequestissue.md new file mode 100644 index 0000000..125d459 --- /dev/null +++ b/docs/models/envelopeupdatebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeUpdateBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdatedata.md b/docs/models/envelopeupdatedata.md new file mode 100644 index 0000000..6a13851 --- /dev/null +++ b/docs/models/envelopeupdatedata.md @@ -0,0 +1,13 @@ +# EnvelopeUpdateData + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.EnvelopeUpdateDataVisibility]](../models/envelopeupdatedatavisibility.md) | :heavy_minus_sign: | N/A | +| `global_access_auth` | List[[models.EnvelopeUpdateDataGlobalAccessAuth](../models/envelopeupdatedataglobalaccessauth.md)] | :heavy_minus_sign: | N/A | +| `global_action_auth` | List[[models.EnvelopeUpdateDataGlobalActionAuth](../models/envelopeupdatedataglobalactionauth.md)] | :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/envelopeupdatedataglobalaccessauth.md b/docs/models/envelopeupdatedataglobalaccessauth.md new file mode 100644 index 0000000..79d13b0 --- /dev/null +++ b/docs/models/envelopeupdatedataglobalaccessauth.md @@ -0,0 +1,9 @@ +# EnvelopeUpdateDataGlobalAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/envelopeupdatedataglobalactionauth.md b/docs/models/envelopeupdatedataglobalactionauth.md new file mode 100644 index 0000000..20a50db --- /dev/null +++ b/docs/models/envelopeupdatedataglobalactionauth.md @@ -0,0 +1,11 @@ +# EnvelopeUpdateDataGlobalActionAuth + + +## 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/envelopeupdatedatavisibility.md b/docs/models/envelopeupdatedatavisibility.md new file mode 100644 index 0000000..343db88 --- /dev/null +++ b/docs/models/envelopeupdatedatavisibility.md @@ -0,0 +1,10 @@ +# EnvelopeUpdateDataVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/envelopeupdatedateformat.md b/docs/models/envelopeupdatedateformat.md new file mode 100644 index 0000000..a39ccdc --- /dev/null +++ b/docs/models/envelopeupdatedateformat.md @@ -0,0 +1,29 @@ +# EnvelopeUpdateDateFormat + + +## 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/envelopeupdatedistributionmethod.md b/docs/models/envelopeupdatedistributionmethod.md new file mode 100644 index 0000000..d5e316c --- /dev/null +++ b/docs/models/envelopeupdatedistributionmethod.md @@ -0,0 +1,9 @@ +# EnvelopeUpdateDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/envelopeupdateemailsettings.md b/docs/models/envelopeupdateemailsettings.md new file mode 100644 index 0000000..25baa62 --- /dev/null +++ b/docs/models/envelopeupdateemailsettings.md @@ -0,0 +1,14 @@ +# EnvelopeUpdateEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdateforbiddenerror.md b/docs/models/envelopeupdateforbiddenerror.md new file mode 100644 index 0000000..b7115b9 --- /dev/null +++ b/docs/models/envelopeupdateforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeUpdateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeUpdateForbiddenIssue](../models/envelopeupdateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdateforbiddenissue.md b/docs/models/envelopeupdateforbiddenissue.md new file mode 100644 index 0000000..a723f01 --- /dev/null +++ b/docs/models/envelopeupdateforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeUpdateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdateformvalues.md b/docs/models/envelopeupdateformvalues.md new file mode 100644 index 0000000..2594728 --- /dev/null +++ b/docs/models/envelopeupdateformvalues.md @@ -0,0 +1,23 @@ +# EnvelopeUpdateFormValues + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `bool` + +```python +value: bool = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopeupdateglobalaccessauthresponse.md b/docs/models/envelopeupdateglobalaccessauthresponse.md new file mode 100644 index 0000000..be68c4e --- /dev/null +++ b/docs/models/envelopeupdateglobalaccessauthresponse.md @@ -0,0 +1,9 @@ +# EnvelopeUpdateGlobalAccessAuthResponse + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/envelopeupdateglobalactionauthresponse.md b/docs/models/envelopeupdateglobalactionauthresponse.md new file mode 100644 index 0000000..f4c1273 --- /dev/null +++ b/docs/models/envelopeupdateglobalactionauthresponse.md @@ -0,0 +1,11 @@ +# EnvelopeUpdateGlobalActionAuthResponse + + +## 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/envelopeupdateinternalservererror.md b/docs/models/envelopeupdateinternalservererror.md new file mode 100644 index 0000000..3ad5e13 --- /dev/null +++ b/docs/models/envelopeupdateinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeUpdateInternalServerError + +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.EnvelopeUpdateInternalServerErrorIssue](../models/envelopeupdateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdateinternalservererrorissue.md b/docs/models/envelopeupdateinternalservererrorissue.md new file mode 100644 index 0000000..cd5895e --- /dev/null +++ b/docs/models/envelopeupdateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeUpdateInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdatelanguage.md b/docs/models/envelopeupdatelanguage.md new file mode 100644 index 0000000..89580e6 --- /dev/null +++ b/docs/models/envelopeupdatelanguage.md @@ -0,0 +1,13 @@ +# EnvelopeUpdateLanguage + + +## 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/envelopeupdatemeta.md b/docs/models/envelopeupdatemeta.md new file mode 100644 index 0000000..9975a28 --- /dev/null +++ b/docs/models/envelopeupdatemeta.md @@ -0,0 +1,22 @@ +# EnvelopeUpdateMeta + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.EnvelopeUpdateDateFormat]](../models/envelopeupdatedateformat.md) | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.EnvelopeUpdateDistributionMethod]](../models/envelopeupdatedistributionmethod.md) | :heavy_minus_sign: | N/A | +| `signing_order` | [Optional[models.EnvelopeUpdateSigningOrder]](../models/envelopeupdatesigningorder.md) | :heavy_minus_sign: | N/A | +| `allow_dictate_next_signer` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `language` | [Optional[models.EnvelopeUpdateLanguage]](../models/envelopeupdatelanguage.md) | :heavy_minus_sign: | N/A | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [OptionalNullable[models.EnvelopeUpdateEmailSettings]](../models/envelopeupdateemailsettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdaterequest.md b/docs/models/envelopeupdaterequest.md new file mode 100644 index 0000000..bf60067 --- /dev/null +++ b/docs/models/envelopeupdaterequest.md @@ -0,0 +1,10 @@ +# EnvelopeUpdateRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | [Optional[models.EnvelopeUpdateData]](../models/envelopeupdatedata.md) | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.EnvelopeUpdateMeta]](../models/envelopeupdatemeta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdateresponse.md b/docs/models/envelopeupdateresponse.md new file mode 100644 index 0000000..b8ed305 --- /dev/null +++ b/docs/models/envelopeupdateresponse.md @@ -0,0 +1,30 @@ +# EnvelopeUpdateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `internal_version` | *float* | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeUpdateType](../models/envelopeupdatetype.md) | :heavy_check_mark: | N/A | +| `status` | [models.EnvelopeUpdateStatus](../models/envelopeupdatestatus.md) | :heavy_check_mark: | N/A | +| `source` | [models.EnvelopeUpdateSource](../models/envelopeupdatesource.md) | :heavy_check_mark: | N/A | +| `visibility` | [models.EnvelopeUpdateVisibilityResponse](../models/envelopeupdatevisibilityresponse.md) | :heavy_check_mark: | N/A | +| `template_type` | [models.EnvelopeUpdateTemplateType](../models/envelopeupdatetemplatetype.md) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `secondary_id` | *str* | :heavy_check_mark: | N/A | +| `external_id` | *Nullable[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 | +| `title` | *str* | :heavy_check_mark: | N/A | +| `auth_options` | [Nullable[models.EnvelopeUpdateAuthOptions]](../models/envelopeupdateauthoptions.md) | :heavy_check_mark: | N/A | +| `form_values` | Dict[str, [models.EnvelopeUpdateFormValues](../models/envelopeupdateformvalues.md)] | :heavy_check_mark: | N/A | +| `public_title` | *str* | :heavy_check_mark: | N/A | +| `public_description` | *str* | :heavy_check_mark: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdatesigningorder.md b/docs/models/envelopeupdatesigningorder.md new file mode 100644 index 0000000..b7405d1 --- /dev/null +++ b/docs/models/envelopeupdatesigningorder.md @@ -0,0 +1,9 @@ +# EnvelopeUpdateSigningOrder + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `PARALLEL` | PARALLEL | +| `SEQUENTIAL` | SEQUENTIAL | \ No newline at end of file diff --git a/docs/models/envelopeupdatesource.md b/docs/models/envelopeupdatesource.md new file mode 100644 index 0000000..c4e3823 --- /dev/null +++ b/docs/models/envelopeupdatesource.md @@ -0,0 +1,10 @@ +# EnvelopeUpdateSource + + +## Values + +| Name | Value | +| ---------------------- | ---------------------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | +| `TEMPLATE_DIRECT_LINK` | TEMPLATE_DIRECT_LINK | \ No newline at end of file diff --git a/docs/models/envelopeupdatestatus.md b/docs/models/envelopeupdatestatus.md new file mode 100644 index 0000000..a5f638b --- /dev/null +++ b/docs/models/envelopeupdatestatus.md @@ -0,0 +1,11 @@ +# EnvelopeUpdateStatus + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `DRAFT` | DRAFT | +| `PENDING` | PENDING | +| `COMPLETED` | COMPLETED | +| `REJECTED` | REJECTED | \ No newline at end of file diff --git a/docs/models/envelopeupdatetemplatetype.md b/docs/models/envelopeupdatetemplatetype.md new file mode 100644 index 0000000..84bd0d0 --- /dev/null +++ b/docs/models/envelopeupdatetemplatetype.md @@ -0,0 +1,9 @@ +# EnvelopeUpdateTemplateType + + +## Values + +| Name | Value | +| --------- | --------- | +| `PUBLIC` | PUBLIC | +| `PRIVATE` | PRIVATE | \ No newline at end of file diff --git a/docs/models/envelopeupdatetype.md b/docs/models/envelopeupdatetype.md new file mode 100644 index 0000000..5bf5d37 --- /dev/null +++ b/docs/models/envelopeupdatetype.md @@ -0,0 +1,9 @@ +# EnvelopeUpdateType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | \ No newline at end of file diff --git a/docs/models/envelopeupdateunauthorizederror.md b/docs/models/envelopeupdateunauthorizederror.md new file mode 100644 index 0000000..e8c96e9 --- /dev/null +++ b/docs/models/envelopeupdateunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeUpdateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeUpdateUnauthorizedIssue](../models/envelopeupdateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdateunauthorizedissue.md b/docs/models/envelopeupdateunauthorizedissue.md new file mode 100644 index 0000000..0d087f4 --- /dev/null +++ b/docs/models/envelopeupdateunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeUpdateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeupdatevisibilityresponse.md b/docs/models/envelopeupdatevisibilityresponse.md new file mode 100644 index 0000000..a57c523 --- /dev/null +++ b/docs/models/envelopeupdatevisibilityresponse.md @@ -0,0 +1,10 @@ +# EnvelopeUpdateVisibilityResponse + + +## 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/envelopeuseattachment.md similarity index 72% rename from docs/models/templatedocumentdata.md rename to docs/models/envelopeuseattachment.md index 75685ef..a4239b1 100644 --- a/docs/models/templatedocumentdata.md +++ b/docs/models/envelopeuseattachment.md @@ -1,11 +1,10 @@ -# TemplateDocumentData +# EnvelopeUseAttachment ## Fields | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [models.TemplateDocumentDataType](../models/templatedocumentdatatype.md) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | +| `label` | *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 +| `type` | [Optional[models.EnvelopeUseTypeLink]](../models/envelopeusetypelink.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeusebadrequesterror.md b/docs/models/envelopeusebadrequesterror.md new file mode 100644 index 0000000..688172d --- /dev/null +++ b/docs/models/envelopeusebadrequesterror.md @@ -0,0 +1,12 @@ +# EnvelopeUseBadRequestError + +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.EnvelopeUseBadRequestIssue](../models/envelopeusebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeusebadrequestissue.md b/docs/models/envelopeusebadrequestissue.md new file mode 100644 index 0000000..eb30171 --- /dev/null +++ b/docs/models/envelopeusebadrequestissue.md @@ -0,0 +1,8 @@ +# EnvelopeUseBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeusecustomdocumentdatum.md b/docs/models/envelopeusecustomdocumentdatum.md new file mode 100644 index 0000000..757418b --- /dev/null +++ b/docs/models/envelopeusecustomdocumentdatum.md @@ -0,0 +1,9 @@ +# EnvelopeUseCustomDocumentDatum + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `identifier` | [models.EnvelopeUseIdentifier](../models/envelopeuseidentifier.md) | :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/envelopeusedateformat.md b/docs/models/envelopeusedateformat.md new file mode 100644 index 0000000..c98c79d --- /dev/null +++ b/docs/models/envelopeusedateformat.md @@ -0,0 +1,29 @@ +# EnvelopeUseDateFormat + + +## 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/envelopeusedistributionmethod.md b/docs/models/envelopeusedistributionmethod.md new file mode 100644 index 0000000..fe13b92 --- /dev/null +++ b/docs/models/envelopeusedistributionmethod.md @@ -0,0 +1,9 @@ +# EnvelopeUseDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/envelopeuseemailsettings.md b/docs/models/envelopeuseemailsettings.md new file mode 100644 index 0000000..a6b4e0d --- /dev/null +++ b/docs/models/envelopeuseemailsettings.md @@ -0,0 +1,14 @@ +# EnvelopeUseEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeusefile.md b/docs/models/envelopeusefile.md new file mode 100644 index 0000000..eed3ff9 --- /dev/null +++ b/docs/models/envelopeusefile.md @@ -0,0 +1,10 @@ +# EnvelopeUseFile + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `file_name` | *str* | :heavy_check_mark: | N/A | +| `content` | *Union[bytes, IO[bytes], io.BufferedReader]* | :heavy_check_mark: | N/A | +| `content_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseforbiddenerror.md b/docs/models/envelopeuseforbiddenerror.md new file mode 100644 index 0000000..4f5f6f7 --- /dev/null +++ b/docs/models/envelopeuseforbiddenerror.md @@ -0,0 +1,12 @@ +# EnvelopeUseForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeUseForbiddenIssue](../models/envelopeuseforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseforbiddenissue.md b/docs/models/envelopeuseforbiddenissue.md new file mode 100644 index 0000000..f247d8e --- /dev/null +++ b/docs/models/envelopeuseforbiddenissue.md @@ -0,0 +1,8 @@ +# EnvelopeUseForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseidentifier.md b/docs/models/envelopeuseidentifier.md new file mode 100644 index 0000000..c04d8dd --- /dev/null +++ b/docs/models/envelopeuseidentifier.md @@ -0,0 +1,17 @@ +# EnvelopeUseIdentifier + + +## Supported Types + +### `str` + +```python +value: str = /* values here */ +``` + +### `float` + +```python +value: float = /* values here */ +``` + diff --git a/docs/models/envelopeuseinternalservererror.md b/docs/models/envelopeuseinternalservererror.md new file mode 100644 index 0000000..73266a4 --- /dev/null +++ b/docs/models/envelopeuseinternalservererror.md @@ -0,0 +1,12 @@ +# EnvelopeUseInternalServerError + +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.EnvelopeUseInternalServerErrorIssue](../models/envelopeuseinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseinternalservererrorissue.md b/docs/models/envelopeuseinternalservererrorissue.md new file mode 100644 index 0000000..81a7586 --- /dev/null +++ b/docs/models/envelopeuseinternalservererrorissue.md @@ -0,0 +1,8 @@ +# EnvelopeUseInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuselanguage.md b/docs/models/envelopeuselanguage.md new file mode 100644 index 0000000..3d76381 --- /dev/null +++ b/docs/models/envelopeuselanguage.md @@ -0,0 +1,13 @@ +# EnvelopeUseLanguage + + +## 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/envelopeusepayload.md b/docs/models/envelopeusepayload.md new file mode 100644 index 0000000..b612a1b --- /dev/null +++ b/docs/models/envelopeusepayload.md @@ -0,0 +1,16 @@ +# EnvelopeUsePayload + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `external_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `recipients` | List[[models.EnvelopeUseRecipient](../models/envelopeuserecipient.md)] | :heavy_check_mark: | N/A | +| `distribute_document` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `custom_document_data` | List[[models.EnvelopeUseCustomDocumentDatum](../models/envelopeusecustomdocumentdatum.md)] | :heavy_minus_sign: | N/A | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `prefill_fields` | List[[models.EnvelopeUsePrefillFieldUnion](../models/envelopeuseprefillfieldunion.md)] | :heavy_minus_sign: | N/A | +| `override` | [Optional[models.Override]](../models/override.md) | :heavy_minus_sign: | N/A | +| `attachments` | List[[models.EnvelopeUseAttachment](../models/envelopeuseattachment.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseprefillfieldcheckbox.md b/docs/models/envelopeuseprefillfieldcheckbox.md new file mode 100644 index 0000000..41f17a8 --- /dev/null +++ b/docs/models/envelopeuseprefillfieldcheckbox.md @@ -0,0 +1,11 @@ +# EnvelopeUsePrefillFieldCheckbox + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `type` | [models.EnvelopeUseTypeCheckbox](../models/envelopeusetypecheckbox.md) | :heavy_check_mark: | N/A | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | List[*str*] | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseprefillfielddate.md b/docs/models/envelopeuseprefillfielddate.md new file mode 100644 index 0000000..b8e2ea0 --- /dev/null +++ b/docs/models/envelopeuseprefillfielddate.md @@ -0,0 +1,10 @@ +# EnvelopeUsePrefillFieldDate + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `type` | [models.EnvelopeUseTypeDate](../models/envelopeusetypedate.md) | :heavy_check_mark: | N/A | +| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseprefillfielddropdown.md b/docs/models/envelopeuseprefillfielddropdown.md new file mode 100644 index 0000000..6e21be7 --- /dev/null +++ b/docs/models/envelopeuseprefillfielddropdown.md @@ -0,0 +1,11 @@ +# EnvelopeUsePrefillFieldDropdown + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `type` | [models.EnvelopeUseTypeDropdown](../models/envelopeusetypedropdown.md) | :heavy_check_mark: | N/A | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/prefillfieldradio.md b/docs/models/envelopeuseprefillfieldnumber.md similarity index 77% rename from docs/models/prefillfieldradio.md rename to docs/models/envelopeuseprefillfieldnumber.md index 7e11b80..c1a572c 100644 --- a/docs/models/prefillfieldradio.md +++ b/docs/models/envelopeuseprefillfieldnumber.md @@ -1,11 +1,12 @@ -# PrefillFieldRadio +# EnvelopeUsePrefillFieldNumber ## Fields | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `type` | [models.PrefillFieldTypeRadio](../models/prefillfieldtyperadio.md) | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeUseTypeNumber](../models/envelopeusetypenumber.md) | :heavy_check_mark: | N/A | | `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/prefillfieldtext.md b/docs/models/envelopeuseprefillfieldradio.md similarity index 78% rename from docs/models/prefillfieldtext.md rename to docs/models/envelopeuseprefillfieldradio.md index 1807c8d..878f8b0 100644 --- a/docs/models/prefillfieldtext.md +++ b/docs/models/envelopeuseprefillfieldradio.md @@ -1,12 +1,11 @@ -# PrefillFieldText +# EnvelopeUsePrefillFieldRadio ## Fields | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `type` | [models.PrefillFieldTypeText](../models/prefillfieldtypetext.md) | :heavy_check_mark: | N/A | +| `type` | [models.EnvelopeUseTypeRadio](../models/envelopeusetyperadio.md) | :heavy_check_mark: | N/A | | `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | `value` | *Optional[str]* | :heavy_minus_sign: | N/A | | `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseprefillfieldtext.md b/docs/models/envelopeuseprefillfieldtext.md new file mode 100644 index 0000000..d094fe7 --- /dev/null +++ b/docs/models/envelopeuseprefillfieldtext.md @@ -0,0 +1,12 @@ +# EnvelopeUsePrefillFieldText + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `type` | [models.EnvelopeUseTypeText](../models/envelopeusetypetext.md) | :heavy_check_mark: | N/A | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseprefillfieldunion.md b/docs/models/envelopeuseprefillfieldunion.md new file mode 100644 index 0000000..b13ff22 --- /dev/null +++ b/docs/models/envelopeuseprefillfieldunion.md @@ -0,0 +1,41 @@ +# EnvelopeUsePrefillFieldUnion + + +## Supported Types + +### `models.EnvelopeUsePrefillFieldText` + +```python +value: models.EnvelopeUsePrefillFieldText = /* values here */ +``` + +### `models.EnvelopeUsePrefillFieldNumber` + +```python +value: models.EnvelopeUsePrefillFieldNumber = /* values here */ +``` + +### `models.EnvelopeUsePrefillFieldRadio` + +```python +value: models.EnvelopeUsePrefillFieldRadio = /* values here */ +``` + +### `models.EnvelopeUsePrefillFieldCheckbox` + +```python +value: models.EnvelopeUsePrefillFieldCheckbox = /* values here */ +``` + +### `models.EnvelopeUsePrefillFieldDropdown` + +```python +value: models.EnvelopeUsePrefillFieldDropdown = /* values here */ +``` + +### `models.EnvelopeUsePrefillFieldDate` + +```python +value: models.EnvelopeUsePrefillFieldDate = /* values here */ +``` + diff --git a/docs/models/envelopeuserecipient.md b/docs/models/envelopeuserecipient.md new file mode 100644 index 0000000..f59ab86 --- /dev/null +++ b/docs/models/envelopeuserecipient.md @@ -0,0 +1,11 @@ +# EnvelopeUseRecipient + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *float* | :heavy_check_mark: | N/A | +| `email` | *str* | :heavy_check_mark: | N/A | +| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `signing_order` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuserequest.md b/docs/models/envelopeuserequest.md new file mode 100644 index 0000000..ceabb79 --- /dev/null +++ b/docs/models/envelopeuserequest.md @@ -0,0 +1,9 @@ +# EnvelopeUseRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `payload` | [models.EnvelopeUsePayload](../models/envelopeusepayload.md) | :heavy_check_mark: | N/A | +| `files` | List[[models.EnvelopeUseFile](../models/envelopeusefile.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseresponse.md b/docs/models/envelopeuseresponse.md new file mode 100644 index 0000000..09c385d --- /dev/null +++ b/docs/models/envelopeuseresponse.md @@ -0,0 +1,10 @@ +# EnvelopeUseResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeusetypecheckbox.md b/docs/models/envelopeusetypecheckbox.md new file mode 100644 index 0000000..12b9c39 --- /dev/null +++ b/docs/models/envelopeusetypecheckbox.md @@ -0,0 +1,8 @@ +# EnvelopeUseTypeCheckbox + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/envelopeusetypedate.md b/docs/models/envelopeusetypedate.md new file mode 100644 index 0000000..bdfab76 --- /dev/null +++ b/docs/models/envelopeusetypedate.md @@ -0,0 +1,8 @@ +# EnvelopeUseTypeDate + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/envelopeusetypedropdown.md b/docs/models/envelopeusetypedropdown.md new file mode 100644 index 0000000..3a5e9f0 --- /dev/null +++ b/docs/models/envelopeusetypedropdown.md @@ -0,0 +1,8 @@ +# EnvelopeUseTypeDropdown + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/envelopeusetypelink.md b/docs/models/envelopeusetypelink.md new file mode 100644 index 0000000..8a0be74 --- /dev/null +++ b/docs/models/envelopeusetypelink.md @@ -0,0 +1,8 @@ +# EnvelopeUseTypeLink + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/docs/models/envelopeusetypenumber.md b/docs/models/envelopeusetypenumber.md new file mode 100644 index 0000000..0e63a5f --- /dev/null +++ b/docs/models/envelopeusetypenumber.md @@ -0,0 +1,8 @@ +# EnvelopeUseTypeNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/envelopeusetyperadio.md b/docs/models/envelopeusetyperadio.md new file mode 100644 index 0000000..28f385d --- /dev/null +++ b/docs/models/envelopeusetyperadio.md @@ -0,0 +1,8 @@ +# EnvelopeUseTypeRadio + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/envelopeusetypetext.md b/docs/models/envelopeusetypetext.md new file mode 100644 index 0000000..8120a85 --- /dev/null +++ b/docs/models/envelopeusetypetext.md @@ -0,0 +1,8 @@ +# EnvelopeUseTypeText + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/envelopeuseunauthorizederror.md b/docs/models/envelopeuseunauthorizederror.md new file mode 100644 index 0000000..2a209f5 --- /dev/null +++ b/docs/models/envelopeuseunauthorizederror.md @@ -0,0 +1,12 @@ +# EnvelopeUseUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.EnvelopeUseUnauthorizedIssue](../models/envelopeuseunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/envelopeuseunauthorizedissue.md b/docs/models/envelopeuseunauthorizedissue.md new file mode 100644 index 0000000..658f294 --- /dev/null +++ b/docs/models/envelopeuseunauthorizedissue.md @@ -0,0 +1,8 @@ +# EnvelopeUseUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfielddirectioncheckbox.md b/docs/models/fieldcreatedocumentfielddirectioncheckbox.md new file mode 100644 index 0000000..12716e9 --- /dev/null +++ b/docs/models/fieldcreatedocumentfielddirectioncheckbox.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfielddirectionradio.md b/docs/models/fieldcreatedocumentfielddirectionradio.md new file mode 100644 index 0000000..5a3c538 --- /dev/null +++ b/docs/models/fieldcreatedocumentfielddirectionradio.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfielddirectionresponse1.md b/docs/models/fieldcreatedocumentfielddirectionresponse1.md new file mode 100644 index 0000000..857b5a7 --- /dev/null +++ b/docs/models/fieldcreatedocumentfielddirectionresponse1.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldDirectionResponse1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfielddirectionresponse2.md b/docs/models/fieldcreatedocumentfielddirectionresponse2.md new file mode 100644 index 0000000..a67de02 --- /dev/null +++ b/docs/models/fieldcreatedocumentfielddirectionresponse2.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldDirectionResponse2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldcheckbox.md b/docs/models/fieldcreatedocumentfieldfieldcheckbox.md index 873af9e..2f02d92 100644 --- a/docs/models/fieldcreatedocumentfieldfieldcheckbox.md +++ b/docs/models/fieldcreatedocumentfieldfieldcheckbox.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldTypeCheckboxRequest1](../models/fieldcreatedocumentfieldtypecheckboxrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldFieldMetaCheckboxRequest]](../models/fieldcreatedocumentfieldfieldmetacheckboxrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfielddate.md b/docs/models/fieldcreatedocumentfieldfielddate.md index 44ac5b4..838a7cc 100644 --- a/docs/models/fieldcreatedocumentfieldfielddate.md +++ b/docs/models/fieldcreatedocumentfieldfielddate.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldTypeDateRequest1](../models/fieldcreatedocumentfieldtypedaterequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldFieldMetaDateRequest]](../models/fieldcreatedocumentfieldfieldmetadaterequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfielddropdown.md b/docs/models/fieldcreatedocumentfieldfielddropdown.md index 8aa052b..2fa08bb 100644 --- a/docs/models/fieldcreatedocumentfieldfielddropdown.md +++ b/docs/models/fieldcreatedocumentfieldfielddropdown.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldTypeDropdownRequest1](../models/fieldcreatedocumentfieldtypedropdownrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldFieldMetaDropdownRequest]](../models/fieldcreatedocumentfieldfieldmetadropdownrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldemail.md b/docs/models/fieldcreatedocumentfieldfieldemail.md index 9d495c9..32d8d26 100644 --- a/docs/models/fieldcreatedocumentfieldfieldemail.md +++ b/docs/models/fieldcreatedocumentfieldfieldemail.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldTypeEmailRequest1](../models/fieldcreatedocumentfieldtypeemailrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldFieldMetaEmailRequest]](../models/fieldcreatedocumentfieldfieldmetaemailrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldfreesignature.md b/docs/models/fieldcreatedocumentfieldfieldfreesignature.md index 1d6d223..7500033 100644 --- a/docs/models/fieldcreatedocumentfieldfieldfreesignature.md +++ b/docs/models/fieldcreatedocumentfieldfieldfreesignature.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldTypeFreeSignature](../models/fieldcreatedocumentfieldtypefreesignature.md) | :heavy_check_mark: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldinitials.md b/docs/models/fieldcreatedocumentfieldfieldinitials.md index fb41a8c..4ffde6d 100644 --- a/docs/models/fieldcreatedocumentfieldfieldinitials.md +++ b/docs/models/fieldcreatedocumentfieldfieldinitials.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldTypeInitialsRequest1](../models/fieldcreatedocumentfieldtypeinitialsrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldFieldMetaInitialsRequest]](../models/fieldcreatedocumentfieldfieldmetainitialsrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetacheckboxrequest.md b/docs/models/fieldcreatedocumentfieldfieldmetacheckboxrequest.md index cf32579..3dfdbf2 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetacheckboxrequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetacheckboxrequest.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldCreateDocumentFieldDirectionCheckbox]](../models/fieldcreatedocumentfielddirectioncheckbox.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..bd33b51 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetacheckboxresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetacheckboxresponse.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldCreateDocumentFieldDirectionResponse2]](../models/fieldcreatedocumentfielddirectionresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetadaterequest.md b/docs/models/fieldcreatedocumentfieldfieldmetadaterequest.md index 3d56a96..87bb761 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetadaterequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetadaterequest.md @@ -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.FieldCreateDocumentFieldTypeDateRequest2](../models/fieldcreatedocumentfieldtypedaterequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldTypeDateRequest2](../models/fieldcreatedocumentfieldtypedaterequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignDate]](../models/fieldcreatedocumentfieldtextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetadateresponse.md b/docs/models/fieldcreatedocumentfieldfieldmetadateresponse.md index cab01f6..ac62c92 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetadateresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetadateresponse.md @@ -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.FieldCreateDocumentFieldFieldMetaTypeDate](../models/fieldcreatedocumentfieldfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldFieldMetaTypeDate](../models/fieldcreatedocumentfieldfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignResponse4]](../models/fieldcreatedocumentfieldtextalignresponse4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetadropdownrequest.md b/docs/models/fieldcreatedocumentfieldfieldmetadropdownrequest.md index d710386..bc760ec 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetadropdownrequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetadropdownrequest.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateDocumentFieldTypeDropdownRequest2](../models/fieldcreatedocumentfieldtypedropdownrequest2.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldCreateDocumentFieldValueDropdown](../models/fieldcreatedocumentfieldvaluedropdown.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/fieldcreatedocumentfieldfieldmetadropdownresponse.md b/docs/models/fieldcreatedocumentfieldfieldmetadropdownresponse.md index d9f2cb8..5bd0f5c 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetadropdownresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetadropdownresponse.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateDocumentFieldFieldMetaTypeDropdown](../models/fieldcreatedocumentfieldfieldmetatypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldCreateDocumentFieldValueResponse3](../models/fieldcreatedocumentfieldvalueresponse3.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/fieldcreatedocumentfieldfieldmetaemailrequest.md b/docs/models/fieldcreatedocumentfieldfieldmetaemailrequest.md index bfa0ff9..ef9dead 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetaemailrequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetaemailrequest.md @@ -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.FieldCreateDocumentFieldTypeEmailRequest2](../models/fieldcreatedocumentfieldtypeemailrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldTypeEmailRequest2](../models/fieldcreatedocumentfieldtypeemailrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignEmail]](../models/fieldcreatedocumentfieldtextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetaemailresponse.md b/docs/models/fieldcreatedocumentfieldfieldmetaemailresponse.md index 731952b..5945d1a 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetaemailresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetaemailresponse.md @@ -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.FieldCreateDocumentFieldFieldMetaTypeEmail](../models/fieldcreatedocumentfieldfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldFieldMetaTypeEmail](../models/fieldcreatedocumentfieldfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignResponse3]](../models/fieldcreatedocumentfieldtextalignresponse3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetainitialsrequest.md b/docs/models/fieldcreatedocumentfieldfieldmetainitialsrequest.md index 68a1c39..39ad13a 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetainitialsrequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetainitialsrequest.md @@ -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.FieldCreateDocumentFieldTypeInitialsRequest2](../models/fieldcreatedocumentfieldtypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldTypeInitialsRequest2](../models/fieldcreatedocumentfieldtypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignInitials]](../models/fieldcreatedocumentfieldtextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetainitialsresponse.md b/docs/models/fieldcreatedocumentfieldfieldmetainitialsresponse.md index 135dfa2..5b8f4a5 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetainitialsresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetainitialsresponse.md @@ -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.FieldCreateDocumentFieldFieldMetaTypeInitials](../models/fieldcreatedocumentfieldfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldFieldMetaTypeInitials](../models/fieldcreatedocumentfieldfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignResponse1]](../models/fieldcreatedocumentfieldtextalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetanamerequest.md b/docs/models/fieldcreatedocumentfieldfieldmetanamerequest.md index 12ece1e..3f1f51b 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetanamerequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetanamerequest.md @@ -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.FieldCreateDocumentFieldTypeNameRequest2](../models/fieldcreatedocumentfieldtypenamerequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldTypeNameRequest2](../models/fieldcreatedocumentfieldtypenamerequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignName]](../models/fieldcreatedocumentfieldtextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetanameresponse.md b/docs/models/fieldcreatedocumentfieldfieldmetanameresponse.md index 1571843..f7283e6 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetanameresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetanameresponse.md @@ -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.FieldCreateDocumentFieldFieldMetaTypeName](../models/fieldcreatedocumentfieldfieldmetatypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldFieldMetaTypeName](../models/fieldcreatedocumentfieldfieldmetatypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignResponse2]](../models/fieldcreatedocumentfieldtextalignresponse2.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..5a8bbf7 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetanumberrequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetanumberrequest.md @@ -3,16 +3,19 @@ ## 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.FieldCreateDocumentFieldTypeNumberRequest2](../models/fieldcreatedocumentfieldtypenumberrequest2.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.FieldCreateDocumentFieldTextAlignNumber]](../models/fieldcreatedocumentfieldtextalignnumber.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldTypeNumberRequest2](../models/fieldcreatedocumentfieldtypenumberrequest2.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 | +| `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignNumber]](../models/fieldcreatedocumentfieldtextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateDocumentFieldVerticalAlignNumber]](../models/fieldcreatedocumentfieldverticalalignnumber.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..6d95d31 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetanumberresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetanumberresponse.md @@ -3,16 +3,19 @@ ## 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.FieldCreateDocumentFieldFieldMetaTypeNumber](../models/fieldcreatedocumentfieldfieldmetatypenumber.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.FieldCreateDocumentFieldTextAlignResponse6]](../models/fieldcreatedocumentfieldtextalignresponse6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldFieldMetaTypeNumber](../models/fieldcreatedocumentfieldfieldmetatypenumber.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 | +| `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignResponse6]](../models/fieldcreatedocumentfieldtextalignresponse6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateDocumentFieldVerticalAlignResponse2]](../models/fieldcreatedocumentfieldverticalalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetaradiorequest.md b/docs/models/fieldcreatedocumentfieldfieldmetaradiorequest.md index 7a99e59..4ad870c 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetaradiorequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetaradiorequest.md @@ -3,11 +3,13 @@ ## 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.FieldCreateDocumentFieldTypeRadioRequest2](../models/fieldcreatedocumentfieldtyperadiorequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateDocumentFieldValueRadio](../models/fieldcreatedocumentfieldvalueradio.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldTypeRadioRequest2](../models/fieldcreatedocumentfieldtyperadiorequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateDocumentFieldValueRadio](../models/fieldcreatedocumentfieldvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateDocumentFieldDirectionRadio]](../models/fieldcreatedocumentfielddirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetaradioresponse.md b/docs/models/fieldcreatedocumentfieldfieldmetaradioresponse.md index be6b48b..7f8c29f 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetaradioresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetaradioresponse.md @@ -3,11 +3,13 @@ ## 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.FieldCreateDocumentFieldFieldMetaTypeRadio](../models/fieldcreatedocumentfieldfieldmetatyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateDocumentFieldValueResponse1](../models/fieldcreatedocumentfieldvalueresponse1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldFieldMetaTypeRadio](../models/fieldcreatedocumentfieldfieldmetatyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateDocumentFieldValueResponse1](../models/fieldcreatedocumentfieldvalueresponse1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateDocumentFieldDirectionResponse1]](../models/fieldcreatedocumentfielddirectionresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetasignaturerequest.md b/docs/models/fieldcreatedocumentfieldfieldmetasignaturerequest.md new file mode 100644 index 0000000..1a283fa --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldfieldmetasignaturerequest.md @@ -0,0 +1,13 @@ +# FieldCreateDocumentFieldFieldMetaSignatureRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldTypeSignatureRequest2](../models/fieldcreatedocumentfieldtypesignaturerequest2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetasignatureresponse.md b/docs/models/fieldcreatedocumentfieldfieldmetasignatureresponse.md new file mode 100644 index 0000000..2d2653d --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldfieldmetasignatureresponse.md @@ -0,0 +1,13 @@ +# FieldCreateDocumentFieldFieldMetaSignatureResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldFieldMetaTypeSignature](../models/fieldcreatedocumentfieldfieldmetatypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetatextrequest.md b/docs/models/fieldcreatedocumentfieldfieldmetatextrequest.md index 6d0d297..16d03f4 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetatextrequest.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetatextrequest.md @@ -3,14 +3,17 @@ ## 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.FieldCreateDocumentFieldTypeTextRequest2](../models/fieldcreatedocumentfieldtypetextrequest2.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.FieldCreateDocumentFieldTextAlignText]](../models/fieldcreatedocumentfieldtextaligntext.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldTypeTextRequest2](../models/fieldcreatedocumentfieldtypetextrequest2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignText]](../models/fieldcreatedocumentfieldtextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateDocumentFieldVerticalAlignText]](../models/fieldcreatedocumentfieldverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetatextresponse.md b/docs/models/fieldcreatedocumentfieldfieldmetatextresponse.md index a9b2148..b0aeafd 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetatextresponse.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetatextresponse.md @@ -3,14 +3,17 @@ ## 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.FieldCreateDocumentFieldFieldMetaTypeText](../models/fieldcreatedocumentfieldfieldmetatypetext.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.FieldCreateDocumentFieldTextAlignResponse5]](../models/fieldcreatedocumentfieldtextalignresponse5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldFieldMetaTypeText](../models/fieldcreatedocumentfieldfieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldCreateDocumentFieldTextAlignResponse5]](../models/fieldcreatedocumentfieldtextalignresponse5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateDocumentFieldVerticalAlignResponse1]](../models/fieldcreatedocumentfieldverticalalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetatypesignature.md b/docs/models/fieldcreatedocumentfieldfieldmetatypesignature.md new file mode 100644 index 0000000..d87d356 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldfieldmetatypesignature.md @@ -0,0 +1,8 @@ +# FieldCreateDocumentFieldFieldMetaTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldmetaunion.md b/docs/models/fieldcreatedocumentfieldfieldmetaunion.md index f27206e..e6c12a4 100644 --- a/docs/models/fieldcreatedocumentfieldfieldmetaunion.md +++ b/docs/models/fieldcreatedocumentfieldfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldCreateDocumentFieldFieldMetaSignatureResponse` + +```python +value: models.FieldCreateDocumentFieldFieldMetaSignatureResponse = /* values here */ +``` + ### `models.FieldCreateDocumentFieldFieldMetaInitialsResponse` ```python diff --git a/docs/models/fieldcreatedocumentfieldfieldname.md b/docs/models/fieldcreatedocumentfieldfieldname.md index 2af6792..f2491e3 100644 --- a/docs/models/fieldcreatedocumentfieldfieldname.md +++ b/docs/models/fieldcreatedocumentfieldfieldname.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldTypeNameRequest1](../models/fieldcreatedocumentfieldtypenamerequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldFieldMetaNameRequest]](../models/fieldcreatedocumentfieldfieldmetanamerequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldnumber.md b/docs/models/fieldcreatedocumentfieldfieldnumber.md index fedc6be..c1056e3 100644 --- a/docs/models/fieldcreatedocumentfieldfieldnumber.md +++ b/docs/models/fieldcreatedocumentfieldfieldnumber.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateDocumentFieldTypeNumberRequest1](../models/fieldcreatedocumentfieldtypenumberrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldFieldMetaNumberRequest]](../models/fieldcreatedocumentfieldfieldmetanumberrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldradio.md b/docs/models/fieldcreatedocumentfieldfieldradio.md index 8311d65..0d7d41b 100644 --- a/docs/models/fieldcreatedocumentfieldfieldradio.md +++ b/docs/models/fieldcreatedocumentfieldfieldradio.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldTypeRadioRequest1](../models/fieldcreatedocumentfieldtyperadiorequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldFieldMetaRadioRequest]](../models/fieldcreatedocumentfieldfieldmetaradiorequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldsignature.md b/docs/models/fieldcreatedocumentfieldfieldsignature.md index 26b7110..8d4732b 100644 --- a/docs/models/fieldcreatedocumentfieldfieldsignature.md +++ b/docs/models/fieldcreatedocumentfieldfieldsignature.md @@ -3,12 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [models.FieldCreateDocumentFieldTypeSignature](../models/fieldcreatedocumentfieldtypesignature.md) | :heavy_check_mark: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.FieldCreateDocumentFieldTypeSignatureRequest1](../models/fieldcreatedocumentfieldtypesignaturerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.FieldCreateDocumentFieldFieldMetaSignatureRequest]](../models/fieldcreatedocumentfieldfieldmetasignaturerequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldfieldtext.md b/docs/models/fieldcreatedocumentfieldfieldtext.md index 55c6692..4e6313d 100644 --- a/docs/models/fieldcreatedocumentfieldfieldtext.md +++ b/docs/models/fieldcreatedocumentfieldfieldtext.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldTypeTextRequest1](../models/fieldcreatedocumentfieldtypetextrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldFieldMetaTextRequest]](../models/fieldcreatedocumentfieldfieldmetatextrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldforbiddenerror.md b/docs/models/fieldcreatedocumentfieldforbiddenerror.md new file mode 100644 index 0000000..e6b7d5b --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldCreateDocumentFieldForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldCreateDocumentFieldForbiddenIssue](../models/fieldcreatedocumentfieldforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldforbiddenissue.md b/docs/models/fieldcreatedocumentfieldforbiddenissue.md new file mode 100644 index 0000000..e2c5413 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldCreateDocumentFieldForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldresponse.md b/docs/models/fieldcreatedocumentfieldresponse.md index 04eeec3..9fde5da 100644 --- a/docs/models/fieldcreatedocumentfieldresponse.md +++ b/docs/models/fieldcreatedocumentfieldresponse.md @@ -7,17 +7,19 @@ 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/fieldcreatedocumentfieldsdirectioncheckbox.md b/docs/models/fieldcreatedocumentfieldsdirectioncheckbox.md new file mode 100644 index 0000000..65af4b8 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsdirectioncheckbox.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldsDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsdirectionradio.md b/docs/models/fieldcreatedocumentfieldsdirectionradio.md new file mode 100644 index 0000000..f06f43c --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsdirectionradio.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldsDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsdirectionresponse1.md b/docs/models/fieldcreatedocumentfieldsdirectionresponse1.md new file mode 100644 index 0000000..413b7ae --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsdirectionresponse1.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldsDirectionResponse1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsdirectionresponse2.md b/docs/models/fieldcreatedocumentfieldsdirectionresponse2.md new file mode 100644 index 0000000..40ff510 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsdirectionresponse2.md @@ -0,0 +1,9 @@ +# FieldCreateDocumentFieldsDirectionResponse2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldcheckbox.md b/docs/models/fieldcreatedocumentfieldsfieldcheckbox.md index d2414a4..ab76caa 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldcheckbox.md +++ b/docs/models/fieldcreatedocumentfieldsfieldcheckbox.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateDocumentFieldsTypeCheckboxRequest1](../models/fieldcreatedocumentfieldstypecheckboxrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldsFieldMetaCheckboxRequest]](../models/fieldcreatedocumentfieldsfieldmetacheckboxrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfielddate.md b/docs/models/fieldcreatedocumentfieldsfielddate.md index 6f2be59..df9825a 100644 --- a/docs/models/fieldcreatedocumentfieldsfielddate.md +++ b/docs/models/fieldcreatedocumentfieldsfielddate.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldsTypeDateRequest1](../models/fieldcreatedocumentfieldstypedaterequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldsFieldMetaDateRequest]](../models/fieldcreatedocumentfieldsfieldmetadaterequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfielddropdown.md b/docs/models/fieldcreatedocumentfieldsfielddropdown.md index 7630497..e7a0aac 100644 --- a/docs/models/fieldcreatedocumentfieldsfielddropdown.md +++ b/docs/models/fieldcreatedocumentfieldsfielddropdown.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateDocumentFieldsTypeDropdownRequest1](../models/fieldcreatedocumentfieldstypedropdownrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldsFieldMetaDropdownRequest]](../models/fieldcreatedocumentfieldsfieldmetadropdownrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldemail.md b/docs/models/fieldcreatedocumentfieldsfieldemail.md index 70161f6..4e492eb 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldemail.md +++ b/docs/models/fieldcreatedocumentfieldsfieldemail.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateDocumentFieldsTypeEmailRequest1](../models/fieldcreatedocumentfieldstypeemailrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldsFieldMetaEmailRequest]](../models/fieldcreatedocumentfieldsfieldmetaemailrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldfreesignature.md b/docs/models/fieldcreatedocumentfieldsfieldfreesignature.md index b96488f..47d2a55 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldfreesignature.md +++ b/docs/models/fieldcreatedocumentfieldsfieldfreesignature.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateDocumentFieldsTypeFreeSignature](../models/fieldcreatedocumentfieldstypefreesignature.md) | :heavy_check_mark: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldinitials.md b/docs/models/fieldcreatedocumentfieldsfieldinitials.md index 3e98030..be2e4b4 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldinitials.md +++ b/docs/models/fieldcreatedocumentfieldsfieldinitials.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateDocumentFieldsTypeInitialsRequest1](../models/fieldcreatedocumentfieldstypeinitialsrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldsFieldMetaInitialsRequest]](../models/fieldcreatedocumentfieldsfieldmetainitialsrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxrequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxrequest.md index cc3ed43..bd20475 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxrequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxrequest.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldCreateDocumentFieldsDirectionCheckbox]](../models/fieldcreatedocumentfieldsdirectioncheckbox.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..0c6390f 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetacheckboxresponse.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldCreateDocumentFieldsDirectionResponse2]](../models/fieldcreatedocumentfieldsdirectionresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetadaterequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetadaterequest.md index 7ade308..f28e45d 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetadaterequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetadaterequest.md @@ -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.FieldCreateDocumentFieldsTypeDateRequest2](../models/fieldcreatedocumentfieldstypedaterequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsTypeDateRequest2](../models/fieldcreatedocumentfieldstypedaterequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignDate]](../models/fieldcreatedocumentfieldstextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetadateresponse.md b/docs/models/fieldcreatedocumentfieldsfieldmetadateresponse.md index 16bdb18..bc73e6f 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetadateresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetadateresponse.md @@ -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.FieldCreateDocumentFieldsFieldMetaTypeDate](../models/fieldcreatedocumentfieldsfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeDate](../models/fieldcreatedocumentfieldsfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignResponse4]](../models/fieldcreatedocumentfieldstextalignresponse4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetadropdownrequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetadropdownrequest.md index c087a78..862fd70 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetadropdownrequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetadropdownrequest.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateDocumentFieldsTypeDropdownRequest2](../models/fieldcreatedocumentfieldstypedropdownrequest2.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldCreateDocumentFieldsValueDropdown](../models/fieldcreatedocumentfieldsvaluedropdown.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/fieldcreatedocumentfieldsfieldmetadropdownresponse.md b/docs/models/fieldcreatedocumentfieldsfieldmetadropdownresponse.md index 402d2bf..eab2385 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetadropdownresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetadropdownresponse.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeDropdown](../models/fieldcreatedocumentfieldsfieldmetatypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldCreateDocumentFieldsValueResponse3](../models/fieldcreatedocumentfieldsvalueresponse3.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/fieldcreatedocumentfieldsfieldmetaemailrequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetaemailrequest.md index 1891943..8f471bc 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetaemailrequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetaemailrequest.md @@ -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.FieldCreateDocumentFieldsTypeEmailRequest2](../models/fieldcreatedocumentfieldstypeemailrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsTypeEmailRequest2](../models/fieldcreatedocumentfieldstypeemailrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignEmail]](../models/fieldcreatedocumentfieldstextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetaemailresponse.md b/docs/models/fieldcreatedocumentfieldsfieldmetaemailresponse.md index 564b770..6b6d62c 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetaemailresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetaemailresponse.md @@ -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.FieldCreateDocumentFieldsFieldMetaTypeEmail](../models/fieldcreatedocumentfieldsfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeEmail](../models/fieldcreatedocumentfieldsfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignResponse3]](../models/fieldcreatedocumentfieldstextalignresponse3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetainitialsrequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetainitialsrequest.md index ecc7ebe..2a9aec3 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetainitialsrequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetainitialsrequest.md @@ -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.FieldCreateDocumentFieldsTypeInitialsRequest2](../models/fieldcreatedocumentfieldstypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsTypeInitialsRequest2](../models/fieldcreatedocumentfieldstypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignInitials]](../models/fieldcreatedocumentfieldstextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetainitialsresponse.md b/docs/models/fieldcreatedocumentfieldsfieldmetainitialsresponse.md index 5637d9e..603e780 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetainitialsresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetainitialsresponse.md @@ -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.FieldCreateDocumentFieldsFieldMetaTypeInitials](../models/fieldcreatedocumentfieldsfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeInitials](../models/fieldcreatedocumentfieldsfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignResponse1]](../models/fieldcreatedocumentfieldstextalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetanamerequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetanamerequest.md index 00baa62..141546b 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetanamerequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetanamerequest.md @@ -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.FieldCreateDocumentFieldsTypeNameRequest2](../models/fieldcreatedocumentfieldstypenamerequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsTypeNameRequest2](../models/fieldcreatedocumentfieldstypenamerequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignName]](../models/fieldcreatedocumentfieldstextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetanameresponse.md b/docs/models/fieldcreatedocumentfieldsfieldmetanameresponse.md index ffb23e4..804c65e 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetanameresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetanameresponse.md @@ -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.FieldCreateDocumentFieldsFieldMetaTypeName](../models/fieldcreatedocumentfieldsfieldmetatypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeName](../models/fieldcreatedocumentfieldsfieldmetatypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignResponse2]](../models/fieldcreatedocumentfieldstextalignresponse2.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..df71885 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetanumberrequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetanumberrequest.md @@ -3,16 +3,19 @@ ## 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.FieldCreateDocumentFieldsTypeNumberRequest2](../models/fieldcreatedocumentfieldstypenumberrequest2.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.FieldCreateDocumentFieldsTextAlignNumber]](../models/fieldcreatedocumentfieldstextalignnumber.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsTypeNumberRequest2](../models/fieldcreatedocumentfieldstypenumberrequest2.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 | +| `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignNumber]](../models/fieldcreatedocumentfieldstextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateDocumentFieldsVerticalAlignNumber]](../models/fieldcreatedocumentfieldsverticalalignnumber.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..f295b78 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetanumberresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetanumberresponse.md @@ -3,16 +3,19 @@ ## 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.FieldCreateDocumentFieldsFieldMetaTypeNumber](../models/fieldcreatedocumentfieldsfieldmetatypenumber.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.FieldCreateDocumentFieldsTextAlignResponse6]](../models/fieldcreatedocumentfieldstextalignresponse6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeNumber](../models/fieldcreatedocumentfieldsfieldmetatypenumber.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 | +| `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignResponse6]](../models/fieldcreatedocumentfieldstextalignresponse6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateDocumentFieldsVerticalAlignResponse2]](../models/fieldcreatedocumentfieldsverticalalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetaradiorequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetaradiorequest.md index 047c0ce..b2dd183 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetaradiorequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetaradiorequest.md @@ -3,11 +3,13 @@ ## 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.FieldCreateDocumentFieldsTypeRadioRequest2](../models/fieldcreatedocumentfieldstyperadiorequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateDocumentFieldsValueRadio](../models/fieldcreatedocumentfieldsvalueradio.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsTypeRadioRequest2](../models/fieldcreatedocumentfieldstyperadiorequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateDocumentFieldsValueRadio](../models/fieldcreatedocumentfieldsvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateDocumentFieldsDirectionRadio]](../models/fieldcreatedocumentfieldsdirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetaradioresponse.md b/docs/models/fieldcreatedocumentfieldsfieldmetaradioresponse.md index 1420f77..72c016e 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetaradioresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetaradioresponse.md @@ -3,11 +3,13 @@ ## 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.FieldCreateDocumentFieldsFieldMetaTypeRadio](../models/fieldcreatedocumentfieldsfieldmetatyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateDocumentFieldsValueResponse1](../models/fieldcreatedocumentfieldsvalueresponse1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeRadio](../models/fieldcreatedocumentfieldsfieldmetatyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateDocumentFieldsValueResponse1](../models/fieldcreatedocumentfieldsvalueresponse1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateDocumentFieldsDirectionResponse1]](../models/fieldcreatedocumentfieldsdirectionresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetasignaturerequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetasignaturerequest.md new file mode 100644 index 0000000..2f7f8d4 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsfieldmetasignaturerequest.md @@ -0,0 +1,13 @@ +# FieldCreateDocumentFieldsFieldMetaSignatureRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsTypeSignatureRequest2](../models/fieldcreatedocumentfieldstypesignaturerequest2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetasignatureresponse.md b/docs/models/fieldcreatedocumentfieldsfieldmetasignatureresponse.md new file mode 100644 index 0000000..63f0a85 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsfieldmetasignatureresponse.md @@ -0,0 +1,13 @@ +# FieldCreateDocumentFieldsFieldMetaSignatureResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeSignature](../models/fieldcreatedocumentfieldsfieldmetatypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetatextrequest.md b/docs/models/fieldcreatedocumentfieldsfieldmetatextrequest.md index 02d9cbe..2840531 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetatextrequest.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetatextrequest.md @@ -3,14 +3,17 @@ ## 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.FieldCreateDocumentFieldsTypeTextRequest2](../models/fieldcreatedocumentfieldstypetextrequest2.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.FieldCreateDocumentFieldsTextAlignText]](../models/fieldcreatedocumentfieldstextaligntext.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsTypeTextRequest2](../models/fieldcreatedocumentfieldstypetextrequest2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignText]](../models/fieldcreatedocumentfieldstextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateDocumentFieldsVerticalAlignText]](../models/fieldcreatedocumentfieldsverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetatextresponse.md b/docs/models/fieldcreatedocumentfieldsfieldmetatextresponse.md index a1460fe..003a06d 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetatextresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetatextresponse.md @@ -3,14 +3,17 @@ ## 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.FieldCreateDocumentFieldsFieldMetaTypeText](../models/fieldcreatedocumentfieldsfieldmetatypetext.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.FieldCreateDocumentFieldsTextAlignResponse5]](../models/fieldcreatedocumentfieldstextalignresponse5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateDocumentFieldsFieldMetaTypeText](../models/fieldcreatedocumentfieldsfieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldCreateDocumentFieldsTextAlignResponse5]](../models/fieldcreatedocumentfieldstextalignresponse5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateDocumentFieldsVerticalAlignResponse1]](../models/fieldcreatedocumentfieldsverticalalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetatypesignature.md b/docs/models/fieldcreatedocumentfieldsfieldmetatypesignature.md new file mode 100644 index 0000000..cf85089 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsfieldmetatypesignature.md @@ -0,0 +1,8 @@ +# FieldCreateDocumentFieldsFieldMetaTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldmetaunion.md b/docs/models/fieldcreatedocumentfieldsfieldmetaunion.md index 987c1ad..d7f0410 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldmetaunion.md +++ b/docs/models/fieldcreatedocumentfieldsfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldCreateDocumentFieldsFieldMetaSignatureResponse` + +```python +value: models.FieldCreateDocumentFieldsFieldMetaSignatureResponse = /* values here */ +``` + ### `models.FieldCreateDocumentFieldsFieldMetaInitialsResponse` ```python diff --git a/docs/models/fieldcreatedocumentfieldsfieldname.md b/docs/models/fieldcreatedocumentfieldsfieldname.md index 2e7314e..5ae964c 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldname.md +++ b/docs/models/fieldcreatedocumentfieldsfieldname.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldsTypeNameRequest1](../models/fieldcreatedocumentfieldstypenamerequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldsFieldMetaNameRequest]](../models/fieldcreatedocumentfieldsfieldmetanamerequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldnumber.md b/docs/models/fieldcreatedocumentfieldsfieldnumber.md index 5c2c81f..c497605 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldnumber.md +++ b/docs/models/fieldcreatedocumentfieldsfieldnumber.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldsTypeNumberRequest1](../models/fieldcreatedocumentfieldstypenumberrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldsFieldMetaNumberRequest]](../models/fieldcreatedocumentfieldsfieldmetanumberrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldradio.md b/docs/models/fieldcreatedocumentfieldsfieldradio.md index 3085448..13a6605 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldradio.md +++ b/docs/models/fieldcreatedocumentfieldsfieldradio.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateDocumentFieldsTypeRadioRequest1](../models/fieldcreatedocumentfieldstyperadiorequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldsFieldMetaRadioRequest]](../models/fieldcreatedocumentfieldsfieldmetaradiorequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldresponse.md b/docs/models/fieldcreatedocumentfieldsfieldresponse.md index d44fb2e..bdfafe2 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldresponse.md +++ b/docs/models/fieldcreatedocumentfieldsfieldresponse.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/fieldcreatedocumentfieldsfieldsignature.md b/docs/models/fieldcreatedocumentfieldsfieldsignature.md index 82c8cb9..a8b76ce 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldsignature.md +++ b/docs/models/fieldcreatedocumentfieldsfieldsignature.md @@ -3,12 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `type` | [models.FieldCreateDocumentFieldsTypeSignature](../models/fieldcreatedocumentfieldstypesignature.md) | :heavy_check_mark: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.FieldCreateDocumentFieldsTypeSignatureRequest1](../models/fieldcreatedocumentfieldstypesignaturerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.FieldCreateDocumentFieldsFieldMetaSignatureRequest]](../models/fieldcreatedocumentfieldsfieldmetasignaturerequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsfieldtext.md b/docs/models/fieldcreatedocumentfieldsfieldtext.md index 7518656..2ddc78c 100644 --- a/docs/models/fieldcreatedocumentfieldsfieldtext.md +++ b/docs/models/fieldcreatedocumentfieldsfieldtext.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateDocumentFieldsTypeTextRequest1](../models/fieldcreatedocumentfieldstypetextrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateDocumentFieldsFieldMetaTextRequest]](../models/fieldcreatedocumentfieldsfieldmetatextrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsforbiddenerror.md b/docs/models/fieldcreatedocumentfieldsforbiddenerror.md new file mode 100644 index 0000000..0e1efaf --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldCreateDocumentFieldsForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldCreateDocumentFieldsForbiddenIssue](../models/fieldcreatedocumentfieldsforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsforbiddenissue.md b/docs/models/fieldcreatedocumentfieldsforbiddenissue.md new file mode 100644 index 0000000..e20ebb8 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldCreateDocumentFieldsForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldstypesignaturerequest1.md b/docs/models/fieldcreatedocumentfieldstypesignaturerequest1.md new file mode 100644 index 0000000..66cf84a --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldstypesignaturerequest1.md @@ -0,0 +1,8 @@ +# FieldCreateDocumentFieldsTypeSignatureRequest1 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | SIGNATURE | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldstypesignaturerequest2.md b/docs/models/fieldcreatedocumentfieldstypesignaturerequest2.md new file mode 100644 index 0000000..e106cf1 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldstypesignaturerequest2.md @@ -0,0 +1,8 @@ +# FieldCreateDocumentFieldsTypeSignatureRequest2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsunauthorizederror.md b/docs/models/fieldcreatedocumentfieldsunauthorizederror.md new file mode 100644 index 0000000..5da657c --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldCreateDocumentFieldsUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldCreateDocumentFieldsUnauthorizedIssue](../models/fieldcreatedocumentfieldsunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsunauthorizedissue.md b/docs/models/fieldcreatedocumentfieldsunauthorizedissue.md new file mode 100644 index 0000000..56351ec --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldCreateDocumentFieldsUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsverticalalignnumber.md b/docs/models/fieldcreatedocumentfieldsverticalalignnumber.md new file mode 100644 index 0000000..5e1b56e --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsverticalalignnumber.md @@ -0,0 +1,10 @@ +# FieldCreateDocumentFieldsVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsverticalalignresponse1.md b/docs/models/fieldcreatedocumentfieldsverticalalignresponse1.md new file mode 100644 index 0000000..a587387 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsverticalalignresponse1.md @@ -0,0 +1,10 @@ +# FieldCreateDocumentFieldsVerticalAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsverticalalignresponse2.md b/docs/models/fieldcreatedocumentfieldsverticalalignresponse2.md new file mode 100644 index 0000000..4425c68 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsverticalalignresponse2.md @@ -0,0 +1,10 @@ +# FieldCreateDocumentFieldsVerticalAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldsverticalaligntext.md b/docs/models/fieldcreatedocumentfieldsverticalaligntext.md new file mode 100644 index 0000000..564b3e2 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldsverticalaligntext.md @@ -0,0 +1,10 @@ +# FieldCreateDocumentFieldsVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldtypesignature.md b/docs/models/fieldcreatedocumentfieldtypesignaturerequest1.md similarity index 68% rename from docs/models/fieldcreatedocumentfieldtypesignature.md rename to docs/models/fieldcreatedocumentfieldtypesignaturerequest1.md index 9b91957..09c4504 100644 --- a/docs/models/fieldcreatedocumentfieldtypesignature.md +++ b/docs/models/fieldcreatedocumentfieldtypesignaturerequest1.md @@ -1,4 +1,4 @@ -# FieldCreateDocumentFieldTypeSignature +# FieldCreateDocumentFieldTypeSignatureRequest1 ## Values diff --git a/docs/models/fieldcreatedocumentfieldtypesignaturerequest2.md b/docs/models/fieldcreatedocumentfieldtypesignaturerequest2.md new file mode 100644 index 0000000..363b2dc --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldtypesignaturerequest2.md @@ -0,0 +1,8 @@ +# FieldCreateDocumentFieldTypeSignatureRequest2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldunauthorizederror.md b/docs/models/fieldcreatedocumentfieldunauthorizederror.md new file mode 100644 index 0000000..784e3a2 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldCreateDocumentFieldUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldCreateDocumentFieldUnauthorizedIssue](../models/fieldcreatedocumentfieldunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldunauthorizedissue.md b/docs/models/fieldcreatedocumentfieldunauthorizedissue.md new file mode 100644 index 0000000..8773a2a --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldCreateDocumentFieldUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldverticalalignnumber.md b/docs/models/fieldcreatedocumentfieldverticalalignnumber.md new file mode 100644 index 0000000..0db5a18 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldverticalalignnumber.md @@ -0,0 +1,10 @@ +# FieldCreateDocumentFieldVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldverticalalignresponse1.md b/docs/models/fieldcreatedocumentfieldverticalalignresponse1.md new file mode 100644 index 0000000..31ec9f6 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldverticalalignresponse1.md @@ -0,0 +1,10 @@ +# FieldCreateDocumentFieldVerticalAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldverticalalignresponse2.md b/docs/models/fieldcreatedocumentfieldverticalalignresponse2.md new file mode 100644 index 0000000..30d2082 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldverticalalignresponse2.md @@ -0,0 +1,10 @@ +# FieldCreateDocumentFieldVerticalAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatedocumentfieldverticalaligntext.md b/docs/models/fieldcreatedocumentfieldverticalaligntext.md new file mode 100644 index 0000000..191f234 --- /dev/null +++ b/docs/models/fieldcreatedocumentfieldverticalaligntext.md @@ -0,0 +1,10 @@ +# FieldCreateDocumentFieldVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefielddirectioncheckbox.md b/docs/models/fieldcreatetemplatefielddirectioncheckbox.md new file mode 100644 index 0000000..2cde57f --- /dev/null +++ b/docs/models/fieldcreatetemplatefielddirectioncheckbox.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefielddirectionradio.md b/docs/models/fieldcreatetemplatefielddirectionradio.md new file mode 100644 index 0000000..d21687a --- /dev/null +++ b/docs/models/fieldcreatetemplatefielddirectionradio.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefielddirectionresponse1.md b/docs/models/fieldcreatetemplatefielddirectionresponse1.md new file mode 100644 index 0000000..42c5509 --- /dev/null +++ b/docs/models/fieldcreatetemplatefielddirectionresponse1.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldDirectionResponse1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefielddirectionresponse2.md b/docs/models/fieldcreatetemplatefielddirectionresponse2.md new file mode 100644 index 0000000..2d5ff50 --- /dev/null +++ b/docs/models/fieldcreatetemplatefielddirectionresponse2.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldDirectionResponse2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldcheckbox.md b/docs/models/fieldcreatetemplatefieldfieldcheckbox.md index 3892c5c..b1e85af 100644 --- a/docs/models/fieldcreatetemplatefieldfieldcheckbox.md +++ b/docs/models/fieldcreatetemplatefieldfieldcheckbox.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldTypeCheckboxRequest1](../models/fieldcreatetemplatefieldtypecheckboxrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldFieldMetaCheckboxRequest]](../models/fieldcreatetemplatefieldfieldmetacheckboxrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfielddate.md b/docs/models/fieldcreatetemplatefieldfielddate.md index 73cd2ab..4e1adc4 100644 --- a/docs/models/fieldcreatetemplatefieldfielddate.md +++ b/docs/models/fieldcreatetemplatefieldfielddate.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldTypeDateRequest1](../models/fieldcreatetemplatefieldtypedaterequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldFieldMetaDateRequest]](../models/fieldcreatetemplatefieldfieldmetadaterequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfielddropdown.md b/docs/models/fieldcreatetemplatefieldfielddropdown.md index 511e9c1..0e3cc21 100644 --- a/docs/models/fieldcreatetemplatefieldfielddropdown.md +++ b/docs/models/fieldcreatetemplatefieldfielddropdown.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldTypeDropdownRequest1](../models/fieldcreatetemplatefieldtypedropdownrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldFieldMetaDropdownRequest]](../models/fieldcreatetemplatefieldfieldmetadropdownrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldemail.md b/docs/models/fieldcreatetemplatefieldfieldemail.md index 1be8cdc..ac9db0e 100644 --- a/docs/models/fieldcreatetemplatefieldfieldemail.md +++ b/docs/models/fieldcreatetemplatefieldfieldemail.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldTypeEmailRequest1](../models/fieldcreatetemplatefieldtypeemailrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldFieldMetaEmailRequest]](../models/fieldcreatetemplatefieldfieldmetaemailrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldfreesignature.md b/docs/models/fieldcreatetemplatefieldfieldfreesignature.md index 10f7191..9cbdcb5 100644 --- a/docs/models/fieldcreatetemplatefieldfieldfreesignature.md +++ b/docs/models/fieldcreatetemplatefieldfieldfreesignature.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldTypeFreeSignature](../models/fieldcreatetemplatefieldtypefreesignature.md) | :heavy_check_mark: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldinitials.md b/docs/models/fieldcreatetemplatefieldfieldinitials.md index 5b06f40..a69997e 100644 --- a/docs/models/fieldcreatetemplatefieldfieldinitials.md +++ b/docs/models/fieldcreatetemplatefieldfieldinitials.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldTypeInitialsRequest1](../models/fieldcreatetemplatefieldtypeinitialsrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldFieldMetaInitialsRequest]](../models/fieldcreatetemplatefieldfieldmetainitialsrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetacheckboxrequest.md b/docs/models/fieldcreatetemplatefieldfieldmetacheckboxrequest.md index a255ab9..87006d4 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetacheckboxrequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetacheckboxrequest.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldCreateTemplateFieldDirectionCheckbox]](../models/fieldcreatetemplatefielddirectioncheckbox.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..0f6efd6 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetacheckboxresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetacheckboxresponse.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldCreateTemplateFieldDirectionResponse2]](../models/fieldcreatetemplatefielddirectionresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetadaterequest.md b/docs/models/fieldcreatetemplatefieldfieldmetadaterequest.md index 4da86e5..697bc6e 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetadaterequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetadaterequest.md @@ -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.FieldCreateTemplateFieldTypeDateRequest2](../models/fieldcreatetemplatefieldtypedaterequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldTypeDateRequest2](../models/fieldcreatetemplatefieldtypedaterequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignDate]](../models/fieldcreatetemplatefieldtextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetadateresponse.md b/docs/models/fieldcreatetemplatefieldfieldmetadateresponse.md index bfabef1..d5052b0 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetadateresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetadateresponse.md @@ -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.FieldCreateTemplateFieldFieldMetaTypeDate](../models/fieldcreatetemplatefieldfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldFieldMetaTypeDate](../models/fieldcreatetemplatefieldfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignResponse4]](../models/fieldcreatetemplatefieldtextalignresponse4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetadropdownrequest.md b/docs/models/fieldcreatetemplatefieldfieldmetadropdownrequest.md index 8754558..fba0cd9 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetadropdownrequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetadropdownrequest.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateTemplateFieldTypeDropdownRequest2](../models/fieldcreatetemplatefieldtypedropdownrequest2.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldCreateTemplateFieldValueDropdown](../models/fieldcreatetemplatefieldvaluedropdown.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/fieldcreatetemplatefieldfieldmetadropdownresponse.md b/docs/models/fieldcreatetemplatefieldfieldmetadropdownresponse.md index 0085e32..38536b7 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetadropdownresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetadropdownresponse.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateTemplateFieldFieldMetaTypeDropdown](../models/fieldcreatetemplatefieldfieldmetatypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldCreateTemplateFieldValueResponse3](../models/fieldcreatetemplatefieldvalueresponse3.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/fieldcreatetemplatefieldfieldmetaemailrequest.md b/docs/models/fieldcreatetemplatefieldfieldmetaemailrequest.md index c1b4e72..d04f6bb 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetaemailrequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetaemailrequest.md @@ -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.FieldCreateTemplateFieldTypeEmailRequest2](../models/fieldcreatetemplatefieldtypeemailrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldTypeEmailRequest2](../models/fieldcreatetemplatefieldtypeemailrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignEmail]](../models/fieldcreatetemplatefieldtextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetaemailresponse.md b/docs/models/fieldcreatetemplatefieldfieldmetaemailresponse.md index a73f44a..5bb00cd 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetaemailresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetaemailresponse.md @@ -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.FieldCreateTemplateFieldFieldMetaTypeEmail](../models/fieldcreatetemplatefieldfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldFieldMetaTypeEmail](../models/fieldcreatetemplatefieldfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignResponse3]](../models/fieldcreatetemplatefieldtextalignresponse3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetainitialsrequest.md b/docs/models/fieldcreatetemplatefieldfieldmetainitialsrequest.md index cead13a..778fa30 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetainitialsrequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetainitialsrequest.md @@ -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.FieldCreateTemplateFieldTypeInitialsRequest2](../models/fieldcreatetemplatefieldtypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldTypeInitialsRequest2](../models/fieldcreatetemplatefieldtypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignInitials]](../models/fieldcreatetemplatefieldtextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetainitialsresponse.md b/docs/models/fieldcreatetemplatefieldfieldmetainitialsresponse.md index dc7e362..53240ab 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetainitialsresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetainitialsresponse.md @@ -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.FieldCreateTemplateFieldFieldMetaTypeInitials](../models/fieldcreatetemplatefieldfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldFieldMetaTypeInitials](../models/fieldcreatetemplatefieldfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignResponse1]](../models/fieldcreatetemplatefieldtextalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetanamerequest.md b/docs/models/fieldcreatetemplatefieldfieldmetanamerequest.md index 596e51b..5c8ed11 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetanamerequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetanamerequest.md @@ -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.FieldCreateTemplateFieldTypeNameRequest2](../models/fieldcreatetemplatefieldtypenamerequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldTypeNameRequest2](../models/fieldcreatetemplatefieldtypenamerequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignName]](../models/fieldcreatetemplatefieldtextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetanameresponse.md b/docs/models/fieldcreatetemplatefieldfieldmetanameresponse.md index 830e0d4..960a6ad 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetanameresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetanameresponse.md @@ -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.FieldCreateTemplateFieldFieldMetaTypeName](../models/fieldcreatetemplatefieldfieldmetatypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldFieldMetaTypeName](../models/fieldcreatetemplatefieldfieldmetatypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignResponse2]](../models/fieldcreatetemplatefieldtextalignresponse2.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..c7acca6 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetanumberrequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetanumberrequest.md @@ -3,16 +3,19 @@ ## 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.FieldCreateTemplateFieldTypeNumberRequest2](../models/fieldcreatetemplatefieldtypenumberrequest2.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.FieldCreateTemplateFieldTextAlignNumber]](../models/fieldcreatetemplatefieldtextalignnumber.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldTypeNumberRequest2](../models/fieldcreatetemplatefieldtypenumberrequest2.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 | +| `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignNumber]](../models/fieldcreatetemplatefieldtextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateTemplateFieldVerticalAlignNumber]](../models/fieldcreatetemplatefieldverticalalignnumber.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..b54265e 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetanumberresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetanumberresponse.md @@ -3,16 +3,19 @@ ## 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.FieldCreateTemplateFieldFieldMetaTypeNumber](../models/fieldcreatetemplatefieldfieldmetatypenumber.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.FieldCreateTemplateFieldTextAlignResponse6]](../models/fieldcreatetemplatefieldtextalignresponse6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldFieldMetaTypeNumber](../models/fieldcreatetemplatefieldfieldmetatypenumber.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 | +| `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignResponse6]](../models/fieldcreatetemplatefieldtextalignresponse6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateTemplateFieldVerticalAlignResponse2]](../models/fieldcreatetemplatefieldverticalalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetaradiorequest.md b/docs/models/fieldcreatetemplatefieldfieldmetaradiorequest.md index 173e71b..c6e28ac 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetaradiorequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetaradiorequest.md @@ -3,11 +3,13 @@ ## 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.FieldCreateTemplateFieldTypeRadioRequest2](../models/fieldcreatetemplatefieldtyperadiorequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateTemplateFieldValueRadio](../models/fieldcreatetemplatefieldvalueradio.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldTypeRadioRequest2](../models/fieldcreatetemplatefieldtyperadiorequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateTemplateFieldValueRadio](../models/fieldcreatetemplatefieldvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateTemplateFieldDirectionRadio]](../models/fieldcreatetemplatefielddirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetaradioresponse.md b/docs/models/fieldcreatetemplatefieldfieldmetaradioresponse.md index 5536b49..5d05753 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetaradioresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetaradioresponse.md @@ -3,11 +3,13 @@ ## 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.FieldCreateTemplateFieldFieldMetaTypeRadio](../models/fieldcreatetemplatefieldfieldmetatyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateTemplateFieldValueResponse1](../models/fieldcreatetemplatefieldvalueresponse1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldFieldMetaTypeRadio](../models/fieldcreatetemplatefieldfieldmetatyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateTemplateFieldValueResponse1](../models/fieldcreatetemplatefieldvalueresponse1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateTemplateFieldDirectionResponse1]](../models/fieldcreatetemplatefielddirectionresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetasignaturerequest.md b/docs/models/fieldcreatetemplatefieldfieldmetasignaturerequest.md new file mode 100644 index 0000000..6342b15 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldfieldmetasignaturerequest.md @@ -0,0 +1,13 @@ +# FieldCreateTemplateFieldFieldMetaSignatureRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldTypeSignatureRequest2](../models/fieldcreatetemplatefieldtypesignaturerequest2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetasignatureresponse.md b/docs/models/fieldcreatetemplatefieldfieldmetasignatureresponse.md new file mode 100644 index 0000000..e77e26f --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldfieldmetasignatureresponse.md @@ -0,0 +1,13 @@ +# FieldCreateTemplateFieldFieldMetaSignatureResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldFieldMetaTypeSignature](../models/fieldcreatetemplatefieldfieldmetatypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetatextrequest.md b/docs/models/fieldcreatetemplatefieldfieldmetatextrequest.md index 1768865..8a4275a 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetatextrequest.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetatextrequest.md @@ -3,14 +3,17 @@ ## 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.FieldCreateTemplateFieldTypeTextRequest2](../models/fieldcreatetemplatefieldtypetextrequest2.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.FieldCreateTemplateFieldTextAlignText]](../models/fieldcreatetemplatefieldtextaligntext.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldTypeTextRequest2](../models/fieldcreatetemplatefieldtypetextrequest2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignText]](../models/fieldcreatetemplatefieldtextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateTemplateFieldVerticalAlignText]](../models/fieldcreatetemplatefieldverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetatextresponse.md b/docs/models/fieldcreatetemplatefieldfieldmetatextresponse.md index ae1fa91..b33bd6c 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetatextresponse.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetatextresponse.md @@ -3,14 +3,17 @@ ## 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.FieldCreateTemplateFieldFieldMetaTypeText](../models/fieldcreatetemplatefieldfieldmetatypetext.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.FieldCreateTemplateFieldTextAlignResponse5]](../models/fieldcreatetemplatefieldtextalignresponse5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldFieldMetaTypeText](../models/fieldcreatetemplatefieldfieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldCreateTemplateFieldTextAlignResponse5]](../models/fieldcreatetemplatefieldtextalignresponse5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateTemplateFieldVerticalAlignResponse1]](../models/fieldcreatetemplatefieldverticalalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetatypesignature.md b/docs/models/fieldcreatetemplatefieldfieldmetatypesignature.md new file mode 100644 index 0000000..79d95f2 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldfieldmetatypesignature.md @@ -0,0 +1,8 @@ +# FieldCreateTemplateFieldFieldMetaTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldmetaunion.md b/docs/models/fieldcreatetemplatefieldfieldmetaunion.md index a476bf8..79c2b66 100644 --- a/docs/models/fieldcreatetemplatefieldfieldmetaunion.md +++ b/docs/models/fieldcreatetemplatefieldfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldCreateTemplateFieldFieldMetaSignatureResponse` + +```python +value: models.FieldCreateTemplateFieldFieldMetaSignatureResponse = /* values here */ +``` + ### `models.FieldCreateTemplateFieldFieldMetaInitialsResponse` ```python diff --git a/docs/models/fieldcreatetemplatefieldfieldname.md b/docs/models/fieldcreatetemplatefieldfieldname.md index 67e05f9..7d24343 100644 --- a/docs/models/fieldcreatetemplatefieldfieldname.md +++ b/docs/models/fieldcreatetemplatefieldfieldname.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldTypeNameRequest1](../models/fieldcreatetemplatefieldtypenamerequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldFieldMetaNameRequest]](../models/fieldcreatetemplatefieldfieldmetanamerequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldnumber.md b/docs/models/fieldcreatetemplatefieldfieldnumber.md index 4c043ec..acaa040 100644 --- a/docs/models/fieldcreatetemplatefieldfieldnumber.md +++ b/docs/models/fieldcreatetemplatefieldfieldnumber.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateTemplateFieldTypeNumberRequest1](../models/fieldcreatetemplatefieldtypenumberrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldFieldMetaNumberRequest]](../models/fieldcreatetemplatefieldfieldmetanumberrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldradio.md b/docs/models/fieldcreatetemplatefieldfieldradio.md index efe4231..ce80acf 100644 --- a/docs/models/fieldcreatetemplatefieldfieldradio.md +++ b/docs/models/fieldcreatetemplatefieldfieldradio.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldTypeRadioRequest1](../models/fieldcreatetemplatefieldtyperadiorequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldFieldMetaRadioRequest]](../models/fieldcreatetemplatefieldfieldmetaradiorequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldsignature.md b/docs/models/fieldcreatetemplatefieldfieldsignature.md index c05eb42..f722599 100644 --- a/docs/models/fieldcreatetemplatefieldfieldsignature.md +++ b/docs/models/fieldcreatetemplatefieldfieldsignature.md @@ -3,12 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [models.FieldCreateTemplateFieldTypeSignature](../models/fieldcreatetemplatefieldtypesignature.md) | :heavy_check_mark: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.FieldCreateTemplateFieldTypeSignatureRequest1](../models/fieldcreatetemplatefieldtypesignaturerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.FieldCreateTemplateFieldFieldMetaSignatureRequest]](../models/fieldcreatetemplatefieldfieldmetasignaturerequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldfieldtext.md b/docs/models/fieldcreatetemplatefieldfieldtext.md index 7ee5bd5..fb22c80 100644 --- a/docs/models/fieldcreatetemplatefieldfieldtext.md +++ b/docs/models/fieldcreatetemplatefieldfieldtext.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldTypeTextRequest1](../models/fieldcreatetemplatefieldtypetextrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldFieldMetaTextRequest]](../models/fieldcreatetemplatefieldfieldmetatextrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldforbiddenerror.md b/docs/models/fieldcreatetemplatefieldforbiddenerror.md new file mode 100644 index 0000000..01cc8ec --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldCreateTemplateFieldForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldCreateTemplateFieldForbiddenIssue](../models/fieldcreatetemplatefieldforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldforbiddenissue.md b/docs/models/fieldcreatetemplatefieldforbiddenissue.md new file mode 100644 index 0000000..76ef220 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldCreateTemplateFieldForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldresponse.md b/docs/models/fieldcreatetemplatefieldresponse.md index 7aa96f7..6cbf6ed 100644 --- a/docs/models/fieldcreatetemplatefieldresponse.md +++ b/docs/models/fieldcreatetemplatefieldresponse.md @@ -7,17 +7,19 @@ 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/fieldcreatetemplatefieldsdirectioncheckbox.md b/docs/models/fieldcreatetemplatefieldsdirectioncheckbox.md new file mode 100644 index 0000000..abf8644 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsdirectioncheckbox.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldsDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsdirectionradio.md b/docs/models/fieldcreatetemplatefieldsdirectionradio.md new file mode 100644 index 0000000..fb59b6b --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsdirectionradio.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldsDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsdirectionresponse1.md b/docs/models/fieldcreatetemplatefieldsdirectionresponse1.md new file mode 100644 index 0000000..cc8b395 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsdirectionresponse1.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldsDirectionResponse1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsdirectionresponse2.md b/docs/models/fieldcreatetemplatefieldsdirectionresponse2.md new file mode 100644 index 0000000..69fb244 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsdirectionresponse2.md @@ -0,0 +1,9 @@ +# FieldCreateTemplateFieldsDirectionResponse2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldcheckbox.md b/docs/models/fieldcreatetemplatefieldsfieldcheckbox.md index 8f9c319..f2fa6cc 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldcheckbox.md +++ b/docs/models/fieldcreatetemplatefieldsfieldcheckbox.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateTemplateFieldsTypeCheckboxRequest1](../models/fieldcreatetemplatefieldstypecheckboxrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldsFieldMetaCheckboxRequest]](../models/fieldcreatetemplatefieldsfieldmetacheckboxrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfielddate.md b/docs/models/fieldcreatetemplatefieldsfielddate.md index 8f351e4..84d5e56 100644 --- a/docs/models/fieldcreatetemplatefieldsfielddate.md +++ b/docs/models/fieldcreatetemplatefieldsfielddate.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldsTypeDateRequest1](../models/fieldcreatetemplatefieldstypedaterequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldsFieldMetaDateRequest]](../models/fieldcreatetemplatefieldsfieldmetadaterequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfielddropdown.md b/docs/models/fieldcreatetemplatefieldsfielddropdown.md index a206f87..7ac85ea 100644 --- a/docs/models/fieldcreatetemplatefieldsfielddropdown.md +++ b/docs/models/fieldcreatetemplatefieldsfielddropdown.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateTemplateFieldsTypeDropdownRequest1](../models/fieldcreatetemplatefieldstypedropdownrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldsFieldMetaDropdownRequest]](../models/fieldcreatetemplatefieldsfieldmetadropdownrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldemail.md b/docs/models/fieldcreatetemplatefieldsfieldemail.md index afd2392..5b807a0 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldemail.md +++ b/docs/models/fieldcreatetemplatefieldsfieldemail.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateTemplateFieldsTypeEmailRequest1](../models/fieldcreatetemplatefieldstypeemailrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldsFieldMetaEmailRequest]](../models/fieldcreatetemplatefieldsfieldmetaemailrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldfreesignature.md b/docs/models/fieldcreatetemplatefieldsfieldfreesignature.md index d3a63ee..5fe868f 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldfreesignature.md +++ b/docs/models/fieldcreatetemplatefieldsfieldfreesignature.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateTemplateFieldsTypeFreeSignature](../models/fieldcreatetemplatefieldstypefreesignature.md) | :heavy_check_mark: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldinitials.md b/docs/models/fieldcreatetemplatefieldsfieldinitials.md index c5daf6c..17d68be 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldinitials.md +++ b/docs/models/fieldcreatetemplatefieldsfieldinitials.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateTemplateFieldsTypeInitialsRequest1](../models/fieldcreatetemplatefieldstypeinitialsrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldsFieldMetaInitialsRequest]](../models/fieldcreatetemplatefieldsfieldmetainitialsrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxrequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxrequest.md index 8e4daa2..cc63c5c 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxrequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxrequest.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldCreateTemplateFieldsDirectionCheckbox]](../models/fieldcreatetemplatefieldsdirectioncheckbox.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..86ebf11 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetacheckboxresponse.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldCreateTemplateFieldsDirectionResponse2]](../models/fieldcreatetemplatefieldsdirectionresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetadaterequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetadaterequest.md index 5d18160..872ca81 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetadaterequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetadaterequest.md @@ -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.FieldCreateTemplateFieldsTypeDateRequest2](../models/fieldcreatetemplatefieldstypedaterequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsTypeDateRequest2](../models/fieldcreatetemplatefieldstypedaterequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignDate]](../models/fieldcreatetemplatefieldstextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetadateresponse.md b/docs/models/fieldcreatetemplatefieldsfieldmetadateresponse.md index 22a9329..aeee169 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetadateresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetadateresponse.md @@ -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.FieldCreateTemplateFieldsFieldMetaTypeDate](../models/fieldcreatetemplatefieldsfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeDate](../models/fieldcreatetemplatefieldsfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignResponse4]](../models/fieldcreatetemplatefieldstextalignresponse4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetadropdownrequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetadropdownrequest.md index 9f4f74c..a144b13 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetadropdownrequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetadropdownrequest.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateTemplateFieldsTypeDropdownRequest2](../models/fieldcreatetemplatefieldstypedropdownrequest2.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldCreateTemplateFieldsValueDropdown](../models/fieldcreatetemplatefieldsvaluedropdown.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/fieldcreatetemplatefieldsfieldmetadropdownresponse.md b/docs/models/fieldcreatetemplatefieldsfieldmetadropdownresponse.md index eced698..807bdbe 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetadropdownresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetadropdownresponse.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeDropdown](../models/fieldcreatetemplatefieldsfieldmetatypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldCreateTemplateFieldsValueResponse3](../models/fieldcreatetemplatefieldsvalueresponse3.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/fieldcreatetemplatefieldsfieldmetaemailrequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetaemailrequest.md index 79b9b7d..76e480c 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetaemailrequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetaemailrequest.md @@ -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.FieldCreateTemplateFieldsTypeEmailRequest2](../models/fieldcreatetemplatefieldstypeemailrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsTypeEmailRequest2](../models/fieldcreatetemplatefieldstypeemailrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignEmail]](../models/fieldcreatetemplatefieldstextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetaemailresponse.md b/docs/models/fieldcreatetemplatefieldsfieldmetaemailresponse.md index 04516eb..d44f152 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetaemailresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetaemailresponse.md @@ -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.FieldCreateTemplateFieldsFieldMetaTypeEmail](../models/fieldcreatetemplatefieldsfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeEmail](../models/fieldcreatetemplatefieldsfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignResponse3]](../models/fieldcreatetemplatefieldstextalignresponse3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetainitialsrequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetainitialsrequest.md index 05d4d6a..565240c 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetainitialsrequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetainitialsrequest.md @@ -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.FieldCreateTemplateFieldsTypeInitialsRequest2](../models/fieldcreatetemplatefieldstypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsTypeInitialsRequest2](../models/fieldcreatetemplatefieldstypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignInitials]](../models/fieldcreatetemplatefieldstextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetainitialsresponse.md b/docs/models/fieldcreatetemplatefieldsfieldmetainitialsresponse.md index 1055130..fc857c1 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetainitialsresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetainitialsresponse.md @@ -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.FieldCreateTemplateFieldsFieldMetaTypeInitials](../models/fieldcreatetemplatefieldsfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeInitials](../models/fieldcreatetemplatefieldsfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignResponse1]](../models/fieldcreatetemplatefieldstextalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetanamerequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetanamerequest.md index 56e3f0b..69e6e39 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetanamerequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetanamerequest.md @@ -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.FieldCreateTemplateFieldsTypeNameRequest2](../models/fieldcreatetemplatefieldstypenamerequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsTypeNameRequest2](../models/fieldcreatetemplatefieldstypenamerequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignName]](../models/fieldcreatetemplatefieldstextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetanameresponse.md b/docs/models/fieldcreatetemplatefieldsfieldmetanameresponse.md index 8426129..c69ed8c 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetanameresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetanameresponse.md @@ -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.FieldCreateTemplateFieldsFieldMetaTypeName](../models/fieldcreatetemplatefieldsfieldmetatypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeName](../models/fieldcreatetemplatefieldsfieldmetatypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignResponse2]](../models/fieldcreatetemplatefieldstextalignresponse2.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..92ab38d 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetanumberrequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetanumberrequest.md @@ -3,16 +3,19 @@ ## 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.FieldCreateTemplateFieldsTypeNumberRequest2](../models/fieldcreatetemplatefieldstypenumberrequest2.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.FieldCreateTemplateFieldsTextAlignNumber]](../models/fieldcreatetemplatefieldstextalignnumber.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsTypeNumberRequest2](../models/fieldcreatetemplatefieldstypenumberrequest2.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 | +| `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignNumber]](../models/fieldcreatetemplatefieldstextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateTemplateFieldsVerticalAlignNumber]](../models/fieldcreatetemplatefieldsverticalalignnumber.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..72f2d71 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetanumberresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetanumberresponse.md @@ -3,16 +3,19 @@ ## 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.FieldCreateTemplateFieldsFieldMetaTypeNumber](../models/fieldcreatetemplatefieldsfieldmetatypenumber.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.FieldCreateTemplateFieldsTextAlignResponse6]](../models/fieldcreatetemplatefieldstextalignresponse6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeNumber](../models/fieldcreatetemplatefieldsfieldmetatypenumber.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 | +| `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignResponse6]](../models/fieldcreatetemplatefieldstextalignresponse6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateTemplateFieldsVerticalAlignResponse2]](../models/fieldcreatetemplatefieldsverticalalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetaradiorequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetaradiorequest.md index 189b096..bdd6198 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetaradiorequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetaradiorequest.md @@ -3,11 +3,13 @@ ## 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.FieldCreateTemplateFieldsTypeRadioRequest2](../models/fieldcreatetemplatefieldstyperadiorequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateTemplateFieldsValueRadio](../models/fieldcreatetemplatefieldsvalueradio.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsTypeRadioRequest2](../models/fieldcreatetemplatefieldstyperadiorequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateTemplateFieldsValueRadio](../models/fieldcreatetemplatefieldsvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateTemplateFieldsDirectionRadio]](../models/fieldcreatetemplatefieldsdirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetaradioresponse.md b/docs/models/fieldcreatetemplatefieldsfieldmetaradioresponse.md index 365ccfa..ed9bd87 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetaradioresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetaradioresponse.md @@ -3,11 +3,13 @@ ## 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.FieldCreateTemplateFieldsFieldMetaTypeRadio](../models/fieldcreatetemplatefieldsfieldmetatyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldCreateTemplateFieldsValueResponse1](../models/fieldcreatetemplatefieldsvalueresponse1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeRadio](../models/fieldcreatetemplatefieldsfieldmetatyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldCreateTemplateFieldsValueResponse1](../models/fieldcreatetemplatefieldsvalueresponse1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldCreateTemplateFieldsDirectionResponse1]](../models/fieldcreatetemplatefieldsdirectionresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetasignaturerequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetasignaturerequest.md new file mode 100644 index 0000000..808ff86 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsfieldmetasignaturerequest.md @@ -0,0 +1,13 @@ +# FieldCreateTemplateFieldsFieldMetaSignatureRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsTypeSignatureRequest2](../models/fieldcreatetemplatefieldstypesignaturerequest2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetasignatureresponse.md b/docs/models/fieldcreatetemplatefieldsfieldmetasignatureresponse.md new file mode 100644 index 0000000..9ee7845 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsfieldmetasignatureresponse.md @@ -0,0 +1,13 @@ +# FieldCreateTemplateFieldsFieldMetaSignatureResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeSignature](../models/fieldcreatetemplatefieldsfieldmetatypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetatextrequest.md b/docs/models/fieldcreatetemplatefieldsfieldmetatextrequest.md index 831503f..ae7c056 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetatextrequest.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetatextrequest.md @@ -3,14 +3,17 @@ ## 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.FieldCreateTemplateFieldsTypeTextRequest2](../models/fieldcreatetemplatefieldstypetextrequest2.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.FieldCreateTemplateFieldsTextAlignText]](../models/fieldcreatetemplatefieldstextaligntext.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsTypeTextRequest2](../models/fieldcreatetemplatefieldstypetextrequest2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignText]](../models/fieldcreatetemplatefieldstextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateTemplateFieldsVerticalAlignText]](../models/fieldcreatetemplatefieldsverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetatextresponse.md b/docs/models/fieldcreatetemplatefieldsfieldmetatextresponse.md index f4059d8..5099225 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetatextresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetatextresponse.md @@ -3,14 +3,17 @@ ## 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.FieldCreateTemplateFieldsFieldMetaTypeText](../models/fieldcreatetemplatefieldsfieldmetatypetext.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.FieldCreateTemplateFieldsTextAlignResponse5]](../models/fieldcreatetemplatefieldstextalignresponse5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldCreateTemplateFieldsFieldMetaTypeText](../models/fieldcreatetemplatefieldsfieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldCreateTemplateFieldsTextAlignResponse5]](../models/fieldcreatetemplatefieldstextalignresponse5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldCreateTemplateFieldsVerticalAlignResponse1]](../models/fieldcreatetemplatefieldsverticalalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetatypesignature.md b/docs/models/fieldcreatetemplatefieldsfieldmetatypesignature.md new file mode 100644 index 0000000..5317c8a --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsfieldmetatypesignature.md @@ -0,0 +1,8 @@ +# FieldCreateTemplateFieldsFieldMetaTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldmetaunion.md b/docs/models/fieldcreatetemplatefieldsfieldmetaunion.md index b6f1aeb..067593e 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldmetaunion.md +++ b/docs/models/fieldcreatetemplatefieldsfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldCreateTemplateFieldsFieldMetaSignatureResponse` + +```python +value: models.FieldCreateTemplateFieldsFieldMetaSignatureResponse = /* values here */ +``` + ### `models.FieldCreateTemplateFieldsFieldMetaInitialsResponse` ```python diff --git a/docs/models/fieldcreatetemplatefieldsfieldname.md b/docs/models/fieldcreatetemplatefieldsfieldname.md index ba9e13d..4082c59 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldname.md +++ b/docs/models/fieldcreatetemplatefieldsfieldname.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldsTypeNameRequest1](../models/fieldcreatetemplatefieldstypenamerequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldsFieldMetaNameRequest]](../models/fieldcreatetemplatefieldsfieldmetanamerequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldnumber.md b/docs/models/fieldcreatetemplatefieldsfieldnumber.md index 33d613c..f0d3718 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldnumber.md +++ b/docs/models/fieldcreatetemplatefieldsfieldnumber.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldsTypeNumberRequest1](../models/fieldcreatetemplatefieldstypenumberrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldsFieldMetaNumberRequest]](../models/fieldcreatetemplatefieldsfieldmetanumberrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldradio.md b/docs/models/fieldcreatetemplatefieldsfieldradio.md index 47df2db..cd464ba 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldradio.md +++ b/docs/models/fieldcreatetemplatefieldsfieldradio.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldCreateTemplateFieldsTypeRadioRequest1](../models/fieldcreatetemplatefieldstyperadiorequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldsFieldMetaRadioRequest]](../models/fieldcreatetemplatefieldsfieldmetaradiorequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldresponse.md b/docs/models/fieldcreatetemplatefieldsfieldresponse.md index b03cfc9..575fa30 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldresponse.md +++ b/docs/models/fieldcreatetemplatefieldsfieldresponse.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/fieldcreatetemplatefieldsfieldsignature.md b/docs/models/fieldcreatetemplatefieldsfieldsignature.md index fdca2d6..290cc7e 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldsignature.md +++ b/docs/models/fieldcreatetemplatefieldsfieldsignature.md @@ -3,12 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `type` | [models.FieldCreateTemplateFieldsTypeSignature](../models/fieldcreatetemplatefieldstypesignature.md) | :heavy_check_mark: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.FieldCreateTemplateFieldsTypeSignatureRequest1](../models/fieldcreatetemplatefieldstypesignaturerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.FieldCreateTemplateFieldsFieldMetaSignatureRequest]](../models/fieldcreatetemplatefieldsfieldmetasignaturerequest.md) | :heavy_minus_sign: | N/A | +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsfieldtext.md b/docs/models/fieldcreatetemplatefieldsfieldtext.md index 56cf047..a1f83e0 100644 --- a/docs/models/fieldcreatetemplatefieldsfieldtext.md +++ b/docs/models/fieldcreatetemplatefieldsfieldtext.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldCreateTemplateFieldsTypeTextRequest1](../models/fieldcreatetemplatefieldstypetextrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldCreateTemplateFieldsFieldMetaTextRequest]](../models/fieldcreatetemplatefieldsfieldmetatextrequest.md) | :heavy_minus_sign: | N/A | -| `recipient_id` | *float* | :heavy_check_mark: | The ID of the recipient to create the field for. | -| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. | -| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. | -| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. | -| `width` | *float* | :heavy_check_mark: | The width of the field. | -| `height` | *float* | :heavy_check_mark: | The height of the field. | \ No newline at end of file +| `recipient_id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *float* | :heavy_check_mark: | N/A | +| `page_x` | *float* | :heavy_check_mark: | N/A | +| `page_y` | *float* | :heavy_check_mark: | N/A | +| `width` | *float* | :heavy_check_mark: | N/A | +| `height` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsforbiddenerror.md b/docs/models/fieldcreatetemplatefieldsforbiddenerror.md new file mode 100644 index 0000000..6bc1be7 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldCreateTemplateFieldsForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldCreateTemplateFieldsForbiddenIssue](../models/fieldcreatetemplatefieldsforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsforbiddenissue.md b/docs/models/fieldcreatetemplatefieldsforbiddenissue.md new file mode 100644 index 0000000..594b0d5 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldCreateTemplateFieldsForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldstypesignaturerequest1.md b/docs/models/fieldcreatetemplatefieldstypesignaturerequest1.md new file mode 100644 index 0000000..cff7558 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldstypesignaturerequest1.md @@ -0,0 +1,8 @@ +# FieldCreateTemplateFieldsTypeSignatureRequest1 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | SIGNATURE | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldstypesignaturerequest2.md b/docs/models/fieldcreatetemplatefieldstypesignaturerequest2.md new file mode 100644 index 0000000..28099cc --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldstypesignaturerequest2.md @@ -0,0 +1,8 @@ +# FieldCreateTemplateFieldsTypeSignatureRequest2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsunauthorizederror.md b/docs/models/fieldcreatetemplatefieldsunauthorizederror.md new file mode 100644 index 0000000..3491b96 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldCreateTemplateFieldsUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldCreateTemplateFieldsUnauthorizedIssue](../models/fieldcreatetemplatefieldsunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsunauthorizedissue.md b/docs/models/fieldcreatetemplatefieldsunauthorizedissue.md new file mode 100644 index 0000000..1ec552c --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldCreateTemplateFieldsUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsverticalalignnumber.md b/docs/models/fieldcreatetemplatefieldsverticalalignnumber.md new file mode 100644 index 0000000..4282240 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsverticalalignnumber.md @@ -0,0 +1,10 @@ +# FieldCreateTemplateFieldsVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsverticalalignresponse1.md b/docs/models/fieldcreatetemplatefieldsverticalalignresponse1.md new file mode 100644 index 0000000..cd06c22 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsverticalalignresponse1.md @@ -0,0 +1,10 @@ +# FieldCreateTemplateFieldsVerticalAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsverticalalignresponse2.md b/docs/models/fieldcreatetemplatefieldsverticalalignresponse2.md new file mode 100644 index 0000000..e94ad30 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsverticalalignresponse2.md @@ -0,0 +1,10 @@ +# FieldCreateTemplateFieldsVerticalAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldsverticalaligntext.md b/docs/models/fieldcreatetemplatefieldsverticalaligntext.md new file mode 100644 index 0000000..71fc2e6 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldsverticalaligntext.md @@ -0,0 +1,10 @@ +# FieldCreateTemplateFieldsVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/documentcreatedocumenttemporarytypesignature.md b/docs/models/fieldcreatetemplatefieldtypesignaturerequest1.md similarity index 68% rename from docs/models/documentcreatedocumenttemporarytypesignature.md rename to docs/models/fieldcreatetemplatefieldtypesignaturerequest1.md index a5a7756..bdcc7cb 100644 --- a/docs/models/documentcreatedocumenttemporarytypesignature.md +++ b/docs/models/fieldcreatetemplatefieldtypesignaturerequest1.md @@ -1,4 +1,4 @@ -# DocumentCreateDocumentTemporaryTypeSignature +# FieldCreateTemplateFieldTypeSignatureRequest1 ## Values diff --git a/docs/models/fieldcreatetemplatefieldtypesignaturerequest2.md b/docs/models/fieldcreatetemplatefieldtypesignaturerequest2.md new file mode 100644 index 0000000..56a6065 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldtypesignaturerequest2.md @@ -0,0 +1,8 @@ +# FieldCreateTemplateFieldTypeSignatureRequest2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldunauthorizederror.md b/docs/models/fieldcreatetemplatefieldunauthorizederror.md new file mode 100644 index 0000000..d1c7383 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldCreateTemplateFieldUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldCreateTemplateFieldUnauthorizedIssue](../models/fieldcreatetemplatefieldunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldunauthorizedissue.md b/docs/models/fieldcreatetemplatefieldunauthorizedissue.md new file mode 100644 index 0000000..8d1252c --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldCreateTemplateFieldUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldverticalalignnumber.md b/docs/models/fieldcreatetemplatefieldverticalalignnumber.md new file mode 100644 index 0000000..0e451d7 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldverticalalignnumber.md @@ -0,0 +1,10 @@ +# FieldCreateTemplateFieldVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldverticalalignresponse1.md b/docs/models/fieldcreatetemplatefieldverticalalignresponse1.md new file mode 100644 index 0000000..4807e0f --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldverticalalignresponse1.md @@ -0,0 +1,10 @@ +# FieldCreateTemplateFieldVerticalAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldverticalalignresponse2.md b/docs/models/fieldcreatetemplatefieldverticalalignresponse2.md new file mode 100644 index 0000000..0ce33a4 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldverticalalignresponse2.md @@ -0,0 +1,10 @@ +# FieldCreateTemplateFieldVerticalAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldcreatetemplatefieldverticalaligntext.md b/docs/models/fieldcreatetemplatefieldverticalaligntext.md new file mode 100644 index 0000000..9b3ed76 --- /dev/null +++ b/docs/models/fieldcreatetemplatefieldverticalaligntext.md @@ -0,0 +1,10 @@ +# FieldCreateTemplateFieldVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fielddeletedocumentfieldforbiddenerror.md b/docs/models/fielddeletedocumentfieldforbiddenerror.md new file mode 100644 index 0000000..d28fc1a --- /dev/null +++ b/docs/models/fielddeletedocumentfieldforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldDeleteDocumentFieldForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldDeleteDocumentFieldForbiddenIssue](../models/fielddeletedocumentfieldforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fielddeletedocumentfieldforbiddenissue.md b/docs/models/fielddeletedocumentfieldforbiddenissue.md new file mode 100644 index 0000000..ee9f0de --- /dev/null +++ b/docs/models/fielddeletedocumentfieldforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldDeleteDocumentFieldForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fielddeletedocumentfieldunauthorizederror.md b/docs/models/fielddeletedocumentfieldunauthorizederror.md new file mode 100644 index 0000000..fc407fd --- /dev/null +++ b/docs/models/fielddeletedocumentfieldunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldDeleteDocumentFieldUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldDeleteDocumentFieldUnauthorizedIssue](../models/fielddeletedocumentfieldunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fielddeletedocumentfieldunauthorizedissue.md b/docs/models/fielddeletedocumentfieldunauthorizedissue.md new file mode 100644 index 0000000..2b972da --- /dev/null +++ b/docs/models/fielddeletedocumentfieldunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldDeleteDocumentFieldUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fielddeletetemplatefieldforbiddenerror.md b/docs/models/fielddeletetemplatefieldforbiddenerror.md new file mode 100644 index 0000000..74e6359 --- /dev/null +++ b/docs/models/fielddeletetemplatefieldforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldDeleteTemplateFieldForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldDeleteTemplateFieldForbiddenIssue](../models/fielddeletetemplatefieldforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fielddeletetemplatefieldforbiddenissue.md b/docs/models/fielddeletetemplatefieldforbiddenissue.md new file mode 100644 index 0000000..954b32a --- /dev/null +++ b/docs/models/fielddeletetemplatefieldforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldDeleteTemplateFieldForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fielddeletetemplatefieldunauthorizederror.md b/docs/models/fielddeletetemplatefieldunauthorizederror.md new file mode 100644 index 0000000..f8f4a92 --- /dev/null +++ b/docs/models/fielddeletetemplatefieldunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldDeleteTemplateFieldUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldDeleteTemplateFieldUnauthorizedIssue](../models/fielddeletetemplatefieldunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fielddeletetemplatefieldunauthorizedissue.md b/docs/models/fielddeletetemplatefieldunauthorizedissue.md new file mode 100644 index 0000000..f9cecd5 --- /dev/null +++ b/docs/models/fielddeletetemplatefieldunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldDeleteTemplateFieldUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfielddirection1.md b/docs/models/fieldgetdocumentfielddirection1.md new file mode 100644 index 0000000..1fac59a --- /dev/null +++ b/docs/models/fieldgetdocumentfielddirection1.md @@ -0,0 +1,9 @@ +# FieldGetDocumentFieldDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfielddirection2.md b/docs/models/fieldgetdocumentfielddirection2.md new file mode 100644 index 0000000..42bae89 --- /dev/null +++ b/docs/models/fieldgetdocumentfielddirection2.md @@ -0,0 +1,9 @@ +# FieldGetDocumentFieldDirection2 + + +## 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..28da749 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetacheckbox.md +++ b/docs/models/fieldgetdocumentfieldfieldmetacheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldGetDocumentFieldDirection2]](../models/fieldgetdocumentfielddirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldfieldmetadate.md b/docs/models/fieldgetdocumentfieldfieldmetadate.md index 7cf0865..6b956b1 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetadate.md +++ b/docs/models/fieldgetdocumentfieldfieldmetadate.md @@ -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.FieldGetDocumentFieldTypeDate](../models/fieldgetdocumentfieldtypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetDocumentFieldTypeDate](../models/fieldgetdocumentfieldtypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldGetDocumentFieldTextAlign4]](../models/fieldgetdocumentfieldtextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldfieldmetadropdown.md b/docs/models/fieldgetdocumentfieldfieldmetadropdown.md index c83e72a..ba34f97 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetadropdown.md +++ b/docs/models/fieldgetdocumentfieldfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldGetDocumentFieldTypeDropdown](../models/fieldgetdocumentfieldtypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldGetDocumentFieldValue3](../models/fieldgetdocumentfieldvalue3.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/fieldgetdocumentfieldfieldmetaemail.md b/docs/models/fieldgetdocumentfieldfieldmetaemail.md index 27473bf..1682639 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetaemail.md +++ b/docs/models/fieldgetdocumentfieldfieldmetaemail.md @@ -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.FieldGetDocumentFieldTypeEmail](../models/fieldgetdocumentfieldtypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetDocumentFieldTypeEmail](../models/fieldgetdocumentfieldtypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldGetDocumentFieldTextAlign3]](../models/fieldgetdocumentfieldtextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldfieldmetainitials.md b/docs/models/fieldgetdocumentfieldfieldmetainitials.md index b31530a..37a122f 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetainitials.md +++ b/docs/models/fieldgetdocumentfieldfieldmetainitials.md @@ -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.FieldGetDocumentFieldTypeInitials](../models/fieldgetdocumentfieldtypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetDocumentFieldTypeInitials](../models/fieldgetdocumentfieldtypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldGetDocumentFieldTextAlign1]](../models/fieldgetdocumentfieldtextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldfieldmetaname.md b/docs/models/fieldgetdocumentfieldfieldmetaname.md index 5cd668c..8e6575d 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetaname.md +++ b/docs/models/fieldgetdocumentfieldfieldmetaname.md @@ -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.FieldGetDocumentFieldTypeName](../models/fieldgetdocumentfieldtypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetDocumentFieldTypeName](../models/fieldgetdocumentfieldtypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldGetDocumentFieldTextAlign2]](../models/fieldgetdocumentfieldtextalign2.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..15bfd02 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetanumber.md +++ b/docs/models/fieldgetdocumentfieldfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.FieldGetDocumentFieldTypeNumber](../models/fieldgetdocumentfieldtypenumber.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.FieldGetDocumentFieldTextAlign6]](../models/fieldgetdocumentfieldtextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetDocumentFieldTypeNumber](../models/fieldgetdocumentfieldtypenumber.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 | +| `text_align` | [Optional[models.FieldGetDocumentFieldTextAlign6]](../models/fieldgetdocumentfieldtextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldGetDocumentFieldVerticalAlign2]](../models/fieldgetdocumentfieldverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldfieldmetaradio.md b/docs/models/fieldgetdocumentfieldfieldmetaradio.md index 2995b8c..8b8afdb 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetaradio.md +++ b/docs/models/fieldgetdocumentfieldfieldmetaradio.md @@ -3,11 +3,13 @@ ## 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.FieldGetDocumentFieldTypeRadio](../models/fieldgetdocumentfieldtyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldGetDocumentFieldValue1](../models/fieldgetdocumentfieldvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetDocumentFieldTypeRadio](../models/fieldgetdocumentfieldtyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldGetDocumentFieldValue1](../models/fieldgetdocumentfieldvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldGetDocumentFieldDirection1]](../models/fieldgetdocumentfielddirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldfieldmetasignature.md b/docs/models/fieldgetdocumentfieldfieldmetasignature.md new file mode 100644 index 0000000..b19a65d --- /dev/null +++ b/docs/models/fieldgetdocumentfieldfieldmetasignature.md @@ -0,0 +1,13 @@ +# FieldGetDocumentFieldFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetDocumentFieldTypeSignature](../models/fieldgetdocumentfieldtypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldfieldmetatext.md b/docs/models/fieldgetdocumentfieldfieldmetatext.md index 08803f6..af25146 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetatext.md +++ b/docs/models/fieldgetdocumentfieldfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.FieldGetDocumentFieldTypeText](../models/fieldgetdocumentfieldtypetext.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.FieldGetDocumentFieldTextAlign5]](../models/fieldgetdocumentfieldtextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetDocumentFieldTypeText](../models/fieldgetdocumentfieldtypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldGetDocumentFieldTextAlign5]](../models/fieldgetdocumentfieldtextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldGetDocumentFieldVerticalAlign1]](../models/fieldgetdocumentfieldverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldfieldmetaunion.md b/docs/models/fieldgetdocumentfieldfieldmetaunion.md index 20a6087..38b2718 100644 --- a/docs/models/fieldgetdocumentfieldfieldmetaunion.md +++ b/docs/models/fieldgetdocumentfieldfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldGetDocumentFieldFieldMetaSignature` + +```python +value: models.FieldGetDocumentFieldFieldMetaSignature = /* values here */ +``` + ### `models.FieldGetDocumentFieldFieldMetaInitials` ```python diff --git a/docs/models/fieldgetdocumentfieldforbiddenerror.md b/docs/models/fieldgetdocumentfieldforbiddenerror.md new file mode 100644 index 0000000..0d11218 --- /dev/null +++ b/docs/models/fieldgetdocumentfieldforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldGetDocumentFieldForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldGetDocumentFieldForbiddenIssue](../models/fieldgetdocumentfieldforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldforbiddenissue.md b/docs/models/fieldgetdocumentfieldforbiddenissue.md new file mode 100644 index 0000000..68f4a75 --- /dev/null +++ b/docs/models/fieldgetdocumentfieldforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldGetDocumentFieldForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldresponse.md b/docs/models/fieldgetdocumentfieldresponse.md index 4c592a7..2769d37 100644 --- a/docs/models/fieldgetdocumentfieldresponse.md +++ b/docs/models/fieldgetdocumentfieldresponse.md @@ -7,17 +7,19 @@ 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/fieldgetdocumentfieldtypesignature.md b/docs/models/fieldgetdocumentfieldtypesignature.md new file mode 100644 index 0000000..9d98c64 --- /dev/null +++ b/docs/models/fieldgetdocumentfieldtypesignature.md @@ -0,0 +1,8 @@ +# FieldGetDocumentFieldTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldunauthorizederror.md b/docs/models/fieldgetdocumentfieldunauthorizederror.md new file mode 100644 index 0000000..8ad1299 --- /dev/null +++ b/docs/models/fieldgetdocumentfieldunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldGetDocumentFieldUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldGetDocumentFieldUnauthorizedIssue](../models/fieldgetdocumentfieldunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldunauthorizedissue.md b/docs/models/fieldgetdocumentfieldunauthorizedissue.md new file mode 100644 index 0000000..f5aaabb --- /dev/null +++ b/docs/models/fieldgetdocumentfieldunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldGetDocumentFieldUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldverticalalign1.md b/docs/models/fieldgetdocumentfieldverticalalign1.md new file mode 100644 index 0000000..c61697e --- /dev/null +++ b/docs/models/fieldgetdocumentfieldverticalalign1.md @@ -0,0 +1,10 @@ +# FieldGetDocumentFieldVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldgetdocumentfieldverticalalign2.md b/docs/models/fieldgetdocumentfieldverticalalign2.md new file mode 100644 index 0000000..a5c005e --- /dev/null +++ b/docs/models/fieldgetdocumentfieldverticalalign2.md @@ -0,0 +1,10 @@ +# FieldGetDocumentFieldVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefielddirection1.md b/docs/models/fieldgettemplatefielddirection1.md new file mode 100644 index 0000000..03e822a --- /dev/null +++ b/docs/models/fieldgettemplatefielddirection1.md @@ -0,0 +1,9 @@ +# FieldGetTemplateFieldDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefielddirection2.md b/docs/models/fieldgettemplatefielddirection2.md new file mode 100644 index 0000000..3bc531b --- /dev/null +++ b/docs/models/fieldgettemplatefielddirection2.md @@ -0,0 +1,9 @@ +# FieldGetTemplateFieldDirection2 + + +## 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..5db6404 100644 --- a/docs/models/fieldgettemplatefieldfieldmetacheckbox.md +++ b/docs/models/fieldgettemplatefieldfieldmetacheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldGetTemplateFieldDirection2]](../models/fieldgettemplatefielddirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldfieldmetadate.md b/docs/models/fieldgettemplatefieldfieldmetadate.md index ccd4bdf..1520e7c 100644 --- a/docs/models/fieldgettemplatefieldfieldmetadate.md +++ b/docs/models/fieldgettemplatefieldfieldmetadate.md @@ -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.FieldGetTemplateFieldTypeDate](../models/fieldgettemplatefieldtypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetTemplateFieldTypeDate](../models/fieldgettemplatefieldtypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldGetTemplateFieldTextAlign4]](../models/fieldgettemplatefieldtextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldfieldmetadropdown.md b/docs/models/fieldgettemplatefieldfieldmetadropdown.md index 9f45e16..5289f5b 100644 --- a/docs/models/fieldgettemplatefieldfieldmetadropdown.md +++ b/docs/models/fieldgettemplatefieldfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldGetTemplateFieldTypeDropdown](../models/fieldgettemplatefieldtypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldGetTemplateFieldValue3](../models/fieldgettemplatefieldvalue3.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/fieldgettemplatefieldfieldmetaemail.md b/docs/models/fieldgettemplatefieldfieldmetaemail.md index 92763c1..33c039f 100644 --- a/docs/models/fieldgettemplatefieldfieldmetaemail.md +++ b/docs/models/fieldgettemplatefieldfieldmetaemail.md @@ -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.FieldGetTemplateFieldTypeEmail](../models/fieldgettemplatefieldtypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetTemplateFieldTypeEmail](../models/fieldgettemplatefieldtypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldGetTemplateFieldTextAlign3]](../models/fieldgettemplatefieldtextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldfieldmetainitials.md b/docs/models/fieldgettemplatefieldfieldmetainitials.md index 95c7d2c..1598b1e 100644 --- a/docs/models/fieldgettemplatefieldfieldmetainitials.md +++ b/docs/models/fieldgettemplatefieldfieldmetainitials.md @@ -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.FieldGetTemplateFieldTypeInitials](../models/fieldgettemplatefieldtypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetTemplateFieldTypeInitials](../models/fieldgettemplatefieldtypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldGetTemplateFieldTextAlign1]](../models/fieldgettemplatefieldtextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldfieldmetaname.md b/docs/models/fieldgettemplatefieldfieldmetaname.md index 96b4021..1ea3477 100644 --- a/docs/models/fieldgettemplatefieldfieldmetaname.md +++ b/docs/models/fieldgettemplatefieldfieldmetaname.md @@ -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.FieldGetTemplateFieldTypeName](../models/fieldgettemplatefieldtypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetTemplateFieldTypeName](../models/fieldgettemplatefieldtypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldGetTemplateFieldTextAlign2]](../models/fieldgettemplatefieldtextalign2.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..d0858d6 100644 --- a/docs/models/fieldgettemplatefieldfieldmetanumber.md +++ b/docs/models/fieldgettemplatefieldfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.FieldGetTemplateFieldTypeNumber](../models/fieldgettemplatefieldtypenumber.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.FieldGetTemplateFieldTextAlign6]](../models/fieldgettemplatefieldtextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetTemplateFieldTypeNumber](../models/fieldgettemplatefieldtypenumber.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 | +| `text_align` | [Optional[models.FieldGetTemplateFieldTextAlign6]](../models/fieldgettemplatefieldtextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldGetTemplateFieldVerticalAlign2]](../models/fieldgettemplatefieldverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldfieldmetaradio.md b/docs/models/fieldgettemplatefieldfieldmetaradio.md index 8841337..b1d848e 100644 --- a/docs/models/fieldgettemplatefieldfieldmetaradio.md +++ b/docs/models/fieldgettemplatefieldfieldmetaradio.md @@ -3,11 +3,13 @@ ## 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.FieldGetTemplateFieldTypeRadio](../models/fieldgettemplatefieldtyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldGetTemplateFieldValue1](../models/fieldgettemplatefieldvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetTemplateFieldTypeRadio](../models/fieldgettemplatefieldtyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldGetTemplateFieldValue1](../models/fieldgettemplatefieldvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldGetTemplateFieldDirection1]](../models/fieldgettemplatefielddirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldfieldmetasignature.md b/docs/models/fieldgettemplatefieldfieldmetasignature.md new file mode 100644 index 0000000..6a53b52 --- /dev/null +++ b/docs/models/fieldgettemplatefieldfieldmetasignature.md @@ -0,0 +1,13 @@ +# FieldGetTemplateFieldFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetTemplateFieldTypeSignature](../models/fieldgettemplatefieldtypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldfieldmetatext.md b/docs/models/fieldgettemplatefieldfieldmetatext.md index 439649d..d37426e 100644 --- a/docs/models/fieldgettemplatefieldfieldmetatext.md +++ b/docs/models/fieldgettemplatefieldfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.FieldGetTemplateFieldTypeText](../models/fieldgettemplatefieldtypetext.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.FieldGetTemplateFieldTextAlign5]](../models/fieldgettemplatefieldtextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldGetTemplateFieldTypeText](../models/fieldgettemplatefieldtypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldGetTemplateFieldTextAlign5]](../models/fieldgettemplatefieldtextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldGetTemplateFieldVerticalAlign1]](../models/fieldgettemplatefieldverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldfieldmetaunion.md b/docs/models/fieldgettemplatefieldfieldmetaunion.md index 6a9b6a3..190697a 100644 --- a/docs/models/fieldgettemplatefieldfieldmetaunion.md +++ b/docs/models/fieldgettemplatefieldfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldGetTemplateFieldFieldMetaSignature` + +```python +value: models.FieldGetTemplateFieldFieldMetaSignature = /* values here */ +``` + ### `models.FieldGetTemplateFieldFieldMetaInitials` ```python diff --git a/docs/models/fieldgettemplatefieldforbiddenerror.md b/docs/models/fieldgettemplatefieldforbiddenerror.md new file mode 100644 index 0000000..ae46173 --- /dev/null +++ b/docs/models/fieldgettemplatefieldforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldGetTemplateFieldForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldGetTemplateFieldForbiddenIssue](../models/fieldgettemplatefieldforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldforbiddenissue.md b/docs/models/fieldgettemplatefieldforbiddenissue.md new file mode 100644 index 0000000..773f065 --- /dev/null +++ b/docs/models/fieldgettemplatefieldforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldGetTemplateFieldForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldresponse.md b/docs/models/fieldgettemplatefieldresponse.md index 567fc7f..e9159a6 100644 --- a/docs/models/fieldgettemplatefieldresponse.md +++ b/docs/models/fieldgettemplatefieldresponse.md @@ -7,17 +7,19 @@ 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/fieldgettemplatefieldtypesignature.md b/docs/models/fieldgettemplatefieldtypesignature.md new file mode 100644 index 0000000..721cd70 --- /dev/null +++ b/docs/models/fieldgettemplatefieldtypesignature.md @@ -0,0 +1,8 @@ +# FieldGetTemplateFieldTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldunauthorizederror.md b/docs/models/fieldgettemplatefieldunauthorizederror.md new file mode 100644 index 0000000..b2b4f95 --- /dev/null +++ b/docs/models/fieldgettemplatefieldunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldGetTemplateFieldUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldGetTemplateFieldUnauthorizedIssue](../models/fieldgettemplatefieldunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldunauthorizedissue.md b/docs/models/fieldgettemplatefieldunauthorizedissue.md new file mode 100644 index 0000000..b52b08b --- /dev/null +++ b/docs/models/fieldgettemplatefieldunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldGetTemplateFieldUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldverticalalign1.md b/docs/models/fieldgettemplatefieldverticalalign1.md new file mode 100644 index 0000000..a3a52d0 --- /dev/null +++ b/docs/models/fieldgettemplatefieldverticalalign1.md @@ -0,0 +1,10 @@ +# FieldGetTemplateFieldVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldgettemplatefieldverticalalign2.md b/docs/models/fieldgettemplatefieldverticalalign2.md new file mode 100644 index 0000000..289e190 --- /dev/null +++ b/docs/models/fieldgettemplatefieldverticalalign2.md @@ -0,0 +1,10 @@ +# FieldGetTemplateFieldVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldmetadocumentcheckbox.md b/docs/models/fieldmetadocumentcheckbox.md index ec72577..208f552 100644 --- a/docs/models/fieldmetadocumentcheckbox.md +++ b/docs/models/fieldmetadocumentcheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.DocumentDirection2]](../models/documentdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldmetadocumentdate.md b/docs/models/fieldmetadocumentdate.md index d3c4c69..b1da711 100644 --- a/docs/models/fieldmetadocumentdate.md +++ b/docs/models/fieldmetadocumentdate.md @@ -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.DocumentTypeDate](../models/documenttypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentTypeDate](../models/documenttypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.DocumentTextAlign4]](../models/documenttextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldmetadocumentdropdown.md b/docs/models/fieldmetadocumentdropdown.md index 7f1675f..fff5c70 100644 --- a/docs/models/fieldmetadocumentdropdown.md +++ b/docs/models/fieldmetadocumentdropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.DocumentTypeDropdown](../models/documenttypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.DocumentValue3](../models/documentvalue3.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/fieldmetadocumentemail.md b/docs/models/fieldmetadocumentemail.md index f023eb2..2aa9c36 100644 --- a/docs/models/fieldmetadocumentemail.md +++ b/docs/models/fieldmetadocumentemail.md @@ -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.DocumentTypeEmail](../models/documenttypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentTypeEmail](../models/documenttypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.DocumentTextAlign3]](../models/documenttextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldmetadocumentinitials.md b/docs/models/fieldmetadocumentinitials.md index a067a70..87b03fe 100644 --- a/docs/models/fieldmetadocumentinitials.md +++ b/docs/models/fieldmetadocumentinitials.md @@ -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.DocumentTypeInitials](../models/documenttypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentTypeInitials](../models/documenttypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.DocumentTextAlign1]](../models/documenttextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldmetadocumentname.md b/docs/models/fieldmetadocumentname.md index 7336b38..3f1a257 100644 --- a/docs/models/fieldmetadocumentname.md +++ b/docs/models/fieldmetadocumentname.md @@ -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.DocumentTypeName](../models/documenttypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentTypeName](../models/documenttypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.DocumentTextAlign2]](../models/documenttextalign2.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..6b04dca 100644 --- a/docs/models/fieldmetadocumentnumber.md +++ b/docs/models/fieldmetadocumentnumber.md @@ -3,16 +3,19 @@ ## 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.DocumentTypeNumber](../models/documenttypenumber.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.DocumentTextAlign6]](../models/documenttextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentTypeNumber](../models/documenttypenumber.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 | +| `text_align` | [Optional[models.DocumentTextAlign6]](../models/documenttextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.DocumentVerticalAlign2]](../models/documentverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldmetadocumentradio.md b/docs/models/fieldmetadocumentradio.md index 6759470..41883fd 100644 --- a/docs/models/fieldmetadocumentradio.md +++ b/docs/models/fieldmetadocumentradio.md @@ -3,11 +3,13 @@ ## 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.DocumentTypeRadio](../models/documenttyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.DocumentValue1](../models/documentvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentTypeRadio](../models/documenttyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.DocumentValue1](../models/documentvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.DocumentDirection1]](../models/documentdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldmetadocumentsignature.md b/docs/models/fieldmetadocumentsignature.md new file mode 100644 index 0000000..68484aa --- /dev/null +++ b/docs/models/fieldmetadocumentsignature.md @@ -0,0 +1,13 @@ +# FieldMetaDocumentSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentTypeSignature](../models/documenttypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldmetadocumenttext.md b/docs/models/fieldmetadocumenttext.md index 3601be3..630fa5d 100644 --- a/docs/models/fieldmetadocumenttext.md +++ b/docs/models/fieldmetadocumenttext.md @@ -3,14 +3,17 @@ ## 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.DocumentTypeText](../models/documenttypetext.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.DocumentTextAlign5]](../models/documenttextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.DocumentTypeText](../models/documenttypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.DocumentTextAlign5]](../models/documenttextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.DocumentVerticalAlign1]](../models/documentverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfielddirectioncheckbox.md b/docs/models/fieldupdatedocumentfielddirectioncheckbox.md new file mode 100644 index 0000000..197d4fe --- /dev/null +++ b/docs/models/fieldupdatedocumentfielddirectioncheckbox.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfielddirectionradio.md b/docs/models/fieldupdatedocumentfielddirectionradio.md new file mode 100644 index 0000000..9cc0a1f --- /dev/null +++ b/docs/models/fieldupdatedocumentfielddirectionradio.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfielddirectionresponse1.md b/docs/models/fieldupdatedocumentfielddirectionresponse1.md new file mode 100644 index 0000000..e681710 --- /dev/null +++ b/docs/models/fieldupdatedocumentfielddirectionresponse1.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldDirectionResponse1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfielddirectionresponse2.md b/docs/models/fieldupdatedocumentfielddirectionresponse2.md new file mode 100644 index 0000000..e553843 --- /dev/null +++ b/docs/models/fieldupdatedocumentfielddirectionresponse2.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldDirectionResponse2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldcheckbox.md b/docs/models/fieldupdatedocumentfieldfieldcheckbox.md index 7159e41..24fd7e7 100644 --- a/docs/models/fieldupdatedocumentfieldfieldcheckbox.md +++ b/docs/models/fieldupdatedocumentfieldfieldcheckbox.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldTypeCheckboxRequest1](../models/fieldupdatedocumentfieldtypecheckboxrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldFieldMetaCheckboxRequest]](../models/fieldupdatedocumentfieldfieldmetacheckboxrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfielddate.md b/docs/models/fieldupdatedocumentfieldfielddate.md index 693d64d..7a166cf 100644 --- a/docs/models/fieldupdatedocumentfieldfielddate.md +++ b/docs/models/fieldupdatedocumentfieldfielddate.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldTypeDateRequest1](../models/fieldupdatedocumentfieldtypedaterequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldFieldMetaDateRequest]](../models/fieldupdatedocumentfieldfieldmetadaterequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfielddropdown.md b/docs/models/fieldupdatedocumentfieldfielddropdown.md index b94b409..b3fc813 100644 --- a/docs/models/fieldupdatedocumentfieldfielddropdown.md +++ b/docs/models/fieldupdatedocumentfieldfielddropdown.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldTypeDropdownRequest1](../models/fieldupdatedocumentfieldtypedropdownrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldFieldMetaDropdownRequest]](../models/fieldupdatedocumentfieldfieldmetadropdownrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldemail.md b/docs/models/fieldupdatedocumentfieldfieldemail.md index 36796f2..a3e7752 100644 --- a/docs/models/fieldupdatedocumentfieldfieldemail.md +++ b/docs/models/fieldupdatedocumentfieldfieldemail.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldTypeEmailRequest1](../models/fieldupdatedocumentfieldtypeemailrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldFieldMetaEmailRequest]](../models/fieldupdatedocumentfieldfieldmetaemailrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldfreesignature.md b/docs/models/fieldupdatedocumentfieldfieldfreesignature.md index 3e123bf..95b5a8d 100644 --- a/docs/models/fieldupdatedocumentfieldfieldfreesignature.md +++ b/docs/models/fieldupdatedocumentfieldfieldfreesignature.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldTypeFreeSignature](../models/fieldupdatedocumentfieldtypefreesignature.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldinitials.md b/docs/models/fieldupdatedocumentfieldfieldinitials.md index 03aa216..0f2ca2b 100644 --- a/docs/models/fieldupdatedocumentfieldfieldinitials.md +++ b/docs/models/fieldupdatedocumentfieldfieldinitials.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldTypeInitialsRequest1](../models/fieldupdatedocumentfieldtypeinitialsrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldFieldMetaInitialsRequest]](../models/fieldupdatedocumentfieldfieldmetainitialsrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetacheckboxrequest.md b/docs/models/fieldupdatedocumentfieldfieldmetacheckboxrequest.md index 56c2b7c..8ab03f8 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetacheckboxrequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetacheckboxrequest.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldUpdateDocumentFieldDirectionCheckbox]](../models/fieldupdatedocumentfielddirectioncheckbox.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..0ef4a67 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetacheckboxresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetacheckboxresponse.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldUpdateDocumentFieldDirectionResponse2]](../models/fieldupdatedocumentfielddirectionresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetadaterequest.md b/docs/models/fieldupdatedocumentfieldfieldmetadaterequest.md index fe5da0c..2a054b5 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetadaterequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetadaterequest.md @@ -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.FieldUpdateDocumentFieldTypeDateRequest2](../models/fieldupdatedocumentfieldtypedaterequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldTypeDateRequest2](../models/fieldupdatedocumentfieldtypedaterequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignDate]](../models/fieldupdatedocumentfieldtextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetadateresponse.md b/docs/models/fieldupdatedocumentfieldfieldmetadateresponse.md index d016d5f..7b0fe96 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetadateresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetadateresponse.md @@ -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.FieldUpdateDocumentFieldFieldMetaTypeDate](../models/fieldupdatedocumentfieldfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeDate](../models/fieldupdatedocumentfieldfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignResponse4]](../models/fieldupdatedocumentfieldtextalignresponse4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetadropdownrequest.md b/docs/models/fieldupdatedocumentfieldfieldmetadropdownrequest.md index 6396d40..0ac74d8 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetadropdownrequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetadropdownrequest.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateDocumentFieldTypeDropdownRequest2](../models/fieldupdatedocumentfieldtypedropdownrequest2.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldUpdateDocumentFieldValueDropdown](../models/fieldupdatedocumentfieldvaluedropdown.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/fieldupdatedocumentfieldfieldmetadropdownresponse.md b/docs/models/fieldupdatedocumentfieldfieldmetadropdownresponse.md index ee27d08..2ae7320 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetadropdownresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetadropdownresponse.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeDropdown](../models/fieldupdatedocumentfieldfieldmetatypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldUpdateDocumentFieldValueResponse3](../models/fieldupdatedocumentfieldvalueresponse3.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/fieldupdatedocumentfieldfieldmetaemailrequest.md b/docs/models/fieldupdatedocumentfieldfieldmetaemailrequest.md index 03a4c4e..4db162c 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetaemailrequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetaemailrequest.md @@ -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.FieldUpdateDocumentFieldTypeEmailRequest2](../models/fieldupdatedocumentfieldtypeemailrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldTypeEmailRequest2](../models/fieldupdatedocumentfieldtypeemailrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignEmail]](../models/fieldupdatedocumentfieldtextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetaemailresponse.md b/docs/models/fieldupdatedocumentfieldfieldmetaemailresponse.md index d1e3e16..39b41fd 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetaemailresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetaemailresponse.md @@ -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.FieldUpdateDocumentFieldFieldMetaTypeEmail](../models/fieldupdatedocumentfieldfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeEmail](../models/fieldupdatedocumentfieldfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignResponse3]](../models/fieldupdatedocumentfieldtextalignresponse3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetainitialsrequest.md b/docs/models/fieldupdatedocumentfieldfieldmetainitialsrequest.md index ea70faf..d5062dd 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetainitialsrequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetainitialsrequest.md @@ -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.FieldUpdateDocumentFieldTypeInitialsRequest2](../models/fieldupdatedocumentfieldtypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldTypeInitialsRequest2](../models/fieldupdatedocumentfieldtypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignInitials]](../models/fieldupdatedocumentfieldtextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetainitialsresponse.md b/docs/models/fieldupdatedocumentfieldfieldmetainitialsresponse.md index 001c362..9272440 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetainitialsresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetainitialsresponse.md @@ -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.FieldUpdateDocumentFieldFieldMetaTypeInitials](../models/fieldupdatedocumentfieldfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeInitials](../models/fieldupdatedocumentfieldfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignResponse1]](../models/fieldupdatedocumentfieldtextalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetanamerequest.md b/docs/models/fieldupdatedocumentfieldfieldmetanamerequest.md index 121c665..73fd9a2 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetanamerequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetanamerequest.md @@ -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.FieldUpdateDocumentFieldTypeNameRequest2](../models/fieldupdatedocumentfieldtypenamerequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldTypeNameRequest2](../models/fieldupdatedocumentfieldtypenamerequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignName]](../models/fieldupdatedocumentfieldtextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetanameresponse.md b/docs/models/fieldupdatedocumentfieldfieldmetanameresponse.md index f2aa67b..3334f5e 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetanameresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetanameresponse.md @@ -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.FieldUpdateDocumentFieldFieldMetaTypeName](../models/fieldupdatedocumentfieldfieldmetatypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeName](../models/fieldupdatedocumentfieldfieldmetatypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignResponse2]](../models/fieldupdatedocumentfieldtextalignresponse2.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..71ef56c 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetanumberrequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetanumberrequest.md @@ -3,16 +3,19 @@ ## 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.FieldUpdateDocumentFieldTypeNumberRequest2](../models/fieldupdatedocumentfieldtypenumberrequest2.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.FieldUpdateDocumentFieldTextAlignNumber]](../models/fieldupdatedocumentfieldtextalignnumber.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldTypeNumberRequest2](../models/fieldupdatedocumentfieldtypenumberrequest2.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 | +| `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignNumber]](../models/fieldupdatedocumentfieldtextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateDocumentFieldVerticalAlignNumber]](../models/fieldupdatedocumentfieldverticalalignnumber.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..b560d04 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetanumberresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetanumberresponse.md @@ -3,16 +3,19 @@ ## 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.FieldUpdateDocumentFieldFieldMetaTypeNumber](../models/fieldupdatedocumentfieldfieldmetatypenumber.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.FieldUpdateDocumentFieldTextAlignResponse6]](../models/fieldupdatedocumentfieldtextalignresponse6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeNumber](../models/fieldupdatedocumentfieldfieldmetatypenumber.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 | +| `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignResponse6]](../models/fieldupdatedocumentfieldtextalignresponse6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateDocumentFieldVerticalAlignResponse2]](../models/fieldupdatedocumentfieldverticalalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetaradiorequest.md b/docs/models/fieldupdatedocumentfieldfieldmetaradiorequest.md index b185ac6..5c69be1 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetaradiorequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetaradiorequest.md @@ -3,11 +3,13 @@ ## 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.FieldUpdateDocumentFieldTypeRadioRequest2](../models/fieldupdatedocumentfieldtyperadiorequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateDocumentFieldValueRadio](../models/fieldupdatedocumentfieldvalueradio.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldTypeRadioRequest2](../models/fieldupdatedocumentfieldtyperadiorequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateDocumentFieldValueRadio](../models/fieldupdatedocumentfieldvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateDocumentFieldDirectionRadio]](../models/fieldupdatedocumentfielddirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetaradioresponse.md b/docs/models/fieldupdatedocumentfieldfieldmetaradioresponse.md index d5f1985..8e7c66a 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetaradioresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetaradioresponse.md @@ -3,11 +3,13 @@ ## 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.FieldUpdateDocumentFieldFieldMetaTypeRadio](../models/fieldupdatedocumentfieldfieldmetatyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateDocumentFieldValueResponse1](../models/fieldupdatedocumentfieldvalueresponse1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeRadio](../models/fieldupdatedocumentfieldfieldmetatyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateDocumentFieldValueResponse1](../models/fieldupdatedocumentfieldvalueresponse1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateDocumentFieldDirectionResponse1]](../models/fieldupdatedocumentfielddirectionresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetasignaturerequest.md b/docs/models/fieldupdatedocumentfieldfieldmetasignaturerequest.md new file mode 100644 index 0000000..17fb343 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldfieldmetasignaturerequest.md @@ -0,0 +1,13 @@ +# FieldUpdateDocumentFieldFieldMetaSignatureRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldTypeSignatureRequest2](../models/fieldupdatedocumentfieldtypesignaturerequest2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetasignatureresponse.md b/docs/models/fieldupdatedocumentfieldfieldmetasignatureresponse.md new file mode 100644 index 0000000..0f1b338 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldfieldmetasignatureresponse.md @@ -0,0 +1,13 @@ +# FieldUpdateDocumentFieldFieldMetaSignatureResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeSignature](../models/fieldupdatedocumentfieldfieldmetatypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetatextrequest.md b/docs/models/fieldupdatedocumentfieldfieldmetatextrequest.md index cf27525..f15a18b 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetatextrequest.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetatextrequest.md @@ -3,14 +3,17 @@ ## 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.FieldUpdateDocumentFieldTypeTextRequest2](../models/fieldupdatedocumentfieldtypetextrequest2.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.FieldUpdateDocumentFieldTextAlignText]](../models/fieldupdatedocumentfieldtextaligntext.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldTypeTextRequest2](../models/fieldupdatedocumentfieldtypetextrequest2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignText]](../models/fieldupdatedocumentfieldtextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateDocumentFieldVerticalAlignText]](../models/fieldupdatedocumentfieldverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetatextresponse.md b/docs/models/fieldupdatedocumentfieldfieldmetatextresponse.md index 4d292d3..f7bc861 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetatextresponse.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetatextresponse.md @@ -3,14 +3,17 @@ ## 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.FieldUpdateDocumentFieldFieldMetaTypeText](../models/fieldupdatedocumentfieldfieldmetatypetext.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.FieldUpdateDocumentFieldTextAlignResponse5]](../models/fieldupdatedocumentfieldtextalignresponse5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldFieldMetaTypeText](../models/fieldupdatedocumentfieldfieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldUpdateDocumentFieldTextAlignResponse5]](../models/fieldupdatedocumentfieldtextalignresponse5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateDocumentFieldVerticalAlignResponse1]](../models/fieldupdatedocumentfieldverticalalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetatypesignature.md b/docs/models/fieldupdatedocumentfieldfieldmetatypesignature.md new file mode 100644 index 0000000..5a34075 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldfieldmetatypesignature.md @@ -0,0 +1,8 @@ +# FieldUpdateDocumentFieldFieldMetaTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldmetaunion.md b/docs/models/fieldupdatedocumentfieldfieldmetaunion.md index a5fcf1c..7092e9f 100644 --- a/docs/models/fieldupdatedocumentfieldfieldmetaunion.md +++ b/docs/models/fieldupdatedocumentfieldfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldUpdateDocumentFieldFieldMetaSignatureResponse` + +```python +value: models.FieldUpdateDocumentFieldFieldMetaSignatureResponse = /* values here */ +``` + ### `models.FieldUpdateDocumentFieldFieldMetaInitialsResponse` ```python diff --git a/docs/models/fieldupdatedocumentfieldfieldname.md b/docs/models/fieldupdatedocumentfieldfieldname.md index 457a140..d168b24 100644 --- a/docs/models/fieldupdatedocumentfieldfieldname.md +++ b/docs/models/fieldupdatedocumentfieldfieldname.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldTypeNameRequest1](../models/fieldupdatedocumentfieldtypenamerequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldFieldMetaNameRequest]](../models/fieldupdatedocumentfieldfieldmetanamerequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldnumber.md b/docs/models/fieldupdatedocumentfieldfieldnumber.md index 8b26adf..186299c 100644 --- a/docs/models/fieldupdatedocumentfieldfieldnumber.md +++ b/docs/models/fieldupdatedocumentfieldfieldnumber.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateDocumentFieldTypeNumberRequest1](../models/fieldupdatedocumentfieldtypenumberrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldFieldMetaNumberRequest]](../models/fieldupdatedocumentfieldfieldmetanumberrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldradio.md b/docs/models/fieldupdatedocumentfieldfieldradio.md index b501d60..fd74e2f 100644 --- a/docs/models/fieldupdatedocumentfieldfieldradio.md +++ b/docs/models/fieldupdatedocumentfieldfieldradio.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldTypeRadioRequest1](../models/fieldupdatedocumentfieldtyperadiorequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldFieldMetaRadioRequest]](../models/fieldupdatedocumentfieldfieldmetaradiorequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldsignature.md b/docs/models/fieldupdatedocumentfieldfieldsignature.md index ebe1a5d..c7e2f08 100644 --- a/docs/models/fieldupdatedocumentfieldfieldsignature.md +++ b/docs/models/fieldupdatedocumentfieldfieldsignature.md @@ -3,12 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [models.FieldUpdateDocumentFieldTypeSignature](../models/fieldupdatedocumentfieldtypesignature.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.FieldUpdateDocumentFieldTypeSignatureRequest1](../models/fieldupdatedocumentfieldtypesignaturerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.FieldUpdateDocumentFieldFieldMetaSignatureRequest]](../models/fieldupdatedocumentfieldfieldmetasignaturerequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldfieldtext.md b/docs/models/fieldupdatedocumentfieldfieldtext.md index e7f6a33..2bec15d 100644 --- a/docs/models/fieldupdatedocumentfieldfieldtext.md +++ b/docs/models/fieldupdatedocumentfieldfieldtext.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldTypeTextRequest1](../models/fieldupdatedocumentfieldtypetextrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldFieldMetaTextRequest]](../models/fieldupdatedocumentfieldfieldmetatextrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldforbiddenerror.md b/docs/models/fieldupdatedocumentfieldforbiddenerror.md new file mode 100644 index 0000000..28dac4d --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldUpdateDocumentFieldForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldUpdateDocumentFieldForbiddenIssue](../models/fieldupdatedocumentfieldforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldforbiddenissue.md b/docs/models/fieldupdatedocumentfieldforbiddenissue.md new file mode 100644 index 0000000..f92c7af --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldUpdateDocumentFieldForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldresponse.md b/docs/models/fieldupdatedocumentfieldresponse.md index a866bdf..b984d34 100644 --- a/docs/models/fieldupdatedocumentfieldresponse.md +++ b/docs/models/fieldupdatedocumentfieldresponse.md @@ -7,17 +7,19 @@ 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/fieldupdatedocumentfieldsdirectioncheckbox.md b/docs/models/fieldupdatedocumentfieldsdirectioncheckbox.md new file mode 100644 index 0000000..d5cbcc6 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsdirectioncheckbox.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldsDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsdirectionradio.md b/docs/models/fieldupdatedocumentfieldsdirectionradio.md new file mode 100644 index 0000000..0934324 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsdirectionradio.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldsDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsdirectionresponse1.md b/docs/models/fieldupdatedocumentfieldsdirectionresponse1.md new file mode 100644 index 0000000..97ff8e2 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsdirectionresponse1.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldsDirectionResponse1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsdirectionresponse2.md b/docs/models/fieldupdatedocumentfieldsdirectionresponse2.md new file mode 100644 index 0000000..8500a21 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsdirectionresponse2.md @@ -0,0 +1,9 @@ +# FieldUpdateDocumentFieldsDirectionResponse2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldcheckbox.md b/docs/models/fieldupdatedocumentfieldsfieldcheckbox.md index 5e2dadd..8977df1 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldcheckbox.md +++ b/docs/models/fieldupdatedocumentfieldsfieldcheckbox.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateDocumentFieldsTypeCheckboxRequest1](../models/fieldupdatedocumentfieldstypecheckboxrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldsFieldMetaCheckboxRequest]](../models/fieldupdatedocumentfieldsfieldmetacheckboxrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfielddate.md b/docs/models/fieldupdatedocumentfieldsfielddate.md index 1ca3d28..aa634f6 100644 --- a/docs/models/fieldupdatedocumentfieldsfielddate.md +++ b/docs/models/fieldupdatedocumentfieldsfielddate.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldsTypeDateRequest1](../models/fieldupdatedocumentfieldstypedaterequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldsFieldMetaDateRequest]](../models/fieldupdatedocumentfieldsfieldmetadaterequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfielddropdown.md b/docs/models/fieldupdatedocumentfieldsfielddropdown.md index d615486..8e65ca2 100644 --- a/docs/models/fieldupdatedocumentfieldsfielddropdown.md +++ b/docs/models/fieldupdatedocumentfieldsfielddropdown.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateDocumentFieldsTypeDropdownRequest1](../models/fieldupdatedocumentfieldstypedropdownrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldsFieldMetaDropdownRequest]](../models/fieldupdatedocumentfieldsfieldmetadropdownrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldemail.md b/docs/models/fieldupdatedocumentfieldsfieldemail.md index fb2f608..1ad7c32 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldemail.md +++ b/docs/models/fieldupdatedocumentfieldsfieldemail.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateDocumentFieldsTypeEmailRequest1](../models/fieldupdatedocumentfieldstypeemailrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldsFieldMetaEmailRequest]](../models/fieldupdatedocumentfieldsfieldmetaemailrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldfreesignature.md b/docs/models/fieldupdatedocumentfieldsfieldfreesignature.md index 33e283d..a72117b 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldfreesignature.md +++ b/docs/models/fieldupdatedocumentfieldsfieldfreesignature.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateDocumentFieldsTypeFreeSignature](../models/fieldupdatedocumentfieldstypefreesignature.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldinitials.md b/docs/models/fieldupdatedocumentfieldsfieldinitials.md index ab8ca62..5254a3c 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldinitials.md +++ b/docs/models/fieldupdatedocumentfieldsfieldinitials.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateDocumentFieldsTypeInitialsRequest1](../models/fieldupdatedocumentfieldstypeinitialsrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldsFieldMetaInitialsRequest]](../models/fieldupdatedocumentfieldsfieldmetainitialsrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxrequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxrequest.md index 20da435..facf467 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxrequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxrequest.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldUpdateDocumentFieldsDirectionCheckbox]](../models/fieldupdatedocumentfieldsdirectioncheckbox.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..dd97ca1 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetacheckboxresponse.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldUpdateDocumentFieldsDirectionResponse2]](../models/fieldupdatedocumentfieldsdirectionresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetadaterequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetadaterequest.md index b855e1e..4b5a46c 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetadaterequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetadaterequest.md @@ -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.FieldUpdateDocumentFieldsTypeDateRequest2](../models/fieldupdatedocumentfieldstypedaterequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsTypeDateRequest2](../models/fieldupdatedocumentfieldstypedaterequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignDate]](../models/fieldupdatedocumentfieldstextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetadateresponse.md b/docs/models/fieldupdatedocumentfieldsfieldmetadateresponse.md index 298bfa8..b5c6ee0 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetadateresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetadateresponse.md @@ -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.FieldUpdateDocumentFieldsFieldMetaTypeDate](../models/fieldupdatedocumentfieldsfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeDate](../models/fieldupdatedocumentfieldsfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignResponse4]](../models/fieldupdatedocumentfieldstextalignresponse4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetadropdownrequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetadropdownrequest.md index dbe0025..f4042f0 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetadropdownrequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetadropdownrequest.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateDocumentFieldsTypeDropdownRequest2](../models/fieldupdatedocumentfieldstypedropdownrequest2.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldUpdateDocumentFieldsValueDropdown](../models/fieldupdatedocumentfieldsvaluedropdown.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/fieldupdatedocumentfieldsfieldmetadropdownresponse.md b/docs/models/fieldupdatedocumentfieldsfieldmetadropdownresponse.md index 5cc1519..da08f14 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetadropdownresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetadropdownresponse.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeDropdown](../models/fieldupdatedocumentfieldsfieldmetatypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldUpdateDocumentFieldsValueResponse3](../models/fieldupdatedocumentfieldsvalueresponse3.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/fieldupdatedocumentfieldsfieldmetaemailrequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetaemailrequest.md index 1531091..9a5c59d 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetaemailrequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetaemailrequest.md @@ -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.FieldUpdateDocumentFieldsTypeEmailRequest2](../models/fieldupdatedocumentfieldstypeemailrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsTypeEmailRequest2](../models/fieldupdatedocumentfieldstypeemailrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignEmail]](../models/fieldupdatedocumentfieldstextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetaemailresponse.md b/docs/models/fieldupdatedocumentfieldsfieldmetaemailresponse.md index 376f99c..22c64d3 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetaemailresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetaemailresponse.md @@ -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.FieldUpdateDocumentFieldsFieldMetaTypeEmail](../models/fieldupdatedocumentfieldsfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeEmail](../models/fieldupdatedocumentfieldsfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignResponse3]](../models/fieldupdatedocumentfieldstextalignresponse3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetainitialsrequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetainitialsrequest.md index 11850bb..168c342 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetainitialsrequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetainitialsrequest.md @@ -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.FieldUpdateDocumentFieldsTypeInitialsRequest2](../models/fieldupdatedocumentfieldstypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsTypeInitialsRequest2](../models/fieldupdatedocumentfieldstypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignInitials]](../models/fieldupdatedocumentfieldstextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetainitialsresponse.md b/docs/models/fieldupdatedocumentfieldsfieldmetainitialsresponse.md index 407f1d5..cb6af39 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetainitialsresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetainitialsresponse.md @@ -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.FieldUpdateDocumentFieldsFieldMetaTypeInitials](../models/fieldupdatedocumentfieldsfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeInitials](../models/fieldupdatedocumentfieldsfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignResponse1]](../models/fieldupdatedocumentfieldstextalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetanamerequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetanamerequest.md index e058384..7e2361e 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetanamerequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetanamerequest.md @@ -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.FieldUpdateDocumentFieldsTypeNameRequest2](../models/fieldupdatedocumentfieldstypenamerequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsTypeNameRequest2](../models/fieldupdatedocumentfieldstypenamerequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignName]](../models/fieldupdatedocumentfieldstextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetanameresponse.md b/docs/models/fieldupdatedocumentfieldsfieldmetanameresponse.md index bc31d43..65b351d 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetanameresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetanameresponse.md @@ -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.FieldUpdateDocumentFieldsFieldMetaTypeName](../models/fieldupdatedocumentfieldsfieldmetatypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeName](../models/fieldupdatedocumentfieldsfieldmetatypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignResponse2]](../models/fieldupdatedocumentfieldstextalignresponse2.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..63f87e0 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetanumberrequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetanumberrequest.md @@ -3,16 +3,19 @@ ## 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.FieldUpdateDocumentFieldsTypeNumberRequest2](../models/fieldupdatedocumentfieldstypenumberrequest2.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.FieldUpdateDocumentFieldsTextAlignNumber]](../models/fieldupdatedocumentfieldstextalignnumber.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsTypeNumberRequest2](../models/fieldupdatedocumentfieldstypenumberrequest2.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 | +| `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignNumber]](../models/fieldupdatedocumentfieldstextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateDocumentFieldsVerticalAlignNumber]](../models/fieldupdatedocumentfieldsverticalalignnumber.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..3b2a432 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetanumberresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetanumberresponse.md @@ -3,16 +3,19 @@ ## 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.FieldUpdateDocumentFieldsFieldMetaTypeNumber](../models/fieldupdatedocumentfieldsfieldmetatypenumber.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.FieldUpdateDocumentFieldsTextAlignResponse6]](../models/fieldupdatedocumentfieldstextalignresponse6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeNumber](../models/fieldupdatedocumentfieldsfieldmetatypenumber.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 | +| `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignResponse6]](../models/fieldupdatedocumentfieldstextalignresponse6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateDocumentFieldsVerticalAlignResponse2]](../models/fieldupdatedocumentfieldsverticalalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetaradiorequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetaradiorequest.md index b2c3727..4bd91e3 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetaradiorequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetaradiorequest.md @@ -3,11 +3,13 @@ ## 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.FieldUpdateDocumentFieldsTypeRadioRequest2](../models/fieldupdatedocumentfieldstyperadiorequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateDocumentFieldsValueRadio](../models/fieldupdatedocumentfieldsvalueradio.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsTypeRadioRequest2](../models/fieldupdatedocumentfieldstyperadiorequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateDocumentFieldsValueRadio](../models/fieldupdatedocumentfieldsvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateDocumentFieldsDirectionRadio]](../models/fieldupdatedocumentfieldsdirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetaradioresponse.md b/docs/models/fieldupdatedocumentfieldsfieldmetaradioresponse.md index ef9e553..a04ac52 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetaradioresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetaradioresponse.md @@ -3,11 +3,13 @@ ## 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.FieldUpdateDocumentFieldsFieldMetaTypeRadio](../models/fieldupdatedocumentfieldsfieldmetatyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateDocumentFieldsValueResponse1](../models/fieldupdatedocumentfieldsvalueresponse1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeRadio](../models/fieldupdatedocumentfieldsfieldmetatyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateDocumentFieldsValueResponse1](../models/fieldupdatedocumentfieldsvalueresponse1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateDocumentFieldsDirectionResponse1]](../models/fieldupdatedocumentfieldsdirectionresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetasignaturerequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetasignaturerequest.md new file mode 100644 index 0000000..0a12908 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsfieldmetasignaturerequest.md @@ -0,0 +1,13 @@ +# FieldUpdateDocumentFieldsFieldMetaSignatureRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsTypeSignatureRequest2](../models/fieldupdatedocumentfieldstypesignaturerequest2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetasignatureresponse.md b/docs/models/fieldupdatedocumentfieldsfieldmetasignatureresponse.md new file mode 100644 index 0000000..7c9fb64 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsfieldmetasignatureresponse.md @@ -0,0 +1,13 @@ +# FieldUpdateDocumentFieldsFieldMetaSignatureResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeSignature](../models/fieldupdatedocumentfieldsfieldmetatypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetatextrequest.md b/docs/models/fieldupdatedocumentfieldsfieldmetatextrequest.md index e5f587b..b101005 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetatextrequest.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetatextrequest.md @@ -3,14 +3,17 @@ ## 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.FieldUpdateDocumentFieldsTypeTextRequest2](../models/fieldupdatedocumentfieldstypetextrequest2.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.FieldUpdateDocumentFieldsTextAlignText]](../models/fieldupdatedocumentfieldstextaligntext.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsTypeTextRequest2](../models/fieldupdatedocumentfieldstypetextrequest2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignText]](../models/fieldupdatedocumentfieldstextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateDocumentFieldsVerticalAlignText]](../models/fieldupdatedocumentfieldsverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetatextresponse.md b/docs/models/fieldupdatedocumentfieldsfieldmetatextresponse.md index 1113e63..8b992e1 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetatextresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetatextresponse.md @@ -3,14 +3,17 @@ ## 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.FieldUpdateDocumentFieldsFieldMetaTypeText](../models/fieldupdatedocumentfieldsfieldmetatypetext.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.FieldUpdateDocumentFieldsTextAlignResponse5]](../models/fieldupdatedocumentfieldstextalignresponse5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateDocumentFieldsFieldMetaTypeText](../models/fieldupdatedocumentfieldsfieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldUpdateDocumentFieldsTextAlignResponse5]](../models/fieldupdatedocumentfieldstextalignresponse5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateDocumentFieldsVerticalAlignResponse1]](../models/fieldupdatedocumentfieldsverticalalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetatypesignature.md b/docs/models/fieldupdatedocumentfieldsfieldmetatypesignature.md new file mode 100644 index 0000000..567a728 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsfieldmetatypesignature.md @@ -0,0 +1,8 @@ +# FieldUpdateDocumentFieldsFieldMetaTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldmetaunion.md b/docs/models/fieldupdatedocumentfieldsfieldmetaunion.md index 19bd4b6..8a7862c 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldmetaunion.md +++ b/docs/models/fieldupdatedocumentfieldsfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldUpdateDocumentFieldsFieldMetaSignatureResponse` + +```python +value: models.FieldUpdateDocumentFieldsFieldMetaSignatureResponse = /* values here */ +``` + ### `models.FieldUpdateDocumentFieldsFieldMetaInitialsResponse` ```python diff --git a/docs/models/fieldupdatedocumentfieldsfieldname.md b/docs/models/fieldupdatedocumentfieldsfieldname.md index 64c568a..229a33d 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldname.md +++ b/docs/models/fieldupdatedocumentfieldsfieldname.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldsTypeNameRequest1](../models/fieldupdatedocumentfieldstypenamerequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldsFieldMetaNameRequest]](../models/fieldupdatedocumentfieldsfieldmetanamerequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldnumber.md b/docs/models/fieldupdatedocumentfieldsfieldnumber.md index fe3c426..ca05abe 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldnumber.md +++ b/docs/models/fieldupdatedocumentfieldsfieldnumber.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldsTypeNumberRequest1](../models/fieldupdatedocumentfieldstypenumberrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldsFieldMetaNumberRequest]](../models/fieldupdatedocumentfieldsfieldmetanumberrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldradio.md b/docs/models/fieldupdatedocumentfieldsfieldradio.md index 9097c16..c40fa00 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldradio.md +++ b/docs/models/fieldupdatedocumentfieldsfieldradio.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateDocumentFieldsTypeRadioRequest1](../models/fieldupdatedocumentfieldstyperadiorequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldsFieldMetaRadioRequest]](../models/fieldupdatedocumentfieldsfieldmetaradiorequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :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..a5c5182 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldresponse.md +++ b/docs/models/fieldupdatedocumentfieldsfieldresponse.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/fieldupdatedocumentfieldsfieldsignature.md b/docs/models/fieldupdatedocumentfieldsfieldsignature.md index 4449c2e..2acbe3f 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldsignature.md +++ b/docs/models/fieldupdatedocumentfieldsfieldsignature.md @@ -3,12 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `type` | [models.FieldUpdateDocumentFieldsTypeSignature](../models/fieldupdatedocumentfieldstypesignature.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.FieldUpdateDocumentFieldsTypeSignatureRequest1](../models/fieldupdatedocumentfieldstypesignaturerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.FieldUpdateDocumentFieldsFieldMetaSignatureRequest]](../models/fieldupdatedocumentfieldsfieldmetasignaturerequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsfieldtext.md b/docs/models/fieldupdatedocumentfieldsfieldtext.md index 56d90fd..8520a92 100644 --- a/docs/models/fieldupdatedocumentfieldsfieldtext.md +++ b/docs/models/fieldupdatedocumentfieldsfieldtext.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateDocumentFieldsTypeTextRequest1](../models/fieldupdatedocumentfieldstypetextrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateDocumentFieldsFieldMetaTextRequest]](../models/fieldupdatedocumentfieldsfieldmetatextrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsforbiddenerror.md b/docs/models/fieldupdatedocumentfieldsforbiddenerror.md new file mode 100644 index 0000000..c397487 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldUpdateDocumentFieldsForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldUpdateDocumentFieldsForbiddenIssue](../models/fieldupdatedocumentfieldsforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsforbiddenissue.md b/docs/models/fieldupdatedocumentfieldsforbiddenissue.md new file mode 100644 index 0000000..42c4749 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldUpdateDocumentFieldsForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldstypesignature.md b/docs/models/fieldupdatedocumentfieldstypesignature.md deleted file mode 100644 index bf69c08..0000000 --- a/docs/models/fieldupdatedocumentfieldstypesignature.md +++ /dev/null @@ -1,8 +0,0 @@ -# FieldUpdateDocumentFieldsTypeSignature - - -## Values - -| Name | Value | -| ----------- | ----------- | -| `SIGNATURE` | SIGNATURE | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldstypesignaturerequest1.md b/docs/models/fieldupdatedocumentfieldstypesignaturerequest1.md new file mode 100644 index 0000000..6546424 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldstypesignaturerequest1.md @@ -0,0 +1,8 @@ +# FieldUpdateDocumentFieldsTypeSignatureRequest1 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | SIGNATURE | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldstypesignaturerequest2.md b/docs/models/fieldupdatedocumentfieldstypesignaturerequest2.md new file mode 100644 index 0000000..a622128 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldstypesignaturerequest2.md @@ -0,0 +1,8 @@ +# FieldUpdateDocumentFieldsTypeSignatureRequest2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsunauthorizederror.md b/docs/models/fieldupdatedocumentfieldsunauthorizederror.md new file mode 100644 index 0000000..10797a5 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldUpdateDocumentFieldsUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldUpdateDocumentFieldsUnauthorizedIssue](../models/fieldupdatedocumentfieldsunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsunauthorizedissue.md b/docs/models/fieldupdatedocumentfieldsunauthorizedissue.md new file mode 100644 index 0000000..1a6fd6c --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldUpdateDocumentFieldsUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsverticalalignnumber.md b/docs/models/fieldupdatedocumentfieldsverticalalignnumber.md new file mode 100644 index 0000000..858630a --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsverticalalignnumber.md @@ -0,0 +1,10 @@ +# FieldUpdateDocumentFieldsVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsverticalalignresponse1.md b/docs/models/fieldupdatedocumentfieldsverticalalignresponse1.md new file mode 100644 index 0000000..933b94b --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsverticalalignresponse1.md @@ -0,0 +1,10 @@ +# FieldUpdateDocumentFieldsVerticalAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsverticalalignresponse2.md b/docs/models/fieldupdatedocumentfieldsverticalalignresponse2.md new file mode 100644 index 0000000..293a3bd --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsverticalalignresponse2.md @@ -0,0 +1,10 @@ +# FieldUpdateDocumentFieldsVerticalAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldsverticalaligntext.md b/docs/models/fieldupdatedocumentfieldsverticalaligntext.md new file mode 100644 index 0000000..97b261b --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldsverticalaligntext.md @@ -0,0 +1,10 @@ +# FieldUpdateDocumentFieldsVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldtypesignaturerequest1.md b/docs/models/fieldupdatedocumentfieldtypesignaturerequest1.md new file mode 100644 index 0000000..5b3e767 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldtypesignaturerequest1.md @@ -0,0 +1,8 @@ +# FieldUpdateDocumentFieldTypeSignatureRequest1 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | SIGNATURE | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldtypesignaturerequest2.md b/docs/models/fieldupdatedocumentfieldtypesignaturerequest2.md new file mode 100644 index 0000000..1797de4 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldtypesignaturerequest2.md @@ -0,0 +1,8 @@ +# FieldUpdateDocumentFieldTypeSignatureRequest2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldunauthorizederror.md b/docs/models/fieldupdatedocumentfieldunauthorizederror.md new file mode 100644 index 0000000..324a2d7 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldUpdateDocumentFieldUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldUpdateDocumentFieldUnauthorizedIssue](../models/fieldupdatedocumentfieldunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldunauthorizedissue.md b/docs/models/fieldupdatedocumentfieldunauthorizedissue.md new file mode 100644 index 0000000..fa774c4 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldUpdateDocumentFieldUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldverticalalignnumber.md b/docs/models/fieldupdatedocumentfieldverticalalignnumber.md new file mode 100644 index 0000000..8217df8 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldverticalalignnumber.md @@ -0,0 +1,10 @@ +# FieldUpdateDocumentFieldVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldverticalalignresponse1.md b/docs/models/fieldupdatedocumentfieldverticalalignresponse1.md new file mode 100644 index 0000000..b482400 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldverticalalignresponse1.md @@ -0,0 +1,10 @@ +# FieldUpdateDocumentFieldVerticalAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldverticalalignresponse2.md b/docs/models/fieldupdatedocumentfieldverticalalignresponse2.md new file mode 100644 index 0000000..e6d09b1 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldverticalalignresponse2.md @@ -0,0 +1,10 @@ +# FieldUpdateDocumentFieldVerticalAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatedocumentfieldverticalaligntext.md b/docs/models/fieldupdatedocumentfieldverticalaligntext.md new file mode 100644 index 0000000..69a9d86 --- /dev/null +++ b/docs/models/fieldupdatedocumentfieldverticalaligntext.md @@ -0,0 +1,10 @@ +# FieldUpdateDocumentFieldVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefielddirectioncheckbox.md b/docs/models/fieldupdatetemplatefielddirectioncheckbox.md new file mode 100644 index 0000000..e0f6409 --- /dev/null +++ b/docs/models/fieldupdatetemplatefielddirectioncheckbox.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefielddirectionradio.md b/docs/models/fieldupdatetemplatefielddirectionradio.md new file mode 100644 index 0000000..b63a1ca --- /dev/null +++ b/docs/models/fieldupdatetemplatefielddirectionradio.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefielddirectionresponse1.md b/docs/models/fieldupdatetemplatefielddirectionresponse1.md new file mode 100644 index 0000000..43b2cbe --- /dev/null +++ b/docs/models/fieldupdatetemplatefielddirectionresponse1.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldDirectionResponse1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefielddirectionresponse2.md b/docs/models/fieldupdatetemplatefielddirectionresponse2.md new file mode 100644 index 0000000..9945c04 --- /dev/null +++ b/docs/models/fieldupdatetemplatefielddirectionresponse2.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldDirectionResponse2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldcheckbox.md b/docs/models/fieldupdatetemplatefieldfieldcheckbox.md index bcd2ccd..1379654 100644 --- a/docs/models/fieldupdatetemplatefieldfieldcheckbox.md +++ b/docs/models/fieldupdatetemplatefieldfieldcheckbox.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldTypeCheckboxRequest1](../models/fieldupdatetemplatefieldtypecheckboxrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldFieldMetaCheckboxRequest]](../models/fieldupdatetemplatefieldfieldmetacheckboxrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfielddate.md b/docs/models/fieldupdatetemplatefieldfielddate.md index 54aa29a..c7b0a82 100644 --- a/docs/models/fieldupdatetemplatefieldfielddate.md +++ b/docs/models/fieldupdatetemplatefieldfielddate.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldTypeDateRequest1](../models/fieldupdatetemplatefieldtypedaterequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldFieldMetaDateRequest]](../models/fieldupdatetemplatefieldfieldmetadaterequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfielddropdown.md b/docs/models/fieldupdatetemplatefieldfielddropdown.md index e5749e7..85f8ead 100644 --- a/docs/models/fieldupdatetemplatefieldfielddropdown.md +++ b/docs/models/fieldupdatetemplatefieldfielddropdown.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldTypeDropdownRequest1](../models/fieldupdatetemplatefieldtypedropdownrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldFieldMetaDropdownRequest]](../models/fieldupdatetemplatefieldfieldmetadropdownrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldemail.md b/docs/models/fieldupdatetemplatefieldfieldemail.md index c48f57c..738d9e2 100644 --- a/docs/models/fieldupdatetemplatefieldfieldemail.md +++ b/docs/models/fieldupdatetemplatefieldfieldemail.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldTypeEmailRequest1](../models/fieldupdatetemplatefieldtypeemailrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldFieldMetaEmailRequest]](../models/fieldupdatetemplatefieldfieldmetaemailrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldfreesignature.md b/docs/models/fieldupdatetemplatefieldfieldfreesignature.md index 36e7368..3334b74 100644 --- a/docs/models/fieldupdatetemplatefieldfieldfreesignature.md +++ b/docs/models/fieldupdatetemplatefieldfieldfreesignature.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldTypeFreeSignature](../models/fieldupdatetemplatefieldtypefreesignature.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldinitials.md b/docs/models/fieldupdatetemplatefieldfieldinitials.md index 7d924b1..f3722e9 100644 --- a/docs/models/fieldupdatetemplatefieldfieldinitials.md +++ b/docs/models/fieldupdatetemplatefieldfieldinitials.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldTypeInitialsRequest1](../models/fieldupdatetemplatefieldtypeinitialsrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldFieldMetaInitialsRequest]](../models/fieldupdatetemplatefieldfieldmetainitialsrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetacheckboxrequest.md b/docs/models/fieldupdatetemplatefieldfieldmetacheckboxrequest.md index 9e9a4bd..655f521 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetacheckboxrequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetacheckboxrequest.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldUpdateTemplateFieldDirectionCheckbox]](../models/fieldupdatetemplatefielddirectioncheckbox.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..422e398 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetacheckboxresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetacheckboxresponse.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldUpdateTemplateFieldDirectionResponse2]](../models/fieldupdatetemplatefielddirectionresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetadaterequest.md b/docs/models/fieldupdatetemplatefieldfieldmetadaterequest.md index 4d72ce5..d555744 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetadaterequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetadaterequest.md @@ -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.FieldUpdateTemplateFieldTypeDateRequest2](../models/fieldupdatetemplatefieldtypedaterequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldTypeDateRequest2](../models/fieldupdatetemplatefieldtypedaterequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignDate]](../models/fieldupdatetemplatefieldtextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetadateresponse.md b/docs/models/fieldupdatetemplatefieldfieldmetadateresponse.md index 3ecf48e..e5c8adc 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetadateresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetadateresponse.md @@ -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.FieldUpdateTemplateFieldFieldMetaTypeDate](../models/fieldupdatetemplatefieldfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeDate](../models/fieldupdatetemplatefieldfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignResponse4]](../models/fieldupdatetemplatefieldtextalignresponse4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetadropdownrequest.md b/docs/models/fieldupdatetemplatefieldfieldmetadropdownrequest.md index d240cd2..3d81a19 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetadropdownrequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetadropdownrequest.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateTemplateFieldTypeDropdownRequest2](../models/fieldupdatetemplatefieldtypedropdownrequest2.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldUpdateTemplateFieldValueDropdown](../models/fieldupdatetemplatefieldvaluedropdown.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/fieldupdatetemplatefieldfieldmetadropdownresponse.md b/docs/models/fieldupdatetemplatefieldfieldmetadropdownresponse.md index 9f95a8d..fb16511 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetadropdownresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetadropdownresponse.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeDropdown](../models/fieldupdatetemplatefieldfieldmetatypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldUpdateTemplateFieldValueResponse3](../models/fieldupdatetemplatefieldvalueresponse3.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/fieldupdatetemplatefieldfieldmetaemailrequest.md b/docs/models/fieldupdatetemplatefieldfieldmetaemailrequest.md index e0be313..4d0a988 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetaemailrequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetaemailrequest.md @@ -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.FieldUpdateTemplateFieldTypeEmailRequest2](../models/fieldupdatetemplatefieldtypeemailrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldTypeEmailRequest2](../models/fieldupdatetemplatefieldtypeemailrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignEmail]](../models/fieldupdatetemplatefieldtextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetaemailresponse.md b/docs/models/fieldupdatetemplatefieldfieldmetaemailresponse.md index 39a5974..f1f04eb 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetaemailresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetaemailresponse.md @@ -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.FieldUpdateTemplateFieldFieldMetaTypeEmail](../models/fieldupdatetemplatefieldfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeEmail](../models/fieldupdatetemplatefieldfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignResponse3]](../models/fieldupdatetemplatefieldtextalignresponse3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetainitialsrequest.md b/docs/models/fieldupdatetemplatefieldfieldmetainitialsrequest.md index e9288dd..c0776e1 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetainitialsrequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetainitialsrequest.md @@ -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.FieldUpdateTemplateFieldTypeInitialsRequest2](../models/fieldupdatetemplatefieldtypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldTypeInitialsRequest2](../models/fieldupdatetemplatefieldtypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignInitials]](../models/fieldupdatetemplatefieldtextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetainitialsresponse.md b/docs/models/fieldupdatetemplatefieldfieldmetainitialsresponse.md index ab27a5d..66af10f 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetainitialsresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetainitialsresponse.md @@ -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.FieldUpdateTemplateFieldFieldMetaTypeInitials](../models/fieldupdatetemplatefieldfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeInitials](../models/fieldupdatetemplatefieldfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignResponse1]](../models/fieldupdatetemplatefieldtextalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetanamerequest.md b/docs/models/fieldupdatetemplatefieldfieldmetanamerequest.md index 6240f63..0883fa5 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetanamerequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetanamerequest.md @@ -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.FieldUpdateTemplateFieldTypeNameRequest2](../models/fieldupdatetemplatefieldtypenamerequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldTypeNameRequest2](../models/fieldupdatetemplatefieldtypenamerequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignName]](../models/fieldupdatetemplatefieldtextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetanameresponse.md b/docs/models/fieldupdatetemplatefieldfieldmetanameresponse.md index 00322a9..1c54626 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetanameresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetanameresponse.md @@ -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.FieldUpdateTemplateFieldFieldMetaTypeName](../models/fieldupdatetemplatefieldfieldmetatypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeName](../models/fieldupdatetemplatefieldfieldmetatypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignResponse2]](../models/fieldupdatetemplatefieldtextalignresponse2.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..5713a0a 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetanumberrequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetanumberrequest.md @@ -3,16 +3,19 @@ ## 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.FieldUpdateTemplateFieldTypeNumberRequest2](../models/fieldupdatetemplatefieldtypenumberrequest2.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.FieldUpdateTemplateFieldTextAlignNumber]](../models/fieldupdatetemplatefieldtextalignnumber.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldTypeNumberRequest2](../models/fieldupdatetemplatefieldtypenumberrequest2.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 | +| `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignNumber]](../models/fieldupdatetemplatefieldtextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateTemplateFieldVerticalAlignNumber]](../models/fieldupdatetemplatefieldverticalalignnumber.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..72420d3 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetanumberresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetanumberresponse.md @@ -3,16 +3,19 @@ ## 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.FieldUpdateTemplateFieldFieldMetaTypeNumber](../models/fieldupdatetemplatefieldfieldmetatypenumber.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.FieldUpdateTemplateFieldTextAlignResponse6]](../models/fieldupdatetemplatefieldtextalignresponse6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeNumber](../models/fieldupdatetemplatefieldfieldmetatypenumber.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 | +| `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignResponse6]](../models/fieldupdatetemplatefieldtextalignresponse6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateTemplateFieldVerticalAlignResponse2]](../models/fieldupdatetemplatefieldverticalalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetaradiorequest.md b/docs/models/fieldupdatetemplatefieldfieldmetaradiorequest.md index 9a2bab2..e0ca3df 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetaradiorequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetaradiorequest.md @@ -3,11 +3,13 @@ ## 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.FieldUpdateTemplateFieldTypeRadioRequest2](../models/fieldupdatetemplatefieldtyperadiorequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateTemplateFieldValueRadio](../models/fieldupdatetemplatefieldvalueradio.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldTypeRadioRequest2](../models/fieldupdatetemplatefieldtyperadiorequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateTemplateFieldValueRadio](../models/fieldupdatetemplatefieldvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateTemplateFieldDirectionRadio]](../models/fieldupdatetemplatefielddirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetaradioresponse.md b/docs/models/fieldupdatetemplatefieldfieldmetaradioresponse.md index b3b748c..e5916b4 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetaradioresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetaradioresponse.md @@ -3,11 +3,13 @@ ## 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.FieldUpdateTemplateFieldFieldMetaTypeRadio](../models/fieldupdatetemplatefieldfieldmetatyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateTemplateFieldValueResponse1](../models/fieldupdatetemplatefieldvalueresponse1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeRadio](../models/fieldupdatetemplatefieldfieldmetatyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateTemplateFieldValueResponse1](../models/fieldupdatetemplatefieldvalueresponse1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateTemplateFieldDirectionResponse1]](../models/fieldupdatetemplatefielddirectionresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetasignaturerequest.md b/docs/models/fieldupdatetemplatefieldfieldmetasignaturerequest.md new file mode 100644 index 0000000..c45643e --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldfieldmetasignaturerequest.md @@ -0,0 +1,13 @@ +# FieldUpdateTemplateFieldFieldMetaSignatureRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldTypeSignatureRequest2](../models/fieldupdatetemplatefieldtypesignaturerequest2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetasignatureresponse.md b/docs/models/fieldupdatetemplatefieldfieldmetasignatureresponse.md new file mode 100644 index 0000000..db293af --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldfieldmetasignatureresponse.md @@ -0,0 +1,13 @@ +# FieldUpdateTemplateFieldFieldMetaSignatureResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeSignature](../models/fieldupdatetemplatefieldfieldmetatypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetatextrequest.md b/docs/models/fieldupdatetemplatefieldfieldmetatextrequest.md index 3f1b9ae..dc9750f 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetatextrequest.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetatextrequest.md @@ -3,14 +3,17 @@ ## 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.FieldUpdateTemplateFieldTypeTextRequest2](../models/fieldupdatetemplatefieldtypetextrequest2.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.FieldUpdateTemplateFieldTextAlignText]](../models/fieldupdatetemplatefieldtextaligntext.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldTypeTextRequest2](../models/fieldupdatetemplatefieldtypetextrequest2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignText]](../models/fieldupdatetemplatefieldtextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateTemplateFieldVerticalAlignText]](../models/fieldupdatetemplatefieldverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetatextresponse.md b/docs/models/fieldupdatetemplatefieldfieldmetatextresponse.md index 6d8c058..32e5a45 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetatextresponse.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetatextresponse.md @@ -3,14 +3,17 @@ ## 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.FieldUpdateTemplateFieldFieldMetaTypeText](../models/fieldupdatetemplatefieldfieldmetatypetext.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.FieldUpdateTemplateFieldTextAlignResponse5]](../models/fieldupdatetemplatefieldtextalignresponse5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldFieldMetaTypeText](../models/fieldupdatetemplatefieldfieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldUpdateTemplateFieldTextAlignResponse5]](../models/fieldupdatetemplatefieldtextalignresponse5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateTemplateFieldVerticalAlignResponse1]](../models/fieldupdatetemplatefieldverticalalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetatypesignature.md b/docs/models/fieldupdatetemplatefieldfieldmetatypesignature.md new file mode 100644 index 0000000..b306fb8 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldfieldmetatypesignature.md @@ -0,0 +1,8 @@ +# FieldUpdateTemplateFieldFieldMetaTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldmetaunion.md b/docs/models/fieldupdatetemplatefieldfieldmetaunion.md index acc5f2b..199d453 100644 --- a/docs/models/fieldupdatetemplatefieldfieldmetaunion.md +++ b/docs/models/fieldupdatetemplatefieldfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldUpdateTemplateFieldFieldMetaSignatureResponse` + +```python +value: models.FieldUpdateTemplateFieldFieldMetaSignatureResponse = /* values here */ +``` + ### `models.FieldUpdateTemplateFieldFieldMetaInitialsResponse` ```python diff --git a/docs/models/fieldupdatetemplatefieldfieldname.md b/docs/models/fieldupdatetemplatefieldfieldname.md index 641e8b4..d8e2591 100644 --- a/docs/models/fieldupdatetemplatefieldfieldname.md +++ b/docs/models/fieldupdatetemplatefieldfieldname.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldTypeNameRequest1](../models/fieldupdatetemplatefieldtypenamerequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldFieldMetaNameRequest]](../models/fieldupdatetemplatefieldfieldmetanamerequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldnumber.md b/docs/models/fieldupdatetemplatefieldfieldnumber.md index 0523d86..bb9ae4e 100644 --- a/docs/models/fieldupdatetemplatefieldfieldnumber.md +++ b/docs/models/fieldupdatetemplatefieldfieldnumber.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateTemplateFieldTypeNumberRequest1](../models/fieldupdatetemplatefieldtypenumberrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldFieldMetaNumberRequest]](../models/fieldupdatetemplatefieldfieldmetanumberrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldradio.md b/docs/models/fieldupdatetemplatefieldfieldradio.md index 4aeec3f..b3d9153 100644 --- a/docs/models/fieldupdatetemplatefieldfieldradio.md +++ b/docs/models/fieldupdatetemplatefieldfieldradio.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldTypeRadioRequest1](../models/fieldupdatetemplatefieldtyperadiorequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldFieldMetaRadioRequest]](../models/fieldupdatetemplatefieldfieldmetaradiorequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldsignature.md b/docs/models/fieldupdatetemplatefieldfieldsignature.md index 618da72..0155452 100644 --- a/docs/models/fieldupdatetemplatefieldfieldsignature.md +++ b/docs/models/fieldupdatetemplatefieldfieldsignature.md @@ -3,12 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [models.FieldUpdateTemplateFieldTypeSignature](../models/fieldupdatetemplatefieldtypesignature.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.FieldUpdateTemplateFieldTypeSignatureRequest1](../models/fieldupdatetemplatefieldtypesignaturerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.FieldUpdateTemplateFieldFieldMetaSignatureRequest]](../models/fieldupdatetemplatefieldfieldmetasignaturerequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldfieldtext.md b/docs/models/fieldupdatetemplatefieldfieldtext.md index bdc842b..7ff4880 100644 --- a/docs/models/fieldupdatetemplatefieldfieldtext.md +++ b/docs/models/fieldupdatetemplatefieldfieldtext.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldTypeTextRequest1](../models/fieldupdatetemplatefieldtypetextrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldFieldMetaTextRequest]](../models/fieldupdatetemplatefieldfieldmetatextrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldforbiddenerror.md b/docs/models/fieldupdatetemplatefieldforbiddenerror.md new file mode 100644 index 0000000..b7a4aba --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldUpdateTemplateFieldForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldUpdateTemplateFieldForbiddenIssue](../models/fieldupdatetemplatefieldforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldforbiddenissue.md b/docs/models/fieldupdatetemplatefieldforbiddenissue.md new file mode 100644 index 0000000..0968b06 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldUpdateTemplateFieldForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldresponse.md b/docs/models/fieldupdatetemplatefieldresponse.md index 43e81a7..e8bde8a 100644 --- a/docs/models/fieldupdatetemplatefieldresponse.md +++ b/docs/models/fieldupdatetemplatefieldresponse.md @@ -7,17 +7,19 @@ 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/fieldupdatetemplatefieldsdirectioncheckbox.md b/docs/models/fieldupdatetemplatefieldsdirectioncheckbox.md new file mode 100644 index 0000000..e4761ab --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsdirectioncheckbox.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldsDirectionCheckbox + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsdirectionradio.md b/docs/models/fieldupdatetemplatefieldsdirectionradio.md new file mode 100644 index 0000000..0fc9935 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsdirectionradio.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldsDirectionRadio + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsdirectionresponse1.md b/docs/models/fieldupdatetemplatefieldsdirectionresponse1.md new file mode 100644 index 0000000..147f993 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsdirectionresponse1.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldsDirectionResponse1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsdirectionresponse2.md b/docs/models/fieldupdatetemplatefieldsdirectionresponse2.md new file mode 100644 index 0000000..71f0411 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsdirectionresponse2.md @@ -0,0 +1,9 @@ +# FieldUpdateTemplateFieldsDirectionResponse2 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldcheckbox.md b/docs/models/fieldupdatetemplatefieldsfieldcheckbox.md index d28787d..9279a0a 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldcheckbox.md +++ b/docs/models/fieldupdatetemplatefieldsfieldcheckbox.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateTemplateFieldsTypeCheckboxRequest1](../models/fieldupdatetemplatefieldstypecheckboxrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldsFieldMetaCheckboxRequest]](../models/fieldupdatetemplatefieldsfieldmetacheckboxrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfielddate.md b/docs/models/fieldupdatetemplatefieldsfielddate.md index 2af4648..5c90ef7 100644 --- a/docs/models/fieldupdatetemplatefieldsfielddate.md +++ b/docs/models/fieldupdatetemplatefieldsfielddate.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldsTypeDateRequest1](../models/fieldupdatetemplatefieldstypedaterequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldsFieldMetaDateRequest]](../models/fieldupdatetemplatefieldsfieldmetadaterequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfielddropdown.md b/docs/models/fieldupdatetemplatefieldsfielddropdown.md index 4dfeeeb..ee12abc 100644 --- a/docs/models/fieldupdatetemplatefieldsfielddropdown.md +++ b/docs/models/fieldupdatetemplatefieldsfielddropdown.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateTemplateFieldsTypeDropdownRequest1](../models/fieldupdatetemplatefieldstypedropdownrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldsFieldMetaDropdownRequest]](../models/fieldupdatetemplatefieldsfieldmetadropdownrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldemail.md b/docs/models/fieldupdatetemplatefieldsfieldemail.md index 9e64968..5ed153e 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldemail.md +++ b/docs/models/fieldupdatetemplatefieldsfieldemail.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateTemplateFieldsTypeEmailRequest1](../models/fieldupdatetemplatefieldstypeemailrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldsFieldMetaEmailRequest]](../models/fieldupdatetemplatefieldsfieldmetaemailrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldfreesignature.md b/docs/models/fieldupdatetemplatefieldsfieldfreesignature.md index d39350a..47e11b1 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldfreesignature.md +++ b/docs/models/fieldupdatetemplatefieldsfieldfreesignature.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateTemplateFieldsTypeFreeSignature](../models/fieldupdatetemplatefieldstypefreesignature.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldinitials.md b/docs/models/fieldupdatetemplatefieldsfieldinitials.md index 0feb3c7..947cc76 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldinitials.md +++ b/docs/models/fieldupdatetemplatefieldsfieldinitials.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateTemplateFieldsTypeInitialsRequest1](../models/fieldupdatetemplatefieldstypeinitialsrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldsFieldMetaInitialsRequest]](../models/fieldupdatetemplatefieldsfieldmetainitialsrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxrequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxrequest.md index d7e9686..b6a31a1 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxrequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxrequest.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldUpdateTemplateFieldsDirectionCheckbox]](../models/fieldupdatetemplatefieldsdirectioncheckbox.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..5bc762c 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetacheckboxresponse.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.FieldUpdateTemplateFieldsDirectionResponse2]](../models/fieldupdatetemplatefieldsdirectionresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetadaterequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetadaterequest.md index c90b280..273f10e 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetadaterequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetadaterequest.md @@ -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.FieldUpdateTemplateFieldsTypeDateRequest2](../models/fieldupdatetemplatefieldstypedaterequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsTypeDateRequest2](../models/fieldupdatetemplatefieldstypedaterequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignDate]](../models/fieldupdatetemplatefieldstextaligndate.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetadateresponse.md b/docs/models/fieldupdatetemplatefieldsfieldmetadateresponse.md index dbe2116..29bfea0 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetadateresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetadateresponse.md @@ -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.FieldUpdateTemplateFieldsFieldMetaTypeDate](../models/fieldupdatetemplatefieldsfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeDate](../models/fieldupdatetemplatefieldsfieldmetatypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignResponse4]](../models/fieldupdatetemplatefieldstextalignresponse4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetadropdownrequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetadropdownrequest.md index d890c6b..08c48d0 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetadropdownrequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetadropdownrequest.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateTemplateFieldsTypeDropdownRequest2](../models/fieldupdatetemplatefieldstypedropdownrequest2.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldUpdateTemplateFieldsValueDropdown](../models/fieldupdatetemplatefieldsvaluedropdown.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/fieldupdatetemplatefieldsfieldmetadropdownresponse.md b/docs/models/fieldupdatetemplatefieldsfieldmetadropdownresponse.md index c330fea..10e434e 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetadropdownresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetadropdownresponse.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeDropdown](../models/fieldupdatetemplatefieldsfieldmetatypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.FieldUpdateTemplateFieldsValueResponse3](../models/fieldupdatetemplatefieldsvalueresponse3.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/fieldupdatetemplatefieldsfieldmetaemailrequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetaemailrequest.md index 2c356ca..4cf073b 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetaemailrequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetaemailrequest.md @@ -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.FieldUpdateTemplateFieldsTypeEmailRequest2](../models/fieldupdatetemplatefieldstypeemailrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsTypeEmailRequest2](../models/fieldupdatetemplatefieldstypeemailrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignEmail]](../models/fieldupdatetemplatefieldstextalignemail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetaemailresponse.md b/docs/models/fieldupdatetemplatefieldsfieldmetaemailresponse.md index 983db73..fb1c4ca 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetaemailresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetaemailresponse.md @@ -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.FieldUpdateTemplateFieldsFieldMetaTypeEmail](../models/fieldupdatetemplatefieldsfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeEmail](../models/fieldupdatetemplatefieldsfieldmetatypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignResponse3]](../models/fieldupdatetemplatefieldstextalignresponse3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetainitialsrequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetainitialsrequest.md index 28ab954..9350bae 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetainitialsrequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetainitialsrequest.md @@ -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.FieldUpdateTemplateFieldsTypeInitialsRequest2](../models/fieldupdatetemplatefieldstypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsTypeInitialsRequest2](../models/fieldupdatetemplatefieldstypeinitialsrequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignInitials]](../models/fieldupdatetemplatefieldstextaligninitials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetainitialsresponse.md b/docs/models/fieldupdatetemplatefieldsfieldmetainitialsresponse.md index 99708ad..575205b 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetainitialsresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetainitialsresponse.md @@ -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.FieldUpdateTemplateFieldsFieldMetaTypeInitials](../models/fieldupdatetemplatefieldsfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeInitials](../models/fieldupdatetemplatefieldsfieldmetatypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignResponse1]](../models/fieldupdatetemplatefieldstextalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetanamerequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetanamerequest.md index e4bcc40..a970d8a 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetanamerequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetanamerequest.md @@ -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.FieldUpdateTemplateFieldsTypeNameRequest2](../models/fieldupdatetemplatefieldstypenamerequest2.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsTypeNameRequest2](../models/fieldupdatetemplatefieldstypenamerequest2.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignName]](../models/fieldupdatetemplatefieldstextalignname.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetanameresponse.md b/docs/models/fieldupdatetemplatefieldsfieldmetanameresponse.md index 495bddb..dd42b8a 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetanameresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetanameresponse.md @@ -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.FieldUpdateTemplateFieldsFieldMetaTypeName](../models/fieldupdatetemplatefieldsfieldmetatypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeName](../models/fieldupdatetemplatefieldsfieldmetatypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignResponse2]](../models/fieldupdatetemplatefieldstextalignresponse2.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..44d350e 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetanumberrequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetanumberrequest.md @@ -3,16 +3,19 @@ ## 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.FieldUpdateTemplateFieldsTypeNumberRequest2](../models/fieldupdatetemplatefieldstypenumberrequest2.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.FieldUpdateTemplateFieldsTextAlignNumber]](../models/fieldupdatetemplatefieldstextalignnumber.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsTypeNumberRequest2](../models/fieldupdatetemplatefieldstypenumberrequest2.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 | +| `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignNumber]](../models/fieldupdatetemplatefieldstextalignnumber.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateTemplateFieldsVerticalAlignNumber]](../models/fieldupdatetemplatefieldsverticalalignnumber.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..670df04 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetanumberresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetanumberresponse.md @@ -3,16 +3,19 @@ ## 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.FieldUpdateTemplateFieldsFieldMetaTypeNumber](../models/fieldupdatetemplatefieldsfieldmetatypenumber.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.FieldUpdateTemplateFieldsTextAlignResponse6]](../models/fieldupdatetemplatefieldstextalignresponse6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeNumber](../models/fieldupdatetemplatefieldsfieldmetatypenumber.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 | +| `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignResponse6]](../models/fieldupdatetemplatefieldstextalignresponse6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateTemplateFieldsVerticalAlignResponse2]](../models/fieldupdatetemplatefieldsverticalalignresponse2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetaradiorequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetaradiorequest.md index 7434fb3..aeb582b 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetaradiorequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetaradiorequest.md @@ -3,11 +3,13 @@ ## 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.FieldUpdateTemplateFieldsTypeRadioRequest2](../models/fieldupdatetemplatefieldstyperadiorequest2.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateTemplateFieldsValueRadio](../models/fieldupdatetemplatefieldsvalueradio.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsTypeRadioRequest2](../models/fieldupdatetemplatefieldstyperadiorequest2.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateTemplateFieldsValueRadio](../models/fieldupdatetemplatefieldsvalueradio.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateTemplateFieldsDirectionRadio]](../models/fieldupdatetemplatefieldsdirectionradio.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetaradioresponse.md b/docs/models/fieldupdatetemplatefieldsfieldmetaradioresponse.md index e524d03..a1f7be3 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetaradioresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetaradioresponse.md @@ -3,11 +3,13 @@ ## 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.FieldUpdateTemplateFieldsFieldMetaTypeRadio](../models/fieldupdatetemplatefieldsfieldmetatyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.FieldUpdateTemplateFieldsValueResponse1](../models/fieldupdatetemplatefieldsvalueresponse1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeRadio](../models/fieldupdatetemplatefieldsfieldmetatyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.FieldUpdateTemplateFieldsValueResponse1](../models/fieldupdatetemplatefieldsvalueresponse1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.FieldUpdateTemplateFieldsDirectionResponse1]](../models/fieldupdatetemplatefieldsdirectionresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetasignaturerequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetasignaturerequest.md new file mode 100644 index 0000000..13f03ee --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsfieldmetasignaturerequest.md @@ -0,0 +1,13 @@ +# FieldUpdateTemplateFieldsFieldMetaSignatureRequest + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsTypeSignatureRequest2](../models/fieldupdatetemplatefieldstypesignaturerequest2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetasignatureresponse.md b/docs/models/fieldupdatetemplatefieldsfieldmetasignatureresponse.md new file mode 100644 index 0000000..efa600c --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsfieldmetasignatureresponse.md @@ -0,0 +1,13 @@ +# FieldUpdateTemplateFieldsFieldMetaSignatureResponse + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeSignature](../models/fieldupdatetemplatefieldsfieldmetatypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetatextrequest.md b/docs/models/fieldupdatetemplatefieldsfieldmetatextrequest.md index 09dd963..35b309d 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetatextrequest.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetatextrequest.md @@ -3,14 +3,17 @@ ## 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.FieldUpdateTemplateFieldsTypeTextRequest2](../models/fieldupdatetemplatefieldstypetextrequest2.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.FieldUpdateTemplateFieldsTextAlignText]](../models/fieldupdatetemplatefieldstextaligntext.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsTypeTextRequest2](../models/fieldupdatetemplatefieldstypetextrequest2.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignText]](../models/fieldupdatetemplatefieldstextaligntext.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateTemplateFieldsVerticalAlignText]](../models/fieldupdatetemplatefieldsverticalaligntext.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetatextresponse.md b/docs/models/fieldupdatetemplatefieldsfieldmetatextresponse.md index fc3b869..53316d4 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetatextresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetatextresponse.md @@ -3,14 +3,17 @@ ## 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.FieldUpdateTemplateFieldsFieldMetaTypeText](../models/fieldupdatetemplatefieldsfieldmetatypetext.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.FieldUpdateTemplateFieldsTextAlignResponse5]](../models/fieldupdatetemplatefieldstextalignresponse5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.FieldUpdateTemplateFieldsFieldMetaTypeText](../models/fieldupdatetemplatefieldsfieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.FieldUpdateTemplateFieldsTextAlignResponse5]](../models/fieldupdatetemplatefieldstextalignresponse5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.FieldUpdateTemplateFieldsVerticalAlignResponse1]](../models/fieldupdatetemplatefieldsverticalalignresponse1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetatypesignature.md b/docs/models/fieldupdatetemplatefieldsfieldmetatypesignature.md new file mode 100644 index 0000000..f372823 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsfieldmetatypesignature.md @@ -0,0 +1,8 @@ +# FieldUpdateTemplateFieldsFieldMetaTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldmetaunion.md b/docs/models/fieldupdatetemplatefieldsfieldmetaunion.md index 4318b0e..aea2d5b 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldmetaunion.md +++ b/docs/models/fieldupdatetemplatefieldsfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.FieldUpdateTemplateFieldsFieldMetaSignatureResponse` + +```python +value: models.FieldUpdateTemplateFieldsFieldMetaSignatureResponse = /* values here */ +``` + ### `models.FieldUpdateTemplateFieldsFieldMetaInitialsResponse` ```python diff --git a/docs/models/fieldupdatetemplatefieldsfieldname.md b/docs/models/fieldupdatetemplatefieldsfieldname.md index 7409025..687d177 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldname.md +++ b/docs/models/fieldupdatetemplatefieldsfieldname.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldsTypeNameRequest1](../models/fieldupdatetemplatefieldstypenamerequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldsFieldMetaNameRequest]](../models/fieldupdatetemplatefieldsfieldmetanamerequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldnumber.md b/docs/models/fieldupdatetemplatefieldsfieldnumber.md index abbe3d8..1c60f17 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldnumber.md +++ b/docs/models/fieldupdatetemplatefieldsfieldnumber.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldsTypeNumberRequest1](../models/fieldupdatetemplatefieldstypenumberrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldsFieldMetaNumberRequest]](../models/fieldupdatetemplatefieldsfieldmetanumberrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldradio.md b/docs/models/fieldupdatetemplatefieldsfieldradio.md index 7f3a4ed..df0bc8c 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldradio.md +++ b/docs/models/fieldupdatetemplatefieldsfieldradio.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `type` | [models.FieldUpdateTemplateFieldsTypeRadioRequest1](../models/fieldupdatetemplatefieldstyperadiorequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldsFieldMetaRadioRequest]](../models/fieldupdatetemplatefieldsfieldmetaradiorequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :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..99e856e 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldresponse.md +++ b/docs/models/fieldupdatetemplatefieldsfieldresponse.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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/fieldupdatetemplatefieldsfieldsignature.md b/docs/models/fieldupdatetemplatefieldsfieldsignature.md index 6878637..8e1403c 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldsignature.md +++ b/docs/models/fieldupdatetemplatefieldsfieldsignature.md @@ -3,12 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `type` | [models.FieldUpdateTemplateFieldsTypeSignature](../models/fieldupdatetemplatefieldstypesignature.md) | :heavy_check_mark: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.FieldUpdateTemplateFieldsTypeSignatureRequest1](../models/fieldupdatetemplatefieldstypesignaturerequest1.md) | :heavy_check_mark: | N/A | +| `field_meta` | [Optional[models.FieldUpdateTemplateFieldsFieldMetaSignatureRequest]](../models/fieldupdatetemplatefieldsfieldmetasignaturerequest.md) | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsfieldtext.md b/docs/models/fieldupdatetemplatefieldsfieldtext.md index b791832..6d39dd8 100644 --- a/docs/models/fieldupdatetemplatefieldsfieldtext.md +++ b/docs/models/fieldupdatetemplatefieldsfieldtext.md @@ -7,9 +7,9 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [models.FieldUpdateTemplateFieldsTypeTextRequest1](../models/fieldupdatetemplatefieldstypetextrequest1.md) | :heavy_check_mark: | N/A | | `field_meta` | [Optional[models.FieldUpdateTemplateFieldsFieldMetaTextRequest]](../models/fieldupdatetemplatefieldsfieldmetatextrequest.md) | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | The ID of the field to update. | -| `page_number` | *Optional[float]* | :heavy_minus_sign: | The page number the field will be on. | -| `page_x` | *Optional[float]* | :heavy_minus_sign: | The X coordinate of where the field will be placed. | -| `page_y` | *Optional[float]* | :heavy_minus_sign: | The Y coordinate of where the field will be placed. | -| `width` | *Optional[float]* | :heavy_minus_sign: | The width of the field. | -| `height` | *Optional[float]* | :heavy_minus_sign: | The height of the field. | \ No newline at end of file +| `id` | *float* | :heavy_check_mark: | N/A | +| `page_number` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_x` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `page_y` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `width` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `height` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsforbiddenerror.md b/docs/models/fieldupdatetemplatefieldsforbiddenerror.md new file mode 100644 index 0000000..6423a74 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsforbiddenerror.md @@ -0,0 +1,12 @@ +# FieldUpdateTemplateFieldsForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldUpdateTemplateFieldsForbiddenIssue](../models/fieldupdatetemplatefieldsforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsforbiddenissue.md b/docs/models/fieldupdatetemplatefieldsforbiddenissue.md new file mode 100644 index 0000000..bbeb463 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsforbiddenissue.md @@ -0,0 +1,8 @@ +# FieldUpdateTemplateFieldsForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldstypesignature.md b/docs/models/fieldupdatetemplatefieldstypesignature.md deleted file mode 100644 index 0d524ce..0000000 --- a/docs/models/fieldupdatetemplatefieldstypesignature.md +++ /dev/null @@ -1,8 +0,0 @@ -# FieldUpdateTemplateFieldsTypeSignature - - -## Values - -| Name | Value | -| ----------- | ----------- | -| `SIGNATURE` | SIGNATURE | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldstypesignaturerequest1.md b/docs/models/fieldupdatetemplatefieldstypesignaturerequest1.md new file mode 100644 index 0000000..3629c64 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldstypesignaturerequest1.md @@ -0,0 +1,8 @@ +# FieldUpdateTemplateFieldsTypeSignatureRequest1 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | SIGNATURE | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldstypesignaturerequest2.md b/docs/models/fieldupdatetemplatefieldstypesignaturerequest2.md new file mode 100644 index 0000000..d31d306 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldstypesignaturerequest2.md @@ -0,0 +1,8 @@ +# FieldUpdateTemplateFieldsTypeSignatureRequest2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsunauthorizederror.md b/docs/models/fieldupdatetemplatefieldsunauthorizederror.md new file mode 100644 index 0000000..98922af --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldUpdateTemplateFieldsUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldUpdateTemplateFieldsUnauthorizedIssue](../models/fieldupdatetemplatefieldsunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsunauthorizedissue.md b/docs/models/fieldupdatetemplatefieldsunauthorizedissue.md new file mode 100644 index 0000000..749872f --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldUpdateTemplateFieldsUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsverticalalignnumber.md b/docs/models/fieldupdatetemplatefieldsverticalalignnumber.md new file mode 100644 index 0000000..df842de --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsverticalalignnumber.md @@ -0,0 +1,10 @@ +# FieldUpdateTemplateFieldsVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsverticalalignresponse1.md b/docs/models/fieldupdatetemplatefieldsverticalalignresponse1.md new file mode 100644 index 0000000..e6ac4b8 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsverticalalignresponse1.md @@ -0,0 +1,10 @@ +# FieldUpdateTemplateFieldsVerticalAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsverticalalignresponse2.md b/docs/models/fieldupdatetemplatefieldsverticalalignresponse2.md new file mode 100644 index 0000000..9b5fe73 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsverticalalignresponse2.md @@ -0,0 +1,10 @@ +# FieldUpdateTemplateFieldsVerticalAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldsverticalaligntext.md b/docs/models/fieldupdatetemplatefieldsverticalaligntext.md new file mode 100644 index 0000000..04cb94a --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldsverticalaligntext.md @@ -0,0 +1,10 @@ +# FieldUpdateTemplateFieldsVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldtypesignaturerequest1.md b/docs/models/fieldupdatetemplatefieldtypesignaturerequest1.md new file mode 100644 index 0000000..06823e6 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldtypesignaturerequest1.md @@ -0,0 +1,8 @@ +# FieldUpdateTemplateFieldTypeSignatureRequest1 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | SIGNATURE | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldtypesignaturerequest2.md b/docs/models/fieldupdatetemplatefieldtypesignaturerequest2.md new file mode 100644 index 0000000..4aacf27 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldtypesignaturerequest2.md @@ -0,0 +1,8 @@ +# FieldUpdateTemplateFieldTypeSignatureRequest2 + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldunauthorizederror.md b/docs/models/fieldupdatetemplatefieldunauthorizederror.md new file mode 100644 index 0000000..abb8f82 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldunauthorizederror.md @@ -0,0 +1,12 @@ +# FieldUpdateTemplateFieldUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FieldUpdateTemplateFieldUnauthorizedIssue](../models/fieldupdatetemplatefieldunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldunauthorizedissue.md b/docs/models/fieldupdatetemplatefieldunauthorizedissue.md new file mode 100644 index 0000000..8857cf2 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldunauthorizedissue.md @@ -0,0 +1,8 @@ +# FieldUpdateTemplateFieldUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldverticalalignnumber.md b/docs/models/fieldupdatetemplatefieldverticalalignnumber.md new file mode 100644 index 0000000..a8626a4 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldverticalalignnumber.md @@ -0,0 +1,10 @@ +# FieldUpdateTemplateFieldVerticalAlignNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldverticalalignresponse1.md b/docs/models/fieldupdatetemplatefieldverticalalignresponse1.md new file mode 100644 index 0000000..f5c72a7 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldverticalalignresponse1.md @@ -0,0 +1,10 @@ +# FieldUpdateTemplateFieldVerticalAlignResponse1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldverticalalignresponse2.md b/docs/models/fieldupdatetemplatefieldverticalalignresponse2.md new file mode 100644 index 0000000..a7e2e15 --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldverticalalignresponse2.md @@ -0,0 +1,10 @@ +# FieldUpdateTemplateFieldVerticalAlignResponse2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/fieldupdatetemplatefieldverticalaligntext.md b/docs/models/fieldupdatetemplatefieldverticalaligntext.md new file mode 100644 index 0000000..9d3e4ba --- /dev/null +++ b/docs/models/fieldupdatetemplatefieldverticalaligntext.md @@ -0,0 +1,10 @@ +# FieldUpdateTemplateFieldVerticalAlignText + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/foldercreatefolderbadrequesterror.md b/docs/models/foldercreatefolderbadrequesterror.md new file mode 100644 index 0000000..7063f0e --- /dev/null +++ b/docs/models/foldercreatefolderbadrequesterror.md @@ -0,0 +1,12 @@ +# FolderCreateFolderBadRequestError + +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.FolderCreateFolderBadRequestIssue](../models/foldercreatefolderbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/foldercreatefolderbadrequestissue.md b/docs/models/foldercreatefolderbadrequestissue.md new file mode 100644 index 0000000..a8f14ae --- /dev/null +++ b/docs/models/foldercreatefolderbadrequestissue.md @@ -0,0 +1,8 @@ +# FolderCreateFolderBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/foldercreatefolderforbiddenerror.md b/docs/models/foldercreatefolderforbiddenerror.md new file mode 100644 index 0000000..4987e0a --- /dev/null +++ b/docs/models/foldercreatefolderforbiddenerror.md @@ -0,0 +1,12 @@ +# FolderCreateFolderForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FolderCreateFolderForbiddenIssue](../models/foldercreatefolderforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/foldercreatefolderforbiddenissue.md b/docs/models/foldercreatefolderforbiddenissue.md new file mode 100644 index 0000000..97cb1f7 --- /dev/null +++ b/docs/models/foldercreatefolderforbiddenissue.md @@ -0,0 +1,8 @@ +# FolderCreateFolderForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/foldercreatefolderinternalservererror.md b/docs/models/foldercreatefolderinternalservererror.md new file mode 100644 index 0000000..e6b4afd --- /dev/null +++ b/docs/models/foldercreatefolderinternalservererror.md @@ -0,0 +1,12 @@ +# FolderCreateFolderInternalServerError + +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.FolderCreateFolderInternalServerErrorIssue](../models/foldercreatefolderinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/foldercreatefolderinternalservererrorissue.md b/docs/models/foldercreatefolderinternalservererrorissue.md new file mode 100644 index 0000000..6cce83d --- /dev/null +++ b/docs/models/foldercreatefolderinternalservererrorissue.md @@ -0,0 +1,8 @@ +# FolderCreateFolderInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/foldercreatefolderrequest.md b/docs/models/foldercreatefolderrequest.md new file mode 100644 index 0000000..9cc6613 --- /dev/null +++ b/docs/models/foldercreatefolderrequest.md @@ -0,0 +1,10 @@ +# FolderCreateFolderRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `name` | *str* | :heavy_check_mark: | N/A | +| `parent_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[models.FolderCreateFolderTypeRequest]](../models/foldercreatefoldertyperequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/foldercreatefolderresponse.md b/docs/models/foldercreatefolderresponse.md new file mode 100644 index 0000000..bd71010 --- /dev/null +++ b/docs/models/foldercreatefolderresponse.md @@ -0,0 +1,19 @@ +# FolderCreateFolderResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `parent_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `pinned` | *bool* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `visibility` | [models.FolderCreateFolderVisibility](../models/foldercreatefoldervisibility.md) | :heavy_check_mark: | N/A | +| `type` | [models.FolderCreateFolderTypeResponse](../models/foldercreatefoldertyperesponse.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/foldercreatefoldertyperequest.md b/docs/models/foldercreatefoldertyperequest.md new file mode 100644 index 0000000..4620678 --- /dev/null +++ b/docs/models/foldercreatefoldertyperequest.md @@ -0,0 +1,9 @@ +# FolderCreateFolderTypeRequest + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | \ No newline at end of file diff --git a/docs/models/foldercreatefoldertyperesponse.md b/docs/models/foldercreatefoldertyperesponse.md new file mode 100644 index 0000000..72c6a53 --- /dev/null +++ b/docs/models/foldercreatefoldertyperesponse.md @@ -0,0 +1,9 @@ +# FolderCreateFolderTypeResponse + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | \ No newline at end of file diff --git a/docs/models/foldercreatefolderunauthorizederror.md b/docs/models/foldercreatefolderunauthorizederror.md new file mode 100644 index 0000000..772853f --- /dev/null +++ b/docs/models/foldercreatefolderunauthorizederror.md @@ -0,0 +1,12 @@ +# FolderCreateFolderUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FolderCreateFolderUnauthorizedIssue](../models/foldercreatefolderunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/foldercreatefolderunauthorizedissue.md b/docs/models/foldercreatefolderunauthorizedissue.md new file mode 100644 index 0000000..20169eb --- /dev/null +++ b/docs/models/foldercreatefolderunauthorizedissue.md @@ -0,0 +1,8 @@ +# FolderCreateFolderUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/foldercreatefoldervisibility.md b/docs/models/foldercreatefoldervisibility.md new file mode 100644 index 0000000..5102e96 --- /dev/null +++ b/docs/models/foldercreatefoldervisibility.md @@ -0,0 +1,10 @@ +# FolderCreateFolderVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/folderdeletefolderbadrequesterror.md b/docs/models/folderdeletefolderbadrequesterror.md new file mode 100644 index 0000000..4d637f7 --- /dev/null +++ b/docs/models/folderdeletefolderbadrequesterror.md @@ -0,0 +1,12 @@ +# FolderDeleteFolderBadRequestError + +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.FolderDeleteFolderBadRequestIssue](../models/folderdeletefolderbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderdeletefolderbadrequestissue.md b/docs/models/folderdeletefolderbadrequestissue.md new file mode 100644 index 0000000..e4a341e --- /dev/null +++ b/docs/models/folderdeletefolderbadrequestissue.md @@ -0,0 +1,8 @@ +# FolderDeleteFolderBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderdeletefolderforbiddenerror.md b/docs/models/folderdeletefolderforbiddenerror.md new file mode 100644 index 0000000..360484c --- /dev/null +++ b/docs/models/folderdeletefolderforbiddenerror.md @@ -0,0 +1,12 @@ +# FolderDeleteFolderForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FolderDeleteFolderForbiddenIssue](../models/folderdeletefolderforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderdeletefolderforbiddenissue.md b/docs/models/folderdeletefolderforbiddenissue.md new file mode 100644 index 0000000..8f78591 --- /dev/null +++ b/docs/models/folderdeletefolderforbiddenissue.md @@ -0,0 +1,8 @@ +# FolderDeleteFolderForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderdeletefolderinternalservererror.md b/docs/models/folderdeletefolderinternalservererror.md new file mode 100644 index 0000000..9f85507 --- /dev/null +++ b/docs/models/folderdeletefolderinternalservererror.md @@ -0,0 +1,12 @@ +# FolderDeleteFolderInternalServerError + +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.FolderDeleteFolderInternalServerErrorIssue](../models/folderdeletefolderinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderdeletefolderinternalservererrorissue.md b/docs/models/folderdeletefolderinternalservererrorissue.md new file mode 100644 index 0000000..7346f59 --- /dev/null +++ b/docs/models/folderdeletefolderinternalservererrorissue.md @@ -0,0 +1,8 @@ +# FolderDeleteFolderInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderdeletefolderrequest.md b/docs/models/folderdeletefolderrequest.md new file mode 100644 index 0000000..8ec4dd4 --- /dev/null +++ b/docs/models/folderdeletefolderrequest.md @@ -0,0 +1,8 @@ +# FolderDeleteFolderRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `folder_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderdeletefolderresponse.md b/docs/models/folderdeletefolderresponse.md new file mode 100644 index 0000000..135dc35 --- /dev/null +++ b/docs/models/folderdeletefolderresponse.md @@ -0,0 +1,10 @@ +# FolderDeleteFolderResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `success` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderdeletefolderunauthorizederror.md b/docs/models/folderdeletefolderunauthorizederror.md new file mode 100644 index 0000000..b4f67f4 --- /dev/null +++ b/docs/models/folderdeletefolderunauthorizederror.md @@ -0,0 +1,12 @@ +# FolderDeleteFolderUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FolderDeleteFolderUnauthorizedIssue](../models/folderdeletefolderunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderdeletefolderunauthorizedissue.md b/docs/models/folderdeletefolderunauthorizedissue.md new file mode 100644 index 0000000..bb31cef --- /dev/null +++ b/docs/models/folderdeletefolderunauthorizedissue.md @@ -0,0 +1,8 @@ +# FolderDeleteFolderUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersbadrequesterror.md b/docs/models/folderfindfoldersbadrequesterror.md new file mode 100644 index 0000000..c183d26 --- /dev/null +++ b/docs/models/folderfindfoldersbadrequesterror.md @@ -0,0 +1,12 @@ +# FolderFindFoldersBadRequestError + +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.FolderFindFoldersBadRequestIssue](../models/folderfindfoldersbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersbadrequestissue.md b/docs/models/folderfindfoldersbadrequestissue.md new file mode 100644 index 0000000..7df4ae1 --- /dev/null +++ b/docs/models/folderfindfoldersbadrequestissue.md @@ -0,0 +1,8 @@ +# FolderFindFoldersBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersdata.md b/docs/models/folderfindfoldersdata.md new file mode 100644 index 0000000..f8e2e45 --- /dev/null +++ b/docs/models/folderfindfoldersdata.md @@ -0,0 +1,17 @@ +# FolderFindFoldersData + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `parent_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `pinned` | *bool* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `visibility` | [models.FolderFindFoldersVisibility](../models/folderfindfoldersvisibility.md) | :heavy_check_mark: | N/A | +| `type` | [models.FolderFindFoldersDataType](../models/folderfindfoldersdatatype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersdatatype.md b/docs/models/folderfindfoldersdatatype.md new file mode 100644 index 0000000..19fe61e --- /dev/null +++ b/docs/models/folderfindfoldersdatatype.md @@ -0,0 +1,9 @@ +# FolderFindFoldersDataType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | \ No newline at end of file diff --git a/docs/models/folderfindfoldersforbiddenerror.md b/docs/models/folderfindfoldersforbiddenerror.md new file mode 100644 index 0000000..fb3ef1d --- /dev/null +++ b/docs/models/folderfindfoldersforbiddenerror.md @@ -0,0 +1,12 @@ +# FolderFindFoldersForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FolderFindFoldersForbiddenIssue](../models/folderfindfoldersforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersforbiddenissue.md b/docs/models/folderfindfoldersforbiddenissue.md new file mode 100644 index 0000000..fc2930c --- /dev/null +++ b/docs/models/folderfindfoldersforbiddenissue.md @@ -0,0 +1,8 @@ +# FolderFindFoldersForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersinternalservererror.md b/docs/models/folderfindfoldersinternalservererror.md new file mode 100644 index 0000000..fa3524e --- /dev/null +++ b/docs/models/folderfindfoldersinternalservererror.md @@ -0,0 +1,12 @@ +# FolderFindFoldersInternalServerError + +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.FolderFindFoldersInternalServerErrorIssue](../models/folderfindfoldersinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersinternalservererrorissue.md b/docs/models/folderfindfoldersinternalservererrorissue.md new file mode 100644 index 0000000..ca5d312 --- /dev/null +++ b/docs/models/folderfindfoldersinternalservererrorissue.md @@ -0,0 +1,8 @@ +# FolderFindFoldersInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersnotfounderror.md b/docs/models/folderfindfoldersnotfounderror.md new file mode 100644 index 0000000..801dafc --- /dev/null +++ b/docs/models/folderfindfoldersnotfounderror.md @@ -0,0 +1,12 @@ +# FolderFindFoldersNotFoundError + +Not found + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FolderFindFoldersNotFoundIssue](../models/folderfindfoldersnotfoundissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersnotfoundissue.md b/docs/models/folderfindfoldersnotfoundissue.md new file mode 100644 index 0000000..892b229 --- /dev/null +++ b/docs/models/folderfindfoldersnotfoundissue.md @@ -0,0 +1,8 @@ +# FolderFindFoldersNotFoundIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersqueryparamtype.md b/docs/models/folderfindfoldersqueryparamtype.md new file mode 100644 index 0000000..2ae4382 --- /dev/null +++ b/docs/models/folderfindfoldersqueryparamtype.md @@ -0,0 +1,9 @@ +# FolderFindFoldersQueryParamType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | \ No newline at end of file diff --git a/docs/models/folderfindfoldersrequest.md b/docs/models/folderfindfoldersrequest.md new file mode 100644 index 0000000..60ceb2d --- /dev/null +++ b/docs/models/folderfindfoldersrequest.md @@ -0,0 +1,12 @@ +# FolderFindFoldersRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `query` | *Optional[str]* | :heavy_minus_sign: | The search query. | +| `page` | *Optional[float]* | :heavy_minus_sign: | The pagination page number, starts at 1. | +| `per_page` | *Optional[float]* | :heavy_minus_sign: | The number of items per page. | +| `parent_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[models.FolderFindFoldersQueryParamType]](../models/folderfindfoldersqueryparamtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersresponse.md b/docs/models/folderfindfoldersresponse.md new file mode 100644 index 0000000..b12cd3f --- /dev/null +++ b/docs/models/folderfindfoldersresponse.md @@ -0,0 +1,14 @@ +# FolderFindFoldersResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `data` | List[[models.FolderFindFoldersData](../models/folderfindfoldersdata.md)] | :heavy_check_mark: | N/A | +| `count` | *float* | :heavy_check_mark: | N/A | +| `current_page` | *float* | :heavy_check_mark: | N/A | +| `per_page` | *float* | :heavy_check_mark: | N/A | +| `total_pages` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersunauthorizederror.md b/docs/models/folderfindfoldersunauthorizederror.md new file mode 100644 index 0000000..c280869 --- /dev/null +++ b/docs/models/folderfindfoldersunauthorizederror.md @@ -0,0 +1,12 @@ +# FolderFindFoldersUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FolderFindFoldersUnauthorizedIssue](../models/folderfindfoldersunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersunauthorizedissue.md b/docs/models/folderfindfoldersunauthorizedissue.md new file mode 100644 index 0000000..26d4212 --- /dev/null +++ b/docs/models/folderfindfoldersunauthorizedissue.md @@ -0,0 +1,8 @@ +# FolderFindFoldersUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderfindfoldersvisibility.md b/docs/models/folderfindfoldersvisibility.md new file mode 100644 index 0000000..6ec0f91 --- /dev/null +++ b/docs/models/folderfindfoldersvisibility.md @@ -0,0 +1,10 @@ +# FolderFindFoldersVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/folderupdatefolderbadrequesterror.md b/docs/models/folderupdatefolderbadrequesterror.md new file mode 100644 index 0000000..9daa12d --- /dev/null +++ b/docs/models/folderupdatefolderbadrequesterror.md @@ -0,0 +1,12 @@ +# FolderUpdateFolderBadRequestError + +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.FolderUpdateFolderBadRequestIssue](../models/folderupdatefolderbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefolderbadrequestissue.md b/docs/models/folderupdatefolderbadrequestissue.md new file mode 100644 index 0000000..8c588b9 --- /dev/null +++ b/docs/models/folderupdatefolderbadrequestissue.md @@ -0,0 +1,8 @@ +# FolderUpdateFolderBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefolderdata.md b/docs/models/folderupdatefolderdata.md new file mode 100644 index 0000000..dad3598 --- /dev/null +++ b/docs/models/folderupdatefolderdata.md @@ -0,0 +1,11 @@ +# FolderUpdateFolderData + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.FolderUpdateFolderDataVisibility]](../models/folderupdatefolderdatavisibility.md) | :heavy_minus_sign: | N/A | +| `pinned` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefolderdatavisibility.md b/docs/models/folderupdatefolderdatavisibility.md new file mode 100644 index 0000000..982e2a1 --- /dev/null +++ b/docs/models/folderupdatefolderdatavisibility.md @@ -0,0 +1,10 @@ +# FolderUpdateFolderDataVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/folderupdatefolderforbiddenerror.md b/docs/models/folderupdatefolderforbiddenerror.md new file mode 100644 index 0000000..18bc2ef --- /dev/null +++ b/docs/models/folderupdatefolderforbiddenerror.md @@ -0,0 +1,12 @@ +# FolderUpdateFolderForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FolderUpdateFolderForbiddenIssue](../models/folderupdatefolderforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefolderforbiddenissue.md b/docs/models/folderupdatefolderforbiddenissue.md new file mode 100644 index 0000000..6db7258 --- /dev/null +++ b/docs/models/folderupdatefolderforbiddenissue.md @@ -0,0 +1,8 @@ +# FolderUpdateFolderForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefolderinternalservererror.md b/docs/models/folderupdatefolderinternalservererror.md new file mode 100644 index 0000000..5c21b4d --- /dev/null +++ b/docs/models/folderupdatefolderinternalservererror.md @@ -0,0 +1,12 @@ +# FolderUpdateFolderInternalServerError + +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.FolderUpdateFolderInternalServerErrorIssue](../models/folderupdatefolderinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefolderinternalservererrorissue.md b/docs/models/folderupdatefolderinternalservererrorissue.md new file mode 100644 index 0000000..cdbc136 --- /dev/null +++ b/docs/models/folderupdatefolderinternalservererrorissue.md @@ -0,0 +1,8 @@ +# FolderUpdateFolderInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefolderrequest.md b/docs/models/folderupdatefolderrequest.md new file mode 100644 index 0000000..3b01035 --- /dev/null +++ b/docs/models/folderupdatefolderrequest.md @@ -0,0 +1,9 @@ +# FolderUpdateFolderRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `folder_id` | *str* | :heavy_check_mark: | N/A | +| `data` | [models.FolderUpdateFolderData](../models/folderupdatefolderdata.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefolderresponse.md b/docs/models/folderupdatefolderresponse.md new file mode 100644 index 0000000..3f0cd53 --- /dev/null +++ b/docs/models/folderupdatefolderresponse.md @@ -0,0 +1,19 @@ +# FolderUpdateFolderResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | +| `team_id` | *float* | :heavy_check_mark: | N/A | +| `parent_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `pinned` | *bool* | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `visibility` | [models.FolderUpdateFolderVisibilityResponse](../models/folderupdatefoldervisibilityresponse.md) | :heavy_check_mark: | N/A | +| `type` | [models.FolderUpdateFolderType](../models/folderupdatefoldertype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefoldertype.md b/docs/models/folderupdatefoldertype.md new file mode 100644 index 0000000..cbb4450 --- /dev/null +++ b/docs/models/folderupdatefoldertype.md @@ -0,0 +1,9 @@ +# FolderUpdateFolderType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DOCUMENT` | DOCUMENT | +| `TEMPLATE` | TEMPLATE | \ No newline at end of file diff --git a/docs/models/folderupdatefolderunauthorizederror.md b/docs/models/folderupdatefolderunauthorizederror.md new file mode 100644 index 0000000..d08b76b --- /dev/null +++ b/docs/models/folderupdatefolderunauthorizederror.md @@ -0,0 +1,12 @@ +# FolderUpdateFolderUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.FolderUpdateFolderUnauthorizedIssue](../models/folderupdatefolderunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefolderunauthorizedissue.md b/docs/models/folderupdatefolderunauthorizedissue.md new file mode 100644 index 0000000..54383df --- /dev/null +++ b/docs/models/folderupdatefolderunauthorizedissue.md @@ -0,0 +1,8 @@ +# FolderUpdateFolderUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/folderupdatefoldervisibilityresponse.md b/docs/models/folderupdatefoldervisibilityresponse.md new file mode 100644 index 0000000..e1f4994 --- /dev/null +++ b/docs/models/folderupdatefoldervisibilityresponse.md @@ -0,0 +1,10 @@ +# FolderUpdateFolderVisibilityResponse + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/override.md b/docs/models/override.md new file mode 100644 index 0000000..6c98259 --- /dev/null +++ b/docs/models/override.md @@ -0,0 +1,20 @@ +# Override + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.EnvelopeUseDateFormat]](../models/envelopeusedateformat.md) | :heavy_minus_sign: | N/A | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.EnvelopeUseDistributionMethod]](../models/envelopeusedistributionmethod.md) | :heavy_minus_sign: | N/A | +| `email_settings` | [Optional[models.EnvelopeUseEmailSettings]](../models/envelopeuseemailsettings.md) | :heavy_minus_sign: | N/A | +| `language` | [Optional[models.EnvelopeUseLanguage]](../models/envelopeuselanguage.md) | :heavy_minus_sign: | N/A | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `draw_signature_enabled` | *Optional[bool]* | :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/prefillfield.md b/docs/models/prefillfield.md deleted file mode 100644 index 1b31e41..0000000 --- a/docs/models/prefillfield.md +++ /dev/null @@ -1,41 +0,0 @@ -# PrefillField - - -## Supported Types - -### `models.PrefillFieldText` - -```python -value: models.PrefillFieldText = /* values here */ -``` - -### `models.PrefillFieldNumber` - -```python -value: models.PrefillFieldNumber = /* values here */ -``` - -### `models.PrefillFieldRadio` - -```python -value: models.PrefillFieldRadio = /* values here */ -``` - -### `models.PrefillFieldCheckbox` - -```python -value: models.PrefillFieldCheckbox = /* values here */ -``` - -### `models.PrefillFieldDropdown` - -```python -value: models.PrefillFieldDropdown = /* values here */ -``` - -### `models.PrefillFieldDate` - -```python -value: models.PrefillFieldDate = /* values here */ -``` - diff --git a/docs/models/prefillfielddate.md b/docs/models/prefillfielddate.md deleted file mode 100644 index 717d0b8..0000000 --- a/docs/models/prefillfielddate.md +++ /dev/null @@ -1,10 +0,0 @@ -# PrefillFieldDate - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `type` | [models.PrefillFieldTypeDate](../models/prefillfieldtypedate.md) | :heavy_check_mark: | N/A | -| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/prefillfieldnumber.md b/docs/models/prefillfieldnumber.md deleted file mode 100644 index 7ba3eca..0000000 --- a/docs/models/prefillfieldnumber.md +++ /dev/null @@ -1,12 +0,0 @@ -# PrefillFieldNumber - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `type` | [models.PrefillFieldTypeNumber](../models/prefillfieldtypenumber.md) | :heavy_check_mark: | N/A | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientaccessauthrequest.md b/docs/models/recipientcreatedocumentrecipientaccessauthrequest.md index f238fed..24ca004 100644 --- a/docs/models/recipientcreatedocumentrecipientaccessauthrequest.md +++ b/docs/models/recipientcreatedocumentrecipientaccessauthrequest.md @@ -1,10 +1,9 @@ # RecipientCreateDocumentRecipientAccessAuthRequest -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..62b5a5b 100644 --- a/docs/models/recipientcreatedocumentrecipientaccessauthresponse.md +++ b/docs/models/recipientcreatedocumentrecipientaccessauthresponse.md @@ -1,10 +1,9 @@ # RecipientCreateDocumentRecipientAccessAuthResponse -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/recipientcreatedocumentrecipientactionauthrequest.md b/docs/models/recipientcreatedocumentrecipientactionauthrequest.md index 32e19d2..c1c336f 100644 --- a/docs/models/recipientcreatedocumentrecipientactionauthrequest.md +++ b/docs/models/recipientcreatedocumentrecipientactionauthrequest.md @@ -1,7 +1,5 @@ # RecipientCreateDocumentRecipientActionAuthRequest -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientcreatedocumentrecipientactionauthresponse.md b/docs/models/recipientcreatedocumentrecipientactionauthresponse.md index 617ee70..d5ac8e2 100644 --- a/docs/models/recipientcreatedocumentrecipientactionauthresponse.md +++ b/docs/models/recipientcreatedocumentrecipientactionauthresponse.md @@ -1,7 +1,5 @@ # RecipientCreateDocumentRecipientActionAuthResponse -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientcreatedocumentrecipientforbiddenerror.md b/docs/models/recipientcreatedocumentrecipientforbiddenerror.md new file mode 100644 index 0000000..5eab5d5 --- /dev/null +++ b/docs/models/recipientcreatedocumentrecipientforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientCreateDocumentRecipientForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientCreateDocumentRecipientForbiddenIssue](../models/recipientcreatedocumentrecipientforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientforbiddenissue.md b/docs/models/recipientcreatedocumentrecipientforbiddenissue.md new file mode 100644 index 0000000..f4ee2eb --- /dev/null +++ b/docs/models/recipientcreatedocumentrecipientforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientCreateDocumentRecipientForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientresponse.md b/docs/models/recipientcreatedocumentrecipientresponse.md index 76753f6..5e11056 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 | @@ -21,5 +20,7 @@ Successful response | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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 +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `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..013fd3e 100644 --- a/docs/models/recipientcreatedocumentrecipientsaccessauthrequest.md +++ b/docs/models/recipientcreatedocumentrecipientsaccessauthrequest.md @@ -1,10 +1,9 @@ # RecipientCreateDocumentRecipientsAccessAuthRequest -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..0a7ff49 100644 --- a/docs/models/recipientcreatedocumentrecipientsaccessauthresponse.md +++ b/docs/models/recipientcreatedocumentrecipientsaccessauthresponse.md @@ -1,10 +1,9 @@ # RecipientCreateDocumentRecipientsAccessAuthResponse -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/recipientcreatedocumentrecipientsactionauthrequest.md b/docs/models/recipientcreatedocumentrecipientsactionauthrequest.md index 7d0bd43..417eda6 100644 --- a/docs/models/recipientcreatedocumentrecipientsactionauthrequest.md +++ b/docs/models/recipientcreatedocumentrecipientsactionauthrequest.md @@ -1,7 +1,5 @@ # RecipientCreateDocumentRecipientsActionAuthRequest -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientcreatedocumentrecipientsactionauthresponse.md b/docs/models/recipientcreatedocumentrecipientsactionauthresponse.md index 3b241ca..8292d15 100644 --- a/docs/models/recipientcreatedocumentrecipientsactionauthresponse.md +++ b/docs/models/recipientcreatedocumentrecipientsactionauthresponse.md @@ -1,7 +1,5 @@ # RecipientCreateDocumentRecipientsActionAuthResponse -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientcreatedocumentrecipientsforbiddenerror.md b/docs/models/recipientcreatedocumentrecipientsforbiddenerror.md new file mode 100644 index 0000000..988adc9 --- /dev/null +++ b/docs/models/recipientcreatedocumentrecipientsforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientCreateDocumentRecipientsForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientCreateDocumentRecipientsForbiddenIssue](../models/recipientcreatedocumentrecipientsforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientsforbiddenissue.md b/docs/models/recipientcreatedocumentrecipientsforbiddenissue.md new file mode 100644 index 0000000..462fda0 --- /dev/null +++ b/docs/models/recipientcreatedocumentrecipientsforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientCreateDocumentRecipientsForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientsrecipientresponse.md b/docs/models/recipientcreatedocumentrecipientsrecipientresponse.md index 4613443..210a9d8 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 | @@ -19,5 +18,7 @@ | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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 +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `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/documentgetdocumentwithdetailsbyidauthoptions.md b/docs/models/recipientcreatedocumentrecipientsunauthorizederror.md similarity index 59% rename from docs/models/documentgetdocumentwithdetailsbyidauthoptions.md rename to docs/models/recipientcreatedocumentrecipientsunauthorizederror.md index 7b67703..edca696 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidauthoptions.md +++ b/docs/models/recipientcreatedocumentrecipientsunauthorizederror.md @@ -1,9 +1,12 @@ -# DocumentGetDocumentWithDetailsByIDAuthOptions +# RecipientCreateDocumentRecipientsUnauthorizedError + +Authorization not provided ## 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 +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientCreateDocumentRecipientsUnauthorizedIssue](../models/recipientcreatedocumentrecipientsunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatedocumentrecipientsunauthorizedissue.md b/docs/models/recipientcreatedocumentrecipientsunauthorizedissue.md new file mode 100644 index 0000000..af10a01 --- /dev/null +++ b/docs/models/recipientcreatedocumentrecipientsunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientCreateDocumentRecipientsUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentgetdocumentwithdetailsbyidbadrequesterror.md b/docs/models/recipientcreatedocumentrecipientunauthorizederror.md similarity index 92% rename from docs/models/documentgetdocumentwithdetailsbyidbadrequesterror.md rename to docs/models/recipientcreatedocumentrecipientunauthorizederror.md index 038bc4e..9943139 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidbadrequesterror.md +++ b/docs/models/recipientcreatedocumentrecipientunauthorizederror.md @@ -1,6 +1,6 @@ -# DocumentGetDocumentWithDetailsByIDBadRequestError +# RecipientCreateDocumentRecipientUnauthorizedError -Invalid input data +Authorization not provided ## 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.DocumentGetDocumentWithDetailsByIDBadRequestIssue](../models/documentgetdocumentwithdetailsbyidbadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.RecipientCreateDocumentRecipientUnauthorizedIssue](../models/recipientcreatedocumentrecipientunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicatedocumentinternalservererrorissue.md b/docs/models/recipientcreatedocumentrecipientunauthorizedissue.md similarity index 83% rename from docs/models/documentduplicatedocumentinternalservererrorissue.md rename to docs/models/recipientcreatedocumentrecipientunauthorizedissue.md index b18f734..12d0ed6 100644 --- a/docs/models/documentduplicatedocumentinternalservererrorissue.md +++ b/docs/models/recipientcreatedocumentrecipientunauthorizedissue.md @@ -1,4 +1,4 @@ -# DocumentDuplicateDocumentInternalServerErrorIssue +# RecipientCreateDocumentRecipientUnauthorizedIssue ## Fields diff --git a/docs/models/recipientcreatetemplaterecipientaccessauthrequest.md b/docs/models/recipientcreatetemplaterecipientaccessauthrequest.md index 75e315d..979aa5b 100644 --- a/docs/models/recipientcreatetemplaterecipientaccessauthrequest.md +++ b/docs/models/recipientcreatetemplaterecipientaccessauthrequest.md @@ -1,10 +1,9 @@ # RecipientCreateTemplateRecipientAccessAuthRequest -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..484e2a1 100644 --- a/docs/models/recipientcreatetemplaterecipientaccessauthresponse.md +++ b/docs/models/recipientcreatetemplaterecipientaccessauthresponse.md @@ -1,10 +1,9 @@ # RecipientCreateTemplateRecipientAccessAuthResponse -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/recipientcreatetemplaterecipientactionauthrequest.md b/docs/models/recipientcreatetemplaterecipientactionauthrequest.md index 4302cbc..eaa577b 100644 --- a/docs/models/recipientcreatetemplaterecipientactionauthrequest.md +++ b/docs/models/recipientcreatetemplaterecipientactionauthrequest.md @@ -1,7 +1,5 @@ # RecipientCreateTemplateRecipientActionAuthRequest -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientcreatetemplaterecipientactionauthresponse.md b/docs/models/recipientcreatetemplaterecipientactionauthresponse.md index 20d3dfc..f8f08f0 100644 --- a/docs/models/recipientcreatetemplaterecipientactionauthresponse.md +++ b/docs/models/recipientcreatetemplaterecipientactionauthresponse.md @@ -1,7 +1,5 @@ # RecipientCreateTemplateRecipientActionAuthResponse -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientcreatetemplaterecipientforbiddenerror.md b/docs/models/recipientcreatetemplaterecipientforbiddenerror.md new file mode 100644 index 0000000..df5e0c9 --- /dev/null +++ b/docs/models/recipientcreatetemplaterecipientforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientCreateTemplateRecipientForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientCreateTemplateRecipientForbiddenIssue](../models/recipientcreatetemplaterecipientforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientforbiddenissue.md b/docs/models/recipientcreatetemplaterecipientforbiddenissue.md new file mode 100644 index 0000000..dddda96 --- /dev/null +++ b/docs/models/recipientcreatetemplaterecipientforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientCreateTemplateRecipientForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientresponse.md b/docs/models/recipientcreatetemplaterecipientresponse.md index 32ae203..5dcccc0 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 | @@ -21,5 +20,7 @@ Successful response | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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 +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `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..7e9ccc2 100644 --- a/docs/models/recipientcreatetemplaterecipientsaccessauthrequest.md +++ b/docs/models/recipientcreatetemplaterecipientsaccessauthrequest.md @@ -1,10 +1,9 @@ # RecipientCreateTemplateRecipientsAccessAuthRequest -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..0916855 100644 --- a/docs/models/recipientcreatetemplaterecipientsaccessauthresponse.md +++ b/docs/models/recipientcreatetemplaterecipientsaccessauthresponse.md @@ -1,10 +1,9 @@ # RecipientCreateTemplateRecipientsAccessAuthResponse -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/recipientcreatetemplaterecipientsactionauthrequest.md b/docs/models/recipientcreatetemplaterecipientsactionauthrequest.md index 24bc664..7c77e5e 100644 --- a/docs/models/recipientcreatetemplaterecipientsactionauthrequest.md +++ b/docs/models/recipientcreatetemplaterecipientsactionauthrequest.md @@ -1,7 +1,5 @@ # RecipientCreateTemplateRecipientsActionAuthRequest -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientcreatetemplaterecipientsactionauthresponse.md b/docs/models/recipientcreatetemplaterecipientsactionauthresponse.md index 7279747..d1b9516 100644 --- a/docs/models/recipientcreatetemplaterecipientsactionauthresponse.md +++ b/docs/models/recipientcreatetemplaterecipientsactionauthresponse.md @@ -1,7 +1,5 @@ # RecipientCreateTemplateRecipientsActionAuthResponse -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientcreatetemplaterecipientsforbiddenerror.md b/docs/models/recipientcreatetemplaterecipientsforbiddenerror.md new file mode 100644 index 0000000..dc29ced --- /dev/null +++ b/docs/models/recipientcreatetemplaterecipientsforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientCreateTemplateRecipientsForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientCreateTemplateRecipientsForbiddenIssue](../models/recipientcreatetemplaterecipientsforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientsforbiddenissue.md b/docs/models/recipientcreatetemplaterecipientsforbiddenissue.md new file mode 100644 index 0000000..511cd8f --- /dev/null +++ b/docs/models/recipientcreatetemplaterecipientsforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientCreateTemplateRecipientsForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientsrecipientresponse.md b/docs/models/recipientcreatetemplaterecipientsrecipientresponse.md index 3eb8df2..bc223a2 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 | @@ -19,5 +18,7 @@ | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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 +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `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/documentgetdocumentwithdetailsbyidinternalservererror.md b/docs/models/recipientcreatetemplaterecipientsunauthorizederror.md similarity index 53% rename from docs/models/documentgetdocumentwithdetailsbyidinternalservererror.md rename to docs/models/recipientcreatetemplaterecipientsunauthorizederror.md index 5a84970..86be869 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidinternalservererror.md +++ b/docs/models/recipientcreatetemplaterecipientsunauthorizederror.md @@ -1,12 +1,12 @@ -# DocumentGetDocumentWithDetailsByIDInternalServerError +# RecipientCreateTemplateRecipientsUnauthorizedError -Internal server error +Authorization not provided ## 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.RecipientCreateTemplateRecipientsUnauthorizedIssue](../models/recipientcreatetemplaterecipientsunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientsunauthorizedissue.md b/docs/models/recipientcreatetemplaterecipientsunauthorizedissue.md new file mode 100644 index 0000000..1778283 --- /dev/null +++ b/docs/models/recipientcreatetemplaterecipientsunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientCreateTemplateRecipientsUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/documentduplicatedocumentinternalservererror.md b/docs/models/recipientcreatetemplaterecipientunauthorizederror.md similarity index 92% rename from docs/models/documentduplicatedocumentinternalservererror.md rename to docs/models/recipientcreatetemplaterecipientunauthorizederror.md index 9f22233..eea1e60 100644 --- a/docs/models/documentduplicatedocumentinternalservererror.md +++ b/docs/models/recipientcreatetemplaterecipientunauthorizederror.md @@ -1,6 +1,6 @@ -# DocumentDuplicateDocumentInternalServerError +# RecipientCreateTemplateRecipientUnauthorizedError -Internal server error +Authorization not provided ## 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.DocumentDuplicateDocumentInternalServerErrorIssue](../models/documentduplicatedocumentinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `issues` | List[[models.RecipientCreateTemplateRecipientUnauthorizedIssue](../models/recipientcreatetemplaterecipientunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientcreatetemplaterecipientunauthorizedissue.md b/docs/models/recipientcreatetemplaterecipientunauthorizedissue.md new file mode 100644 index 0000000..a61b68e --- /dev/null +++ b/docs/models/recipientcreatetemplaterecipientunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientCreateTemplateRecipientUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientdeletedocumentrecipientforbiddenerror.md b/docs/models/recipientdeletedocumentrecipientforbiddenerror.md new file mode 100644 index 0000000..676002b --- /dev/null +++ b/docs/models/recipientdeletedocumentrecipientforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientDeleteDocumentRecipientForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientDeleteDocumentRecipientForbiddenIssue](../models/recipientdeletedocumentrecipientforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientdeletedocumentrecipientforbiddenissue.md b/docs/models/recipientdeletedocumentrecipientforbiddenissue.md new file mode 100644 index 0000000..aa70a8e --- /dev/null +++ b/docs/models/recipientdeletedocumentrecipientforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientDeleteDocumentRecipientForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientdeletedocumentrecipientunauthorizederror.md b/docs/models/recipientdeletedocumentrecipientunauthorizederror.md new file mode 100644 index 0000000..64be29d --- /dev/null +++ b/docs/models/recipientdeletedocumentrecipientunauthorizederror.md @@ -0,0 +1,12 @@ +# RecipientDeleteDocumentRecipientUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientDeleteDocumentRecipientUnauthorizedIssue](../models/recipientdeletedocumentrecipientunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientdeletedocumentrecipientunauthorizedissue.md b/docs/models/recipientdeletedocumentrecipientunauthorizedissue.md new file mode 100644 index 0000000..c5129e5 --- /dev/null +++ b/docs/models/recipientdeletedocumentrecipientunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientDeleteDocumentRecipientUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientdeletetemplaterecipientforbiddenerror.md b/docs/models/recipientdeletetemplaterecipientforbiddenerror.md new file mode 100644 index 0000000..40d203f --- /dev/null +++ b/docs/models/recipientdeletetemplaterecipientforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientDeleteTemplateRecipientForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientDeleteTemplateRecipientForbiddenIssue](../models/recipientdeletetemplaterecipientforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientdeletetemplaterecipientforbiddenissue.md b/docs/models/recipientdeletetemplaterecipientforbiddenissue.md new file mode 100644 index 0000000..16e4189 --- /dev/null +++ b/docs/models/recipientdeletetemplaterecipientforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientDeleteTemplateRecipientForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientdeletetemplaterecipientunauthorizederror.md b/docs/models/recipientdeletetemplaterecipientunauthorizederror.md new file mode 100644 index 0000000..7341894 --- /dev/null +++ b/docs/models/recipientdeletetemplaterecipientunauthorizederror.md @@ -0,0 +1,12 @@ +# RecipientDeleteTemplateRecipientUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientDeleteTemplateRecipientUnauthorizedIssue](../models/recipientdeletetemplaterecipientunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientdeletetemplaterecipientunauthorizedissue.md b/docs/models/recipientdeletetemplaterecipientunauthorizedissue.md new file mode 100644 index 0000000..e8b559f --- /dev/null +++ b/docs/models/recipientdeletetemplaterecipientunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientDeleteTemplateRecipientUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientaccessauth.md b/docs/models/recipientgetdocumentrecipientaccessauth.md index 18c72b2..8b347b0 100644 --- a/docs/models/recipientgetdocumentrecipientaccessauth.md +++ b/docs/models/recipientgetdocumentrecipientaccessauth.md @@ -1,10 +1,9 @@ # RecipientGetDocumentRecipientAccessAuth -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/recipientgetdocumentrecipientactionauth.md b/docs/models/recipientgetdocumentrecipientactionauth.md index d6852f0..a41e29b 100644 --- a/docs/models/recipientgetdocumentrecipientactionauth.md +++ b/docs/models/recipientgetdocumentrecipientactionauth.md @@ -1,7 +1,5 @@ # RecipientGetDocumentRecipientActionAuth -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientgetdocumentrecipientdirection1.md b/docs/models/recipientgetdocumentrecipientdirection1.md new file mode 100644 index 0000000..8f0c3c5 --- /dev/null +++ b/docs/models/recipientgetdocumentrecipientdirection1.md @@ -0,0 +1,9 @@ +# RecipientGetDocumentRecipientDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientdirection2.md b/docs/models/recipientgetdocumentrecipientdirection2.md new file mode 100644 index 0000000..93d1a6a --- /dev/null +++ b/docs/models/recipientgetdocumentrecipientdirection2.md @@ -0,0 +1,9 @@ +# RecipientGetDocumentRecipientDirection2 + + +## 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..73ec724 100644 --- a/docs/models/recipientgetdocumentrecipientfield.md +++ b/docs/models/recipientgetdocumentrecipientfield.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..d179774 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetacheckbox.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetacheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.RecipientGetDocumentRecipientDirection2]](../models/recipientgetdocumentrecipientdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfieldmetadate.md b/docs/models/recipientgetdocumentrecipientfieldmetadate.md index 64b875c..c4ade29 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetadate.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetadate.md @@ -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.RecipientGetDocumentRecipientTypeDate](../models/recipientgetdocumentrecipienttypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetDocumentRecipientTypeDate](../models/recipientgetdocumentrecipienttypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientGetDocumentRecipientTextAlign4]](../models/recipientgetdocumentrecipienttextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfieldmetadropdown.md b/docs/models/recipientgetdocumentrecipientfieldmetadropdown.md index 66d5afc..096e4e8 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetadropdown.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientGetDocumentRecipientTypeDropdown](../models/recipientgetdocumentrecipienttypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.RecipientGetDocumentRecipientValue3](../models/recipientgetdocumentrecipientvalue3.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/recipientgetdocumentrecipientfieldmetaemail.md b/docs/models/recipientgetdocumentrecipientfieldmetaemail.md index 1eb2b7c..7ad1e2c 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetaemail.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetaemail.md @@ -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.RecipientGetDocumentRecipientTypeEmail](../models/recipientgetdocumentrecipienttypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetDocumentRecipientTypeEmail](../models/recipientgetdocumentrecipienttypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientGetDocumentRecipientTextAlign3]](../models/recipientgetdocumentrecipienttextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfieldmetainitials.md b/docs/models/recipientgetdocumentrecipientfieldmetainitials.md index fecf1e8..69c596d 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetainitials.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetainitials.md @@ -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.RecipientGetDocumentRecipientTypeInitials](../models/recipientgetdocumentrecipienttypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetDocumentRecipientTypeInitials](../models/recipientgetdocumentrecipienttypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientGetDocumentRecipientTextAlign1]](../models/recipientgetdocumentrecipienttextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfieldmetaname.md b/docs/models/recipientgetdocumentrecipientfieldmetaname.md index 5019032..5320fe7 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetaname.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetaname.md @@ -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.RecipientGetDocumentRecipientTypeName](../models/recipientgetdocumentrecipienttypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetDocumentRecipientTypeName](../models/recipientgetdocumentrecipienttypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientGetDocumentRecipientTextAlign2]](../models/recipientgetdocumentrecipienttextalign2.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..525f15f 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetanumber.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.RecipientGetDocumentRecipientTypeNumber](../models/recipientgetdocumentrecipienttypenumber.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.RecipientGetDocumentRecipientTextAlign6]](../models/recipientgetdocumentrecipienttextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetDocumentRecipientTypeNumber](../models/recipientgetdocumentrecipienttypenumber.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 | +| `text_align` | [Optional[models.RecipientGetDocumentRecipientTextAlign6]](../models/recipientgetdocumentrecipienttextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientGetDocumentRecipientVerticalAlign2]](../models/recipientgetdocumentrecipientverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfieldmetaradio.md b/docs/models/recipientgetdocumentrecipientfieldmetaradio.md index 8765490..743521d 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetaradio.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetaradio.md @@ -3,11 +3,13 @@ ## 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.RecipientGetDocumentRecipientTypeRadio](../models/recipientgetdocumentrecipienttyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientGetDocumentRecipientValue1](../models/recipientgetdocumentrecipientvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetDocumentRecipientTypeRadio](../models/recipientgetdocumentrecipienttyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientGetDocumentRecipientValue1](../models/recipientgetdocumentrecipientvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientGetDocumentRecipientDirection1]](../models/recipientgetdocumentrecipientdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfieldmetasignature.md b/docs/models/recipientgetdocumentrecipientfieldmetasignature.md new file mode 100644 index 0000000..93416a6 --- /dev/null +++ b/docs/models/recipientgetdocumentrecipientfieldmetasignature.md @@ -0,0 +1,13 @@ +# RecipientGetDocumentRecipientFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetDocumentRecipientTypeSignature](../models/recipientgetdocumentrecipienttypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfieldmetatext.md b/docs/models/recipientgetdocumentrecipientfieldmetatext.md index 469baa9..648ed71 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetatext.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.RecipientGetDocumentRecipientTypeText](../models/recipientgetdocumentrecipienttypetext.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.RecipientGetDocumentRecipientTextAlign5]](../models/recipientgetdocumentrecipienttextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetDocumentRecipientTypeText](../models/recipientgetdocumentrecipienttypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.RecipientGetDocumentRecipientTextAlign5]](../models/recipientgetdocumentrecipienttextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientGetDocumentRecipientVerticalAlign1]](../models/recipientgetdocumentrecipientverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientfieldmetaunion.md b/docs/models/recipientgetdocumentrecipientfieldmetaunion.md index 52d93af..64fccf5 100644 --- a/docs/models/recipientgetdocumentrecipientfieldmetaunion.md +++ b/docs/models/recipientgetdocumentrecipientfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.RecipientGetDocumentRecipientFieldMetaSignature` + +```python +value: models.RecipientGetDocumentRecipientFieldMetaSignature = /* values here */ +``` + ### `models.RecipientGetDocumentRecipientFieldMetaInitials` ```python diff --git a/docs/models/recipientgetdocumentrecipientforbiddenerror.md b/docs/models/recipientgetdocumentrecipientforbiddenerror.md new file mode 100644 index 0000000..9fcd347 --- /dev/null +++ b/docs/models/recipientgetdocumentrecipientforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientGetDocumentRecipientForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientGetDocumentRecipientForbiddenIssue](../models/recipientgetdocumentrecipientforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientforbiddenissue.md b/docs/models/recipientgetdocumentrecipientforbiddenissue.md new file mode 100644 index 0000000..52f825e --- /dev/null +++ b/docs/models/recipientgetdocumentrecipientforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientGetDocumentRecipientForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientresponse.md b/docs/models/recipientgetdocumentrecipientresponse.md index 9c76081..1687f1e 100644 --- a/docs/models/recipientgetdocumentrecipientresponse.md +++ b/docs/models/recipientgetdocumentrecipientresponse.md @@ -5,22 +5,23 @@ Successful response ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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.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 +| 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 | +| `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.RecipientGetDocumentRecipientAuthOptions]](../models/recipientgetdocumentrecipientauthoptions.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `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/recipientgetdocumentrecipienttypesignature.md b/docs/models/recipientgetdocumentrecipienttypesignature.md new file mode 100644 index 0000000..ef08439 --- /dev/null +++ b/docs/models/recipientgetdocumentrecipienttypesignature.md @@ -0,0 +1,8 @@ +# RecipientGetDocumentRecipientTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientunauthorizederror.md b/docs/models/recipientgetdocumentrecipientunauthorizederror.md new file mode 100644 index 0000000..076fa9b --- /dev/null +++ b/docs/models/recipientgetdocumentrecipientunauthorizederror.md @@ -0,0 +1,12 @@ +# RecipientGetDocumentRecipientUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientGetDocumentRecipientUnauthorizedIssue](../models/recipientgetdocumentrecipientunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientunauthorizedissue.md b/docs/models/recipientgetdocumentrecipientunauthorizedissue.md new file mode 100644 index 0000000..698be18 --- /dev/null +++ b/docs/models/recipientgetdocumentrecipientunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientGetDocumentRecipientUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientverticalalign1.md b/docs/models/recipientgetdocumentrecipientverticalalign1.md new file mode 100644 index 0000000..31247f4 --- /dev/null +++ b/docs/models/recipientgetdocumentrecipientverticalalign1.md @@ -0,0 +1,10 @@ +# RecipientGetDocumentRecipientVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientgetdocumentrecipientverticalalign2.md b/docs/models/recipientgetdocumentrecipientverticalalign2.md new file mode 100644 index 0000000..25d63e9 --- /dev/null +++ b/docs/models/recipientgetdocumentrecipientverticalalign2.md @@ -0,0 +1,10 @@ +# RecipientGetDocumentRecipientVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientaccessauth.md b/docs/models/recipientgettemplaterecipientaccessauth.md index d1ceb74..ff7ce6f 100644 --- a/docs/models/recipientgettemplaterecipientaccessauth.md +++ b/docs/models/recipientgettemplaterecipientaccessauth.md @@ -1,10 +1,9 @@ # RecipientGetTemplateRecipientAccessAuth -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/recipientgettemplaterecipientactionauth.md b/docs/models/recipientgettemplaterecipientactionauth.md index 6de88bd..172ffee 100644 --- a/docs/models/recipientgettemplaterecipientactionauth.md +++ b/docs/models/recipientgettemplaterecipientactionauth.md @@ -1,7 +1,5 @@ # RecipientGetTemplateRecipientActionAuth -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientgettemplaterecipientdirection1.md b/docs/models/recipientgettemplaterecipientdirection1.md new file mode 100644 index 0000000..4895bbf --- /dev/null +++ b/docs/models/recipientgettemplaterecipientdirection1.md @@ -0,0 +1,9 @@ +# RecipientGetTemplateRecipientDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientdirection2.md b/docs/models/recipientgettemplaterecipientdirection2.md new file mode 100644 index 0000000..ac6f3b6 --- /dev/null +++ b/docs/models/recipientgettemplaterecipientdirection2.md @@ -0,0 +1,9 @@ +# RecipientGetTemplateRecipientDirection2 + + +## 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..fd55559 100644 --- a/docs/models/recipientgettemplaterecipientfield.md +++ b/docs/models/recipientgettemplaterecipientfield.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..4104f10 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetacheckbox.md +++ b/docs/models/recipientgettemplaterecipientfieldmetacheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.RecipientGetTemplateRecipientDirection2]](../models/recipientgettemplaterecipientdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfieldmetadate.md b/docs/models/recipientgettemplaterecipientfieldmetadate.md index 112e226..14d2cf4 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetadate.md +++ b/docs/models/recipientgettemplaterecipientfieldmetadate.md @@ -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.RecipientGetTemplateRecipientTypeDate](../models/recipientgettemplaterecipienttypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetTemplateRecipientTypeDate](../models/recipientgettemplaterecipienttypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientGetTemplateRecipientTextAlign4]](../models/recipientgettemplaterecipienttextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfieldmetadropdown.md b/docs/models/recipientgettemplaterecipientfieldmetadropdown.md index 8587a55..5ec5fe0 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetadropdown.md +++ b/docs/models/recipientgettemplaterecipientfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientGetTemplateRecipientTypeDropdown](../models/recipientgettemplaterecipienttypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.RecipientGetTemplateRecipientValue3](../models/recipientgettemplaterecipientvalue3.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/recipientgettemplaterecipientfieldmetaemail.md b/docs/models/recipientgettemplaterecipientfieldmetaemail.md index 0ad4d18..29394b5 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetaemail.md +++ b/docs/models/recipientgettemplaterecipientfieldmetaemail.md @@ -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.RecipientGetTemplateRecipientTypeEmail](../models/recipientgettemplaterecipienttypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetTemplateRecipientTypeEmail](../models/recipientgettemplaterecipienttypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientGetTemplateRecipientTextAlign3]](../models/recipientgettemplaterecipienttextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfieldmetainitials.md b/docs/models/recipientgettemplaterecipientfieldmetainitials.md index 97ae59f..28ddfd4 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetainitials.md +++ b/docs/models/recipientgettemplaterecipientfieldmetainitials.md @@ -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.RecipientGetTemplateRecipientTypeInitials](../models/recipientgettemplaterecipienttypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetTemplateRecipientTypeInitials](../models/recipientgettemplaterecipienttypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientGetTemplateRecipientTextAlign1]](../models/recipientgettemplaterecipienttextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfieldmetaname.md b/docs/models/recipientgettemplaterecipientfieldmetaname.md index 36064c1..45015b7 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetaname.md +++ b/docs/models/recipientgettemplaterecipientfieldmetaname.md @@ -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.RecipientGetTemplateRecipientTypeName](../models/recipientgettemplaterecipienttypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetTemplateRecipientTypeName](../models/recipientgettemplaterecipienttypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientGetTemplateRecipientTextAlign2]](../models/recipientgettemplaterecipienttextalign2.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..d7f5e67 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetanumber.md +++ b/docs/models/recipientgettemplaterecipientfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.RecipientGetTemplateRecipientTypeNumber](../models/recipientgettemplaterecipienttypenumber.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.RecipientGetTemplateRecipientTextAlign6]](../models/recipientgettemplaterecipienttextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetTemplateRecipientTypeNumber](../models/recipientgettemplaterecipienttypenumber.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 | +| `text_align` | [Optional[models.RecipientGetTemplateRecipientTextAlign6]](../models/recipientgettemplaterecipienttextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientGetTemplateRecipientVerticalAlign2]](../models/recipientgettemplaterecipientverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfieldmetaradio.md b/docs/models/recipientgettemplaterecipientfieldmetaradio.md index 0441613..32666c6 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetaradio.md +++ b/docs/models/recipientgettemplaterecipientfieldmetaradio.md @@ -3,11 +3,13 @@ ## 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.RecipientGetTemplateRecipientTypeRadio](../models/recipientgettemplaterecipienttyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientGetTemplateRecipientValue1](../models/recipientgettemplaterecipientvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetTemplateRecipientTypeRadio](../models/recipientgettemplaterecipienttyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientGetTemplateRecipientValue1](../models/recipientgettemplaterecipientvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientGetTemplateRecipientDirection1]](../models/recipientgettemplaterecipientdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfieldmetasignature.md b/docs/models/recipientgettemplaterecipientfieldmetasignature.md new file mode 100644 index 0000000..c2eae0e --- /dev/null +++ b/docs/models/recipientgettemplaterecipientfieldmetasignature.md @@ -0,0 +1,13 @@ +# RecipientGetTemplateRecipientFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetTemplateRecipientTypeSignature](../models/recipientgettemplaterecipienttypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfieldmetatext.md b/docs/models/recipientgettemplaterecipientfieldmetatext.md index 1b17af3..0d118c7 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetatext.md +++ b/docs/models/recipientgettemplaterecipientfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.RecipientGetTemplateRecipientTypeText](../models/recipientgettemplaterecipienttypetext.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.RecipientGetTemplateRecipientTextAlign5]](../models/recipientgettemplaterecipienttextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientGetTemplateRecipientTypeText](../models/recipientgettemplaterecipienttypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.RecipientGetTemplateRecipientTextAlign5]](../models/recipientgettemplaterecipienttextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientGetTemplateRecipientVerticalAlign1]](../models/recipientgettemplaterecipientverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientfieldmetaunion.md b/docs/models/recipientgettemplaterecipientfieldmetaunion.md index 4f393d2..eda70f1 100644 --- a/docs/models/recipientgettemplaterecipientfieldmetaunion.md +++ b/docs/models/recipientgettemplaterecipientfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.RecipientGetTemplateRecipientFieldMetaSignature` + +```python +value: models.RecipientGetTemplateRecipientFieldMetaSignature = /* values here */ +``` + ### `models.RecipientGetTemplateRecipientFieldMetaInitials` ```python diff --git a/docs/models/recipientgettemplaterecipientforbiddenerror.md b/docs/models/recipientgettemplaterecipientforbiddenerror.md new file mode 100644 index 0000000..7a403f4 --- /dev/null +++ b/docs/models/recipientgettemplaterecipientforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientGetTemplateRecipientForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientGetTemplateRecipientForbiddenIssue](../models/recipientgettemplaterecipientforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientforbiddenissue.md b/docs/models/recipientgettemplaterecipientforbiddenissue.md new file mode 100644 index 0000000..2948ea5 --- /dev/null +++ b/docs/models/recipientgettemplaterecipientforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientGetTemplateRecipientForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientresponse.md b/docs/models/recipientgettemplaterecipientresponse.md index d04e7c3..fb0ffd2 100644 --- a/docs/models/recipientgettemplaterecipientresponse.md +++ b/docs/models/recipientgettemplaterecipientresponse.md @@ -5,22 +5,23 @@ Successful response ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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.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 +| 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 | +| `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.RecipientGetTemplateRecipientAuthOptions]](../models/recipientgettemplaterecipientauthoptions.md) | :heavy_check_mark: | N/A | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `rejection_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `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/recipientgettemplaterecipienttypesignature.md b/docs/models/recipientgettemplaterecipienttypesignature.md new file mode 100644 index 0000000..ac34781 --- /dev/null +++ b/docs/models/recipientgettemplaterecipienttypesignature.md @@ -0,0 +1,8 @@ +# RecipientGetTemplateRecipientTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientunauthorizederror.md b/docs/models/recipientgettemplaterecipientunauthorizederror.md new file mode 100644 index 0000000..5fe0846 --- /dev/null +++ b/docs/models/recipientgettemplaterecipientunauthorizederror.md @@ -0,0 +1,12 @@ +# RecipientGetTemplateRecipientUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientGetTemplateRecipientUnauthorizedIssue](../models/recipientgettemplaterecipientunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientunauthorizedissue.md b/docs/models/recipientgettemplaterecipientunauthorizedissue.md new file mode 100644 index 0000000..0c8ba60 --- /dev/null +++ b/docs/models/recipientgettemplaterecipientunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientGetTemplateRecipientUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientverticalalign1.md b/docs/models/recipientgettemplaterecipientverticalalign1.md new file mode 100644 index 0000000..d75d3c1 --- /dev/null +++ b/docs/models/recipientgettemplaterecipientverticalalign1.md @@ -0,0 +1,10 @@ +# RecipientGetTemplateRecipientVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientgettemplaterecipientverticalalign2.md b/docs/models/recipientgettemplaterecipientverticalalign2.md new file mode 100644 index 0000000..6aeeb7c --- /dev/null +++ b/docs/models/recipientgettemplaterecipientverticalalign2.md @@ -0,0 +1,10 @@ +# RecipientGetTemplateRecipientVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientaccessauthrequest.md b/docs/models/recipientupdatedocumentrecipientaccessauthrequest.md index 0c48261..01edcc6 100644 --- a/docs/models/recipientupdatedocumentrecipientaccessauthrequest.md +++ b/docs/models/recipientupdatedocumentrecipientaccessauthrequest.md @@ -1,10 +1,9 @@ # RecipientUpdateDocumentRecipientAccessAuthRequest -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..cb07d2c 100644 --- a/docs/models/recipientupdatedocumentrecipientaccessauthresponse.md +++ b/docs/models/recipientupdatedocumentrecipientaccessauthresponse.md @@ -1,10 +1,9 @@ # RecipientUpdateDocumentRecipientAccessAuthResponse -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/recipientupdatedocumentrecipientactionauthrequest.md b/docs/models/recipientupdatedocumentrecipientactionauthrequest.md index 2084019..fc0b8d8 100644 --- a/docs/models/recipientupdatedocumentrecipientactionauthrequest.md +++ b/docs/models/recipientupdatedocumentrecipientactionauthrequest.md @@ -1,7 +1,5 @@ # RecipientUpdateDocumentRecipientActionAuthRequest -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientupdatedocumentrecipientactionauthresponse.md b/docs/models/recipientupdatedocumentrecipientactionauthresponse.md index b44725c..200f96a 100644 --- a/docs/models/recipientupdatedocumentrecipientactionauthresponse.md +++ b/docs/models/recipientupdatedocumentrecipientactionauthresponse.md @@ -1,7 +1,5 @@ # RecipientUpdateDocumentRecipientActionAuthResponse -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientupdatedocumentrecipientdirection1.md b/docs/models/recipientupdatedocumentrecipientdirection1.md new file mode 100644 index 0000000..974fc47 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientdirection1.md @@ -0,0 +1,9 @@ +# RecipientUpdateDocumentRecipientDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientdirection2.md b/docs/models/recipientupdatedocumentrecipientdirection2.md new file mode 100644 index 0000000..11416d0 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientdirection2.md @@ -0,0 +1,9 @@ +# RecipientUpdateDocumentRecipientDirection2 + + +## 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..7a077c0 100644 --- a/docs/models/recipientupdatedocumentrecipientfield.md +++ b/docs/models/recipientupdatedocumentrecipientfield.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..309976d 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetacheckbox.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetacheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.RecipientUpdateDocumentRecipientDirection2]](../models/recipientupdatedocumentrecipientdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfieldmetadate.md b/docs/models/recipientupdatedocumentrecipientfieldmetadate.md index 0ead9ec..85fdc17 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetadate.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetadate.md @@ -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.RecipientUpdateDocumentRecipientTypeDate](../models/recipientupdatedocumentrecipienttypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientTypeDate](../models/recipientupdatedocumentrecipienttypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateDocumentRecipientTextAlign4]](../models/recipientupdatedocumentrecipienttextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfieldmetadropdown.md b/docs/models/recipientupdatedocumentrecipientfieldmetadropdown.md index 63c57c3..0c53de9 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetadropdown.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientUpdateDocumentRecipientTypeDropdown](../models/recipientupdatedocumentrecipienttypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.RecipientUpdateDocumentRecipientValue3](../models/recipientupdatedocumentrecipientvalue3.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/recipientupdatedocumentrecipientfieldmetaemail.md b/docs/models/recipientupdatedocumentrecipientfieldmetaemail.md index 249e748..45e5678 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetaemail.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetaemail.md @@ -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.RecipientUpdateDocumentRecipientTypeEmail](../models/recipientupdatedocumentrecipienttypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientTypeEmail](../models/recipientupdatedocumentrecipienttypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateDocumentRecipientTextAlign3]](../models/recipientupdatedocumentrecipienttextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfieldmetainitials.md b/docs/models/recipientupdatedocumentrecipientfieldmetainitials.md index 48ca2b6..f1ea8ac 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetainitials.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetainitials.md @@ -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.RecipientUpdateDocumentRecipientTypeInitials](../models/recipientupdatedocumentrecipienttypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientTypeInitials](../models/recipientupdatedocumentrecipienttypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateDocumentRecipientTextAlign1]](../models/recipientupdatedocumentrecipienttextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfieldmetaname.md b/docs/models/recipientupdatedocumentrecipientfieldmetaname.md index 4d282ae..7b31889 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetaname.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetaname.md @@ -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.RecipientUpdateDocumentRecipientTypeName](../models/recipientupdatedocumentrecipienttypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientTypeName](../models/recipientupdatedocumentrecipienttypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateDocumentRecipientTextAlign2]](../models/recipientupdatedocumentrecipienttextalign2.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..c2db175 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetanumber.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.RecipientUpdateDocumentRecipientTypeNumber](../models/recipientupdatedocumentrecipienttypenumber.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.RecipientUpdateDocumentRecipientTextAlign6]](../models/recipientupdatedocumentrecipienttextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientTypeNumber](../models/recipientupdatedocumentrecipienttypenumber.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 | +| `text_align` | [Optional[models.RecipientUpdateDocumentRecipientTextAlign6]](../models/recipientupdatedocumentrecipienttextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientUpdateDocumentRecipientVerticalAlign2]](../models/recipientupdatedocumentrecipientverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfieldmetaradio.md b/docs/models/recipientupdatedocumentrecipientfieldmetaradio.md index 8001c14..f86f3a7 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetaradio.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetaradio.md @@ -3,11 +3,13 @@ ## 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.RecipientUpdateDocumentRecipientTypeRadio](../models/recipientupdatedocumentrecipienttyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientUpdateDocumentRecipientValue1](../models/recipientupdatedocumentrecipientvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientTypeRadio](../models/recipientupdatedocumentrecipienttyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientUpdateDocumentRecipientValue1](../models/recipientupdatedocumentrecipientvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientUpdateDocumentRecipientDirection1]](../models/recipientupdatedocumentrecipientdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfieldmetasignature.md b/docs/models/recipientupdatedocumentrecipientfieldmetasignature.md new file mode 100644 index 0000000..0b56b52 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientfieldmetasignature.md @@ -0,0 +1,13 @@ +# RecipientUpdateDocumentRecipientFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientTypeSignature](../models/recipientupdatedocumentrecipienttypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfieldmetatext.md b/docs/models/recipientupdatedocumentrecipientfieldmetatext.md index 8f1e8dd..7cce092 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetatext.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.RecipientUpdateDocumentRecipientTypeText](../models/recipientupdatedocumentrecipienttypetext.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.RecipientUpdateDocumentRecipientTextAlign5]](../models/recipientupdatedocumentrecipienttextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientTypeText](../models/recipientupdatedocumentrecipienttypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.RecipientUpdateDocumentRecipientTextAlign5]](../models/recipientupdatedocumentrecipienttextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientUpdateDocumentRecipientVerticalAlign1]](../models/recipientupdatedocumentrecipientverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientfieldmetaunion.md b/docs/models/recipientupdatedocumentrecipientfieldmetaunion.md index adfd21f..1e079d4 100644 --- a/docs/models/recipientupdatedocumentrecipientfieldmetaunion.md +++ b/docs/models/recipientupdatedocumentrecipientfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.RecipientUpdateDocumentRecipientFieldMetaSignature` + +```python +value: models.RecipientUpdateDocumentRecipientFieldMetaSignature = /* values here */ +``` + ### `models.RecipientUpdateDocumentRecipientFieldMetaInitials` ```python diff --git a/docs/models/recipientupdatedocumentrecipientforbiddenerror.md b/docs/models/recipientupdatedocumentrecipientforbiddenerror.md new file mode 100644 index 0000000..78c3900 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientUpdateDocumentRecipientForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientUpdateDocumentRecipientForbiddenIssue](../models/recipientupdatedocumentrecipientforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientforbiddenissue.md b/docs/models/recipientupdatedocumentrecipientforbiddenissue.md new file mode 100644 index 0000000..588d762 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientUpdateDocumentRecipientForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientrecipient.md b/docs/models/recipientupdatedocumentrecipientrecipient.md index 7d41b41..11a6fe4 100644 --- a/docs/models/recipientupdatedocumentrecipientrecipient.md +++ b/docs/models/recipientupdatedocumentrecipientrecipient.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *float* | :heavy_check_mark: | The ID of the recipient to update. | +| `id` | *float* | :heavy_check_mark: | N/A | | `email` | *Optional[str]* | :heavy_minus_sign: | N/A | | `name` | *Optional[str]* | :heavy_minus_sign: | N/A | | `role` | [Optional[models.RecipientUpdateDocumentRecipientRoleRequest]](../models/recipientupdatedocumentrecipientrolerequest.md) | :heavy_minus_sign: | N/A | diff --git a/docs/models/recipientupdatedocumentrecipientresponse.md b/docs/models/recipientupdatedocumentrecipientresponse.md index 226bfa4..aca9b30 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 | @@ -21,6 +20,8 @@ Successful response | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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. | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | | `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..d58ece3 100644 --- a/docs/models/recipientupdatedocumentrecipientsaccessauthrequest.md +++ b/docs/models/recipientupdatedocumentrecipientsaccessauthrequest.md @@ -1,10 +1,9 @@ # RecipientUpdateDocumentRecipientsAccessAuthRequest -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..c7e0ca0 100644 --- a/docs/models/recipientupdatedocumentrecipientsaccessauthresponse.md +++ b/docs/models/recipientupdatedocumentrecipientsaccessauthresponse.md @@ -1,10 +1,9 @@ # RecipientUpdateDocumentRecipientsAccessAuthResponse -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/recipientupdatedocumentrecipientsactionauthrequest.md b/docs/models/recipientupdatedocumentrecipientsactionauthrequest.md index 8b04fa4..d77fef6 100644 --- a/docs/models/recipientupdatedocumentrecipientsactionauthrequest.md +++ b/docs/models/recipientupdatedocumentrecipientsactionauthrequest.md @@ -1,7 +1,5 @@ # RecipientUpdateDocumentRecipientsActionAuthRequest -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientupdatedocumentrecipientsactionauthresponse.md b/docs/models/recipientupdatedocumentrecipientsactionauthresponse.md index ec98b13..2931348 100644 --- a/docs/models/recipientupdatedocumentrecipientsactionauthresponse.md +++ b/docs/models/recipientupdatedocumentrecipientsactionauthresponse.md @@ -1,7 +1,5 @@ # RecipientUpdateDocumentRecipientsActionAuthResponse -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientupdatedocumentrecipientsdirection1.md b/docs/models/recipientupdatedocumentrecipientsdirection1.md new file mode 100644 index 0000000..930d41b --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientsdirection1.md @@ -0,0 +1,9 @@ +# RecipientUpdateDocumentRecipientsDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsdirection2.md b/docs/models/recipientupdatedocumentrecipientsdirection2.md new file mode 100644 index 0000000..0807ae0 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientsdirection2.md @@ -0,0 +1,9 @@ +# RecipientUpdateDocumentRecipientsDirection2 + + +## 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..bceda4b 100644 --- a/docs/models/recipientupdatedocumentrecipientsfield.md +++ b/docs/models/recipientupdatedocumentrecipientsfield.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..4571de7 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetacheckbox.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetacheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.RecipientUpdateDocumentRecipientsDirection2]](../models/recipientupdatedocumentrecipientsdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfieldmetadate.md b/docs/models/recipientupdatedocumentrecipientsfieldmetadate.md index 6eb86a5..bc8d44e 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetadate.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetadate.md @@ -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.RecipientUpdateDocumentRecipientsTypeDate](../models/recipientupdatedocumentrecipientstypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientsTypeDate](../models/recipientupdatedocumentrecipientstypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateDocumentRecipientsTextAlign4]](../models/recipientupdatedocumentrecipientstextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfieldmetadropdown.md b/docs/models/recipientupdatedocumentrecipientsfieldmetadropdown.md index 7da15db..2220d21 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetadropdown.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientUpdateDocumentRecipientsTypeDropdown](../models/recipientupdatedocumentrecipientstypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.RecipientUpdateDocumentRecipientsValue3](../models/recipientupdatedocumentrecipientsvalue3.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/recipientupdatedocumentrecipientsfieldmetaemail.md b/docs/models/recipientupdatedocumentrecipientsfieldmetaemail.md index 414f347..1c5264b 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetaemail.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetaemail.md @@ -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.RecipientUpdateDocumentRecipientsTypeEmail](../models/recipientupdatedocumentrecipientstypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientsTypeEmail](../models/recipientupdatedocumentrecipientstypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateDocumentRecipientsTextAlign3]](../models/recipientupdatedocumentrecipientstextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfieldmetainitials.md b/docs/models/recipientupdatedocumentrecipientsfieldmetainitials.md index e0b89a2..2109ce5 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetainitials.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetainitials.md @@ -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.RecipientUpdateDocumentRecipientsTypeInitials](../models/recipientupdatedocumentrecipientstypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientsTypeInitials](../models/recipientupdatedocumentrecipientstypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateDocumentRecipientsTextAlign1]](../models/recipientupdatedocumentrecipientstextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfieldmetaname.md b/docs/models/recipientupdatedocumentrecipientsfieldmetaname.md index 092b8bb..2fc8301 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetaname.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetaname.md @@ -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.RecipientUpdateDocumentRecipientsTypeName](../models/recipientupdatedocumentrecipientstypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientsTypeName](../models/recipientupdatedocumentrecipientstypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateDocumentRecipientsTextAlign2]](../models/recipientupdatedocumentrecipientstextalign2.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..09192ea 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetanumber.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.RecipientUpdateDocumentRecipientsTypeNumber](../models/recipientupdatedocumentrecipientstypenumber.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.RecipientUpdateDocumentRecipientsTextAlign6]](../models/recipientupdatedocumentrecipientstextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientsTypeNumber](../models/recipientupdatedocumentrecipientstypenumber.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 | +| `text_align` | [Optional[models.RecipientUpdateDocumentRecipientsTextAlign6]](../models/recipientupdatedocumentrecipientstextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientUpdateDocumentRecipientsVerticalAlign2]](../models/recipientupdatedocumentrecipientsverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfieldmetaradio.md b/docs/models/recipientupdatedocumentrecipientsfieldmetaradio.md index 7f72bec..72e7870 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetaradio.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetaradio.md @@ -3,11 +3,13 @@ ## 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.RecipientUpdateDocumentRecipientsTypeRadio](../models/recipientupdatedocumentrecipientstyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientUpdateDocumentRecipientsValue1](../models/recipientupdatedocumentrecipientsvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientsTypeRadio](../models/recipientupdatedocumentrecipientstyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientUpdateDocumentRecipientsValue1](../models/recipientupdatedocumentrecipientsvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientUpdateDocumentRecipientsDirection1]](../models/recipientupdatedocumentrecipientsdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfieldmetasignature.md b/docs/models/recipientupdatedocumentrecipientsfieldmetasignature.md new file mode 100644 index 0000000..bdcf137 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetasignature.md @@ -0,0 +1,13 @@ +# RecipientUpdateDocumentRecipientsFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientsTypeSignature](../models/recipientupdatedocumentrecipientstypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfieldmetatext.md b/docs/models/recipientupdatedocumentrecipientsfieldmetatext.md index 0b01484..c2139c1 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetatext.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.RecipientUpdateDocumentRecipientsTypeText](../models/recipientupdatedocumentrecipientstypetext.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.RecipientUpdateDocumentRecipientsTextAlign5]](../models/recipientupdatedocumentrecipientstextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateDocumentRecipientsTypeText](../models/recipientupdatedocumentrecipientstypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.RecipientUpdateDocumentRecipientsTextAlign5]](../models/recipientupdatedocumentrecipientstextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientUpdateDocumentRecipientsVerticalAlign1]](../models/recipientupdatedocumentrecipientsverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsfieldmetaunion.md b/docs/models/recipientupdatedocumentrecipientsfieldmetaunion.md index 678cc85..daa6b5f 100644 --- a/docs/models/recipientupdatedocumentrecipientsfieldmetaunion.md +++ b/docs/models/recipientupdatedocumentrecipientsfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.RecipientUpdateDocumentRecipientsFieldMetaSignature` + +```python +value: models.RecipientUpdateDocumentRecipientsFieldMetaSignature = /* values here */ +``` + ### `models.RecipientUpdateDocumentRecipientsFieldMetaInitials` ```python diff --git a/docs/models/recipientupdatedocumentrecipientsforbiddenerror.md b/docs/models/recipientupdatedocumentrecipientsforbiddenerror.md new file mode 100644 index 0000000..acd6281 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientsforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientUpdateDocumentRecipientsForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientUpdateDocumentRecipientsForbiddenIssue](../models/recipientupdatedocumentrecipientsforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsforbiddenissue.md b/docs/models/recipientupdatedocumentrecipientsforbiddenissue.md new file mode 100644 index 0000000..7b55174 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientsforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientUpdateDocumentRecipientsForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsrecipientrequest.md b/docs/models/recipientupdatedocumentrecipientsrecipientrequest.md index c9b37e2..64ead49 100644 --- a/docs/models/recipientupdatedocumentrecipientsrecipientrequest.md +++ b/docs/models/recipientupdatedocumentrecipientsrecipientrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *float* | :heavy_check_mark: | The ID of the recipient to update. | +| `id` | *float* | :heavy_check_mark: | N/A | | `email` | *Optional[str]* | :heavy_minus_sign: | N/A | | `name` | *Optional[str]* | :heavy_minus_sign: | N/A | | `role` | [Optional[models.RecipientUpdateDocumentRecipientsRoleRequest]](../models/recipientupdatedocumentrecipientsrolerequest.md) | :heavy_minus_sign: | N/A | diff --git a/docs/models/recipientupdatedocumentrecipientsrecipientresponse.md b/docs/models/recipientupdatedocumentrecipientsrecipientresponse.md index 9b11321..a4ca615 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 | @@ -19,6 +18,8 @@ | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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. | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | | `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/recipientupdatedocumentrecipientstypesignature.md b/docs/models/recipientupdatedocumentrecipientstypesignature.md new file mode 100644 index 0000000..0bd8085 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientstypesignature.md @@ -0,0 +1,8 @@ +# RecipientUpdateDocumentRecipientsTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsunauthorizederror.md b/docs/models/recipientupdatedocumentrecipientsunauthorizederror.md new file mode 100644 index 0000000..0603a24 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientsunauthorizederror.md @@ -0,0 +1,12 @@ +# RecipientUpdateDocumentRecipientsUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientUpdateDocumentRecipientsUnauthorizedIssue](../models/recipientupdatedocumentrecipientsunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsunauthorizedissue.md b/docs/models/recipientupdatedocumentrecipientsunauthorizedissue.md new file mode 100644 index 0000000..b6da226 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientsunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientUpdateDocumentRecipientsUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsverticalalign1.md b/docs/models/recipientupdatedocumentrecipientsverticalalign1.md new file mode 100644 index 0000000..225b009 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientsverticalalign1.md @@ -0,0 +1,10 @@ +# RecipientUpdateDocumentRecipientsVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientsverticalalign2.md b/docs/models/recipientupdatedocumentrecipientsverticalalign2.md new file mode 100644 index 0000000..aba15ec --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientsverticalalign2.md @@ -0,0 +1,10 @@ +# RecipientUpdateDocumentRecipientsVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipienttypesignature.md b/docs/models/recipientupdatedocumentrecipienttypesignature.md new file mode 100644 index 0000000..aa616c0 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipienttypesignature.md @@ -0,0 +1,8 @@ +# RecipientUpdateDocumentRecipientTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientunauthorizederror.md b/docs/models/recipientupdatedocumentrecipientunauthorizederror.md new file mode 100644 index 0000000..77b7642 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientunauthorizederror.md @@ -0,0 +1,12 @@ +# RecipientUpdateDocumentRecipientUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientUpdateDocumentRecipientUnauthorizedIssue](../models/recipientupdatedocumentrecipientunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientunauthorizedissue.md b/docs/models/recipientupdatedocumentrecipientunauthorizedissue.md new file mode 100644 index 0000000..16f510e --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientUpdateDocumentRecipientUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientverticalalign1.md b/docs/models/recipientupdatedocumentrecipientverticalalign1.md new file mode 100644 index 0000000..2451af3 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientverticalalign1.md @@ -0,0 +1,10 @@ +# RecipientUpdateDocumentRecipientVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientupdatedocumentrecipientverticalalign2.md b/docs/models/recipientupdatedocumentrecipientverticalalign2.md new file mode 100644 index 0000000..bc0e644 --- /dev/null +++ b/docs/models/recipientupdatedocumentrecipientverticalalign2.md @@ -0,0 +1,10 @@ +# RecipientUpdateDocumentRecipientVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientaccessauthrequest.md b/docs/models/recipientupdatetemplaterecipientaccessauthrequest.md index 3f14986..066d45d 100644 --- a/docs/models/recipientupdatetemplaterecipientaccessauthrequest.md +++ b/docs/models/recipientupdatetemplaterecipientaccessauthrequest.md @@ -1,10 +1,9 @@ # RecipientUpdateTemplateRecipientAccessAuthRequest -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..b9b1258 100644 --- a/docs/models/recipientupdatetemplaterecipientaccessauthresponse.md +++ b/docs/models/recipientupdatetemplaterecipientaccessauthresponse.md @@ -1,10 +1,9 @@ # RecipientUpdateTemplateRecipientAccessAuthResponse -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/recipientupdatetemplaterecipientactionauthrequest.md b/docs/models/recipientupdatetemplaterecipientactionauthrequest.md index 6229ed9..73aae2f 100644 --- a/docs/models/recipientupdatetemplaterecipientactionauthrequest.md +++ b/docs/models/recipientupdatetemplaterecipientactionauthrequest.md @@ -1,7 +1,5 @@ # RecipientUpdateTemplateRecipientActionAuthRequest -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientupdatetemplaterecipientactionauthresponse.md b/docs/models/recipientupdatetemplaterecipientactionauthresponse.md index c38d9b0..db11708 100644 --- a/docs/models/recipientupdatetemplaterecipientactionauthresponse.md +++ b/docs/models/recipientupdatetemplaterecipientactionauthresponse.md @@ -1,7 +1,5 @@ # RecipientUpdateTemplateRecipientActionAuthResponse -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientupdatetemplaterecipientdirection1.md b/docs/models/recipientupdatetemplaterecipientdirection1.md new file mode 100644 index 0000000..2ce3a48 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientdirection1.md @@ -0,0 +1,9 @@ +# RecipientUpdateTemplateRecipientDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientdirection2.md b/docs/models/recipientupdatetemplaterecipientdirection2.md new file mode 100644 index 0000000..6d19a94 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientdirection2.md @@ -0,0 +1,9 @@ +# RecipientUpdateTemplateRecipientDirection2 + + +## 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..650188f 100644 --- a/docs/models/recipientupdatetemplaterecipientfield.md +++ b/docs/models/recipientupdatetemplaterecipientfield.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..ae4a5d0 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetacheckbox.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetacheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.RecipientUpdateTemplateRecipientDirection2]](../models/recipientupdatetemplaterecipientdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfieldmetadate.md b/docs/models/recipientupdatetemplaterecipientfieldmetadate.md index d0b701a..5ea9f8f 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetadate.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetadate.md @@ -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.RecipientUpdateTemplateRecipientTypeDate](../models/recipientupdatetemplaterecipienttypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientTypeDate](../models/recipientupdatetemplaterecipienttypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateTemplateRecipientTextAlign4]](../models/recipientupdatetemplaterecipienttextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfieldmetadropdown.md b/docs/models/recipientupdatetemplaterecipientfieldmetadropdown.md index 3c26aaf..3b0259b 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetadropdown.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientUpdateTemplateRecipientTypeDropdown](../models/recipientupdatetemplaterecipienttypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.RecipientUpdateTemplateRecipientValue3](../models/recipientupdatetemplaterecipientvalue3.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/recipientupdatetemplaterecipientfieldmetaemail.md b/docs/models/recipientupdatetemplaterecipientfieldmetaemail.md index 0b68778..f8aa5fa 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetaemail.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetaemail.md @@ -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.RecipientUpdateTemplateRecipientTypeEmail](../models/recipientupdatetemplaterecipienttypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientTypeEmail](../models/recipientupdatetemplaterecipienttypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateTemplateRecipientTextAlign3]](../models/recipientupdatetemplaterecipienttextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfieldmetainitials.md b/docs/models/recipientupdatetemplaterecipientfieldmetainitials.md index 229a6c4..cfc10da 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetainitials.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetainitials.md @@ -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.RecipientUpdateTemplateRecipientTypeInitials](../models/recipientupdatetemplaterecipienttypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientTypeInitials](../models/recipientupdatetemplaterecipienttypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateTemplateRecipientTextAlign1]](../models/recipientupdatetemplaterecipienttextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfieldmetaname.md b/docs/models/recipientupdatetemplaterecipientfieldmetaname.md index 971b618..9e5bd34 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetaname.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetaname.md @@ -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.RecipientUpdateTemplateRecipientTypeName](../models/recipientupdatetemplaterecipienttypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientTypeName](../models/recipientupdatetemplaterecipienttypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateTemplateRecipientTextAlign2]](../models/recipientupdatetemplaterecipienttextalign2.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..5b6bd6c 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetanumber.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.RecipientUpdateTemplateRecipientTypeNumber](../models/recipientupdatetemplaterecipienttypenumber.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.RecipientUpdateTemplateRecipientTextAlign6]](../models/recipientupdatetemplaterecipienttextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientTypeNumber](../models/recipientupdatetemplaterecipienttypenumber.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 | +| `text_align` | [Optional[models.RecipientUpdateTemplateRecipientTextAlign6]](../models/recipientupdatetemplaterecipienttextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientUpdateTemplateRecipientVerticalAlign2]](../models/recipientupdatetemplaterecipientverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfieldmetaradio.md b/docs/models/recipientupdatetemplaterecipientfieldmetaradio.md index 978867f..92eb218 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetaradio.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetaradio.md @@ -3,11 +3,13 @@ ## 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.RecipientUpdateTemplateRecipientTypeRadio](../models/recipientupdatetemplaterecipienttyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientUpdateTemplateRecipientValue1](../models/recipientupdatetemplaterecipientvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientTypeRadio](../models/recipientupdatetemplaterecipienttyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientUpdateTemplateRecipientValue1](../models/recipientupdatetemplaterecipientvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientUpdateTemplateRecipientDirection1]](../models/recipientupdatetemplaterecipientdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfieldmetasignature.md b/docs/models/recipientupdatetemplaterecipientfieldmetasignature.md new file mode 100644 index 0000000..0acbf6c --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientfieldmetasignature.md @@ -0,0 +1,13 @@ +# RecipientUpdateTemplateRecipientFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientTypeSignature](../models/recipientupdatetemplaterecipienttypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfieldmetatext.md b/docs/models/recipientupdatetemplaterecipientfieldmetatext.md index cbf9e4c..206246d 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetatext.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.RecipientUpdateTemplateRecipientTypeText](../models/recipientupdatetemplaterecipienttypetext.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.RecipientUpdateTemplateRecipientTextAlign5]](../models/recipientupdatetemplaterecipienttextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientTypeText](../models/recipientupdatetemplaterecipienttypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.RecipientUpdateTemplateRecipientTextAlign5]](../models/recipientupdatetemplaterecipienttextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientUpdateTemplateRecipientVerticalAlign1]](../models/recipientupdatetemplaterecipientverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientfieldmetaunion.md b/docs/models/recipientupdatetemplaterecipientfieldmetaunion.md index 58f490c..ac270fe 100644 --- a/docs/models/recipientupdatetemplaterecipientfieldmetaunion.md +++ b/docs/models/recipientupdatetemplaterecipientfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.RecipientUpdateTemplateRecipientFieldMetaSignature` + +```python +value: models.RecipientUpdateTemplateRecipientFieldMetaSignature = /* values here */ +``` + ### `models.RecipientUpdateTemplateRecipientFieldMetaInitials` ```python diff --git a/docs/models/recipientupdatetemplaterecipientforbiddenerror.md b/docs/models/recipientupdatetemplaterecipientforbiddenerror.md new file mode 100644 index 0000000..98cbb84 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientUpdateTemplateRecipientForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientUpdateTemplateRecipientForbiddenIssue](../models/recipientupdatetemplaterecipientforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientforbiddenissue.md b/docs/models/recipientupdatetemplaterecipientforbiddenissue.md new file mode 100644 index 0000000..dd74f1d --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientUpdateTemplateRecipientForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientrecipient.md b/docs/models/recipientupdatetemplaterecipientrecipient.md index 949c5af..4f63ec9 100644 --- a/docs/models/recipientupdatetemplaterecipientrecipient.md +++ b/docs/models/recipientupdatetemplaterecipientrecipient.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *float* | :heavy_check_mark: | The ID of the recipient to update. | +| `id` | *float* | :heavy_check_mark: | N/A | | `email` | *Optional[str]* | :heavy_minus_sign: | N/A | | `name` | *Optional[str]* | :heavy_minus_sign: | N/A | | `role` | [Optional[models.RecipientUpdateTemplateRecipientRoleRequest]](../models/recipientupdatetemplaterecipientrolerequest.md) | :heavy_minus_sign: | N/A | diff --git a/docs/models/recipientupdatetemplaterecipientresponse.md b/docs/models/recipientupdatetemplaterecipientresponse.md index 8f94790..fdb9fd2 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 | @@ -21,6 +20,8 @@ Successful response | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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. | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | | `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..a368908 100644 --- a/docs/models/recipientupdatetemplaterecipientsaccessauthrequest.md +++ b/docs/models/recipientupdatetemplaterecipientsaccessauthrequest.md @@ -1,10 +1,9 @@ # RecipientUpdateTemplateRecipientsAccessAuthRequest -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..d80eef8 100644 --- a/docs/models/recipientupdatetemplaterecipientsaccessauthresponse.md +++ b/docs/models/recipientupdatetemplaterecipientsaccessauthresponse.md @@ -1,10 +1,9 @@ # RecipientUpdateTemplateRecipientsAccessAuthResponse -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/recipientupdatetemplaterecipientsactionauthrequest.md b/docs/models/recipientupdatetemplaterecipientsactionauthrequest.md index 686a96d..4d7dfbb 100644 --- a/docs/models/recipientupdatetemplaterecipientsactionauthrequest.md +++ b/docs/models/recipientupdatetemplaterecipientsactionauthrequest.md @@ -1,7 +1,5 @@ # RecipientUpdateTemplateRecipientsActionAuthRequest -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientupdatetemplaterecipientsactionauthresponse.md b/docs/models/recipientupdatetemplaterecipientsactionauthresponse.md index 2b36fc4..1232eb6 100644 --- a/docs/models/recipientupdatetemplaterecipientsactionauthresponse.md +++ b/docs/models/recipientupdatetemplaterecipientsactionauthresponse.md @@ -1,7 +1,5 @@ # RecipientUpdateTemplateRecipientsActionAuthResponse -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/recipientupdatetemplaterecipientsdirection1.md b/docs/models/recipientupdatetemplaterecipientsdirection1.md new file mode 100644 index 0000000..c2097f5 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientsdirection1.md @@ -0,0 +1,9 @@ +# RecipientUpdateTemplateRecipientsDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsdirection2.md b/docs/models/recipientupdatetemplaterecipientsdirection2.md new file mode 100644 index 0000000..29ad5cf --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientsdirection2.md @@ -0,0 +1,9 @@ +# RecipientUpdateTemplateRecipientsDirection2 + + +## 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..a456bc4 100644 --- a/docs/models/recipientupdatetemplaterecipientsfield.md +++ b/docs/models/recipientupdatetemplaterecipientsfield.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..6152f7d 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetacheckbox.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetacheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.RecipientUpdateTemplateRecipientsDirection2]](../models/recipientupdatetemplaterecipientsdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfieldmetadate.md b/docs/models/recipientupdatetemplaterecipientsfieldmetadate.md index 8a854bf..1acf9d4 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetadate.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetadate.md @@ -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.RecipientUpdateTemplateRecipientsTypeDate](../models/recipientupdatetemplaterecipientstypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientsTypeDate](../models/recipientupdatetemplaterecipientstypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateTemplateRecipientsTextAlign4]](../models/recipientupdatetemplaterecipientstextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfieldmetadropdown.md b/docs/models/recipientupdatetemplaterecipientsfieldmetadropdown.md index 70cc7d8..a1e5ef8 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetadropdown.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.RecipientUpdateTemplateRecipientsTypeDropdown](../models/recipientupdatetemplaterecipientstypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.RecipientUpdateTemplateRecipientsValue3](../models/recipientupdatetemplaterecipientsvalue3.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/recipientupdatetemplaterecipientsfieldmetaemail.md b/docs/models/recipientupdatetemplaterecipientsfieldmetaemail.md index 597e173..af4400f 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetaemail.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetaemail.md @@ -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.RecipientUpdateTemplateRecipientsTypeEmail](../models/recipientupdatetemplaterecipientstypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientsTypeEmail](../models/recipientupdatetemplaterecipientstypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateTemplateRecipientsTextAlign3]](../models/recipientupdatetemplaterecipientstextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfieldmetainitials.md b/docs/models/recipientupdatetemplaterecipientsfieldmetainitials.md index 53d83ec..d54b579 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetainitials.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetainitials.md @@ -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.RecipientUpdateTemplateRecipientsTypeInitials](../models/recipientupdatetemplaterecipientstypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientsTypeInitials](../models/recipientupdatetemplaterecipientstypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateTemplateRecipientsTextAlign1]](../models/recipientupdatetemplaterecipientstextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfieldmetaname.md b/docs/models/recipientupdatetemplaterecipientsfieldmetaname.md index a4f09a6..d989cac 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetaname.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetaname.md @@ -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.RecipientUpdateTemplateRecipientsTypeName](../models/recipientupdatetemplaterecipientstypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientsTypeName](../models/recipientupdatetemplaterecipientstypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.RecipientUpdateTemplateRecipientsTextAlign2]](../models/recipientupdatetemplaterecipientstextalign2.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..ed89e3d 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetanumber.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.RecipientUpdateTemplateRecipientsTypeNumber](../models/recipientupdatetemplaterecipientstypenumber.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.RecipientUpdateTemplateRecipientsTextAlign6]](../models/recipientupdatetemplaterecipientstextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientsTypeNumber](../models/recipientupdatetemplaterecipientstypenumber.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 | +| `text_align` | [Optional[models.RecipientUpdateTemplateRecipientsTextAlign6]](../models/recipientupdatetemplaterecipientstextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientUpdateTemplateRecipientsVerticalAlign2]](../models/recipientupdatetemplaterecipientsverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfieldmetaradio.md b/docs/models/recipientupdatetemplaterecipientsfieldmetaradio.md index cac4e73..40b13ac 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetaradio.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetaradio.md @@ -3,11 +3,13 @@ ## 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.RecipientUpdateTemplateRecipientsTypeRadio](../models/recipientupdatetemplaterecipientstyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.RecipientUpdateTemplateRecipientsValue1](../models/recipientupdatetemplaterecipientsvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientsTypeRadio](../models/recipientupdatetemplaterecipientstyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.RecipientUpdateTemplateRecipientsValue1](../models/recipientupdatetemplaterecipientsvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.RecipientUpdateTemplateRecipientsDirection1]](../models/recipientupdatetemplaterecipientsdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfieldmetasignature.md b/docs/models/recipientupdatetemplaterecipientsfieldmetasignature.md new file mode 100644 index 0000000..dcd4096 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetasignature.md @@ -0,0 +1,13 @@ +# RecipientUpdateTemplateRecipientsFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientsTypeSignature](../models/recipientupdatetemplaterecipientstypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfieldmetatext.md b/docs/models/recipientupdatetemplaterecipientsfieldmetatext.md index cacea7a..396fc07 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetatext.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.RecipientUpdateTemplateRecipientsTypeText](../models/recipientupdatetemplaterecipientstypetext.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.RecipientUpdateTemplateRecipientsTextAlign5]](../models/recipientupdatetemplaterecipientstextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.RecipientUpdateTemplateRecipientsTypeText](../models/recipientupdatetemplaterecipientstypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.RecipientUpdateTemplateRecipientsTextAlign5]](../models/recipientupdatetemplaterecipientstextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.RecipientUpdateTemplateRecipientsVerticalAlign1]](../models/recipientupdatetemplaterecipientsverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsfieldmetaunion.md b/docs/models/recipientupdatetemplaterecipientsfieldmetaunion.md index 9335832..d9ee0de 100644 --- a/docs/models/recipientupdatetemplaterecipientsfieldmetaunion.md +++ b/docs/models/recipientupdatetemplaterecipientsfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.RecipientUpdateTemplateRecipientsFieldMetaSignature` + +```python +value: models.RecipientUpdateTemplateRecipientsFieldMetaSignature = /* values here */ +``` + ### `models.RecipientUpdateTemplateRecipientsFieldMetaInitials` ```python diff --git a/docs/models/recipientupdatetemplaterecipientsforbiddenerror.md b/docs/models/recipientupdatetemplaterecipientsforbiddenerror.md new file mode 100644 index 0000000..7ca3030 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientsforbiddenerror.md @@ -0,0 +1,12 @@ +# RecipientUpdateTemplateRecipientsForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientUpdateTemplateRecipientsForbiddenIssue](../models/recipientupdatetemplaterecipientsforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsforbiddenissue.md b/docs/models/recipientupdatetemplaterecipientsforbiddenissue.md new file mode 100644 index 0000000..40c155c --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientsforbiddenissue.md @@ -0,0 +1,8 @@ +# RecipientUpdateTemplateRecipientsForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsrecipientrequest.md b/docs/models/recipientupdatetemplaterecipientsrecipientrequest.md index ae39616..51ee104 100644 --- a/docs/models/recipientupdatetemplaterecipientsrecipientrequest.md +++ b/docs/models/recipientupdatetemplaterecipientsrecipientrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *float* | :heavy_check_mark: | The ID of the recipient to update. | +| `id` | *float* | :heavy_check_mark: | N/A | | `email` | *Optional[str]* | :heavy_minus_sign: | N/A | | `name` | *Optional[str]* | :heavy_minus_sign: | N/A | | `role` | [Optional[models.RecipientUpdateTemplateRecipientsRoleRequest]](../models/recipientupdatetemplaterecipientsrolerequest.md) | :heavy_minus_sign: | N/A | diff --git a/docs/models/recipientupdatetemplaterecipientsrecipientresponse.md b/docs/models/recipientupdatetemplaterecipientsrecipientresponse.md index b7561cb..7d24d44 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 | @@ -19,6 +18,8 @@ | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `signed_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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. | +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | | `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/recipientupdatetemplaterecipientstypesignature.md b/docs/models/recipientupdatetemplaterecipientstypesignature.md new file mode 100644 index 0000000..fc92970 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientstypesignature.md @@ -0,0 +1,8 @@ +# RecipientUpdateTemplateRecipientsTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsunauthorizederror.md b/docs/models/recipientupdatetemplaterecipientsunauthorizederror.md new file mode 100644 index 0000000..e96479d --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientsunauthorizederror.md @@ -0,0 +1,12 @@ +# RecipientUpdateTemplateRecipientsUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientUpdateTemplateRecipientsUnauthorizedIssue](../models/recipientupdatetemplaterecipientsunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsunauthorizedissue.md b/docs/models/recipientupdatetemplaterecipientsunauthorizedissue.md new file mode 100644 index 0000000..028d793 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientsunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientUpdateTemplateRecipientsUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsverticalalign1.md b/docs/models/recipientupdatetemplaterecipientsverticalalign1.md new file mode 100644 index 0000000..92a2a18 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientsverticalalign1.md @@ -0,0 +1,10 @@ +# RecipientUpdateTemplateRecipientsVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientsverticalalign2.md b/docs/models/recipientupdatetemplaterecipientsverticalalign2.md new file mode 100644 index 0000000..a3f47f0 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientsverticalalign2.md @@ -0,0 +1,10 @@ +# RecipientUpdateTemplateRecipientsVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipienttypesignature.md b/docs/models/recipientupdatetemplaterecipienttypesignature.md new file mode 100644 index 0000000..96e664c --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipienttypesignature.md @@ -0,0 +1,8 @@ +# RecipientUpdateTemplateRecipientTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientunauthorizederror.md b/docs/models/recipientupdatetemplaterecipientunauthorizederror.md new file mode 100644 index 0000000..b431716 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientunauthorizederror.md @@ -0,0 +1,12 @@ +# RecipientUpdateTemplateRecipientUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.RecipientUpdateTemplateRecipientUnauthorizedIssue](../models/recipientupdatetemplaterecipientunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientunauthorizedissue.md b/docs/models/recipientupdatetemplaterecipientunauthorizedissue.md new file mode 100644 index 0000000..9b16d7e --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientunauthorizedissue.md @@ -0,0 +1,8 @@ +# RecipientUpdateTemplateRecipientUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientverticalalign1.md b/docs/models/recipientupdatetemplaterecipientverticalalign1.md new file mode 100644 index 0000000..9341208 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientverticalalign1.md @@ -0,0 +1,10 @@ +# RecipientUpdateTemplateRecipientVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/recipientupdatetemplaterecipientverticalalign2.md b/docs/models/recipientupdatetemplaterecipientverticalalign2.md new file mode 100644 index 0000000..ea9cfe3 --- /dev/null +++ b/docs/models/recipientupdatetemplaterecipientverticalalign2.md @@ -0,0 +1,10 @@ +# RecipientUpdateTemplateRecipientVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateaccessauth.md b/docs/models/templatecreatedocumentfromtemplateaccessauth.md index e8405e8..dbd9fa9 100644 --- a/docs/models/templatecreatedocumentfromtemplateaccessauth.md +++ b/docs/models/templatecreatedocumentfromtemplateaccessauth.md @@ -1,10 +1,9 @@ # TemplateCreateDocumentFromTemplateAccessAuth -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/templatecreatedocumentfromtemplateactionauth.md b/docs/models/templatecreatedocumentfromtemplateactionauth.md index 465d72f..c393201 100644 --- a/docs/models/templatecreatedocumentfromtemplateactionauth.md +++ b/docs/models/templatecreatedocumentfromtemplateactionauth.md @@ -1,7 +1,5 @@ # TemplateCreateDocumentFromTemplateActionAuth -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/templatecreatedocumentfromtemplatecustomdocumentdatum.md b/docs/models/templatecreatedocumentfromtemplatecustomdocumentdatum.md new file mode 100644 index 0000000..3b380a9 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplatecustomdocumentdatum.md @@ -0,0 +1,9 @@ +# TemplateCreateDocumentFromTemplateCustomDocumentDatum + + +## 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/templatecreatedocumentfromtemplatedirection1.md b/docs/models/templatecreatedocumentfromtemplatedirection1.md new file mode 100644 index 0000000..a4c2abd --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplatedirection1.md @@ -0,0 +1,9 @@ +# TemplateCreateDocumentFromTemplateDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatedirection2.md b/docs/models/templatecreatedocumentfromtemplatedirection2.md new file mode 100644 index 0000000..ef51279 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplatedirection2.md @@ -0,0 +1,9 @@ +# TemplateCreateDocumentFromTemplateDirection2 + + +## 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/templatecreatedocumentfromtemplateemailsettings.md b/docs/models/templatecreatedocumentfromtemplateemailsettings.md index 97d1eed..2356045 100644 --- a/docs/models/templatecreatedocumentfromtemplateemailsettings.md +++ b/docs/models/templatecreatedocumentfromtemplateemailsettings.md @@ -3,12 +3,12 @@ ## 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 +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateenvelopeitem.md b/docs/models/templatecreatedocumentfromtemplateenvelopeitem.md new file mode 100644 index 0000000..4ac6c98 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateenvelopeitem.md @@ -0,0 +1,9 @@ +# TemplateCreateDocumentFromTemplateEnvelopeItem + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefield.md b/docs/models/templatecreatedocumentfromtemplatefield.md index 9864607..2ea14bf 100644 --- a/docs/models/templatecreatedocumentfromtemplatefield.md +++ b/docs/models/templatecreatedocumentfromtemplatefield.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..0a18474 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetacheckbox.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetacheckbox.md @@ -9,7 +9,9 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `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.TemplateCreateDocumentFromTemplateDirection2]](../models/templatecreatedocumentfromtemplatedirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefieldmetadate.md b/docs/models/templatecreatedocumentfromtemplatefieldmetadate.md index 7ffb022..99333ab 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetadate.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetadate.md @@ -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.TemplateCreateDocumentFromTemplateFieldMetaTypeDate](../models/templatecreatedocumentfromtemplatefieldmetatypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateDocumentFromTemplateFieldMetaTypeDate](../models/templatecreatedocumentfromtemplatefieldmetatypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateCreateDocumentFromTemplateTextAlign4]](../models/templatecreatedocumentfromtemplatetextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefieldmetadropdown.md b/docs/models/templatecreatedocumentfromtemplatefieldmetadropdown.md index d6fa0cd..17c8225 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetadropdown.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.TemplateCreateDocumentFromTemplateFieldMetaTypeDropdown](../models/templatecreatedocumentfromtemplatefieldmetatypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.TemplateCreateDocumentFromTemplateValue3](../models/templatecreatedocumentfromtemplatevalue3.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/templatecreatedocumentfromtemplatefieldmetaemail.md b/docs/models/templatecreatedocumentfromtemplatefieldmetaemail.md index 906baa2..82990d6 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetaemail.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetaemail.md @@ -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.TemplateCreateDocumentFromTemplateTypeEmail](../models/templatecreatedocumentfromtemplatetypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateDocumentFromTemplateTypeEmail](../models/templatecreatedocumentfromtemplatetypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateCreateDocumentFromTemplateTextAlign3]](../models/templatecreatedocumentfromtemplatetextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefieldmetainitials.md b/docs/models/templatecreatedocumentfromtemplatefieldmetainitials.md index fe6b3f7..22aee80 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetainitials.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetainitials.md @@ -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.TemplateCreateDocumentFromTemplateTypeInitials](../models/templatecreatedocumentfromtemplatetypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateDocumentFromTemplateTypeInitials](../models/templatecreatedocumentfromtemplatetypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateCreateDocumentFromTemplateTextAlign1]](../models/templatecreatedocumentfromtemplatetextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefieldmetaname.md b/docs/models/templatecreatedocumentfromtemplatefieldmetaname.md index 6c2e433..08a666e 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetaname.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetaname.md @@ -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.TemplateCreateDocumentFromTemplateTypeName](../models/templatecreatedocumentfromtemplatetypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateDocumentFromTemplateTypeName](../models/templatecreatedocumentfromtemplatetypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateCreateDocumentFromTemplateTextAlign2]](../models/templatecreatedocumentfromtemplatetextalign2.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..27d70c9 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetanumber.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.TemplateCreateDocumentFromTemplateFieldMetaTypeNumber](../models/templatecreatedocumentfromtemplatefieldmetatypenumber.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.TemplateCreateDocumentFromTemplateTextAlign6]](../models/templatecreatedocumentfromtemplatetextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateDocumentFromTemplateFieldMetaTypeNumber](../models/templatecreatedocumentfromtemplatefieldmetatypenumber.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 | +| `text_align` | [Optional[models.TemplateCreateDocumentFromTemplateTextAlign6]](../models/templatecreatedocumentfromtemplatetextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.TemplateCreateDocumentFromTemplateVerticalAlign2]](../models/templatecreatedocumentfromtemplateverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefieldmetaradio.md b/docs/models/templatecreatedocumentfromtemplatefieldmetaradio.md index 831a68e..23b1452 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetaradio.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetaradio.md @@ -9,5 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.TemplateCreateDocumentFromTemplateFieldMetaTypeRadio](../models/templatecreatedocumentfromtemplatefieldmetatyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.TemplateCreateDocumentFromTemplateValue1](../models/templatecreatedocumentfromtemplatevalue1.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `values` | List[[models.TemplateCreateDocumentFromTemplateValue1](../models/templatecreatedocumentfromtemplatevalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.TemplateCreateDocumentFromTemplateDirection1]](../models/templatecreatedocumentfromtemplatedirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefieldmetasignature.md b/docs/models/templatecreatedocumentfromtemplatefieldmetasignature.md new file mode 100644 index 0000000..4962b7e --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetasignature.md @@ -0,0 +1,13 @@ +# TemplateCreateDocumentFromTemplateFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateDocumentFromTemplateTypeSignature](../models/templatecreatedocumentfromtemplatetypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefieldmetatext.md b/docs/models/templatecreatedocumentfromtemplatefieldmetatext.md index 9d69115..3d8dac6 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetatext.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetatext.md @@ -3,14 +3,17 @@ ## 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.TemplateCreateDocumentFromTemplateFieldMetaTypeText](../models/templatecreatedocumentfromtemplatefieldmetatypetext.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.TemplateCreateDocumentFromTemplateTextAlign5]](../models/templatecreatedocumentfromtemplatetextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateDocumentFromTemplateFieldMetaTypeText](../models/templatecreatedocumentfromtemplatefieldmetatypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.TemplateCreateDocumentFromTemplateTextAlign5]](../models/templatecreatedocumentfromtemplatetextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.TemplateCreateDocumentFromTemplateVerticalAlign1]](../models/templatecreatedocumentfromtemplateverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplatefieldmetaunion.md b/docs/models/templatecreatedocumentfromtemplatefieldmetaunion.md index 55e0e45..0381e7a 100644 --- a/docs/models/templatecreatedocumentfromtemplatefieldmetaunion.md +++ b/docs/models/templatecreatedocumentfromtemplatefieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.TemplateCreateDocumentFromTemplateFieldMetaSignature` + +```python +value: models.TemplateCreateDocumentFromTemplateFieldMetaSignature = /* values here */ +``` + ### `models.TemplateCreateDocumentFromTemplateFieldMetaInitials` ```python diff --git a/docs/models/templatecreatedocumentfromtemplateforbiddenerror.md b/docs/models/templatecreatedocumentfromtemplateforbiddenerror.md new file mode 100644 index 0000000..33e9cad --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateCreateDocumentFromTemplateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateCreateDocumentFromTemplateForbiddenIssue](../models/templatecreatedocumentfromtemplateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateforbiddenissue.md b/docs/models/templatecreatedocumentfromtemplateforbiddenissue.md new file mode 100644 index 0000000..a0a87ac --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateCreateDocumentFromTemplateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateglobalaccessauth.md b/docs/models/templatecreatedocumentfromtemplateglobalaccessauth.md index 81de543..f1e0011 100644 --- a/docs/models/templatecreatedocumentfromtemplateglobalaccessauth.md +++ b/docs/models/templatecreatedocumentfromtemplateglobalaccessauth.md @@ -1,10 +1,9 @@ # TemplateCreateDocumentFromTemplateGlobalAccessAuth -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/templatecreatedocumentfromtemplateglobalactionauth.md b/docs/models/templatecreatedocumentfromtemplateglobalactionauth.md index 3d82348..0669ce6 100644 --- a/docs/models/templatecreatedocumentfromtemplateglobalactionauth.md +++ b/docs/models/templatecreatedocumentfromtemplateglobalactionauth.md @@ -1,7 +1,5 @@ # TemplateCreateDocumentFromTemplateGlobalActionAuth -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. - ## Values diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldcheckbox.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldcheckbox.md new file mode 100644 index 0000000..4bc6433 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldcheckbox.md @@ -0,0 +1,11 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldCheckbox + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.TemplateCreateDocumentFromTemplatePrefillFieldTypeCheckbox](../models/templatecreatedocumentfromtemplateprefillfieldtypecheckbox.md) | :heavy_check_mark: | N/A | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | List[*str*] | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfielddate.md b/docs/models/templatecreatedocumentfromtemplateprefillfielddate.md new file mode 100644 index 0000000..90639a8 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfielddate.md @@ -0,0 +1,10 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldDate + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.TemplateCreateDocumentFromTemplatePrefillFieldTypeDate](../models/templatecreatedocumentfromtemplateprefillfieldtypedate.md) | :heavy_check_mark: | N/A | +| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfielddropdown.md b/docs/models/templatecreatedocumentfromtemplateprefillfielddropdown.md new file mode 100644 index 0000000..1fa282e --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfielddropdown.md @@ -0,0 +1,11 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldDropdown + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.TemplateCreateDocumentFromTemplatePrefillFieldTypeDropdown](../models/templatecreatedocumentfromtemplateprefillfieldtypedropdown.md) | :heavy_check_mark: | N/A | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldnumber.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldnumber.md new file mode 100644 index 0000000..6b4cd4b --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldnumber.md @@ -0,0 +1,12 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldNumber + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.TemplateCreateDocumentFromTemplatePrefillFieldTypeNumber](../models/templatecreatedocumentfromtemplateprefillfieldtypenumber.md) | :heavy_check_mark: | N/A | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldradio.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldradio.md new file mode 100644 index 0000000..8b57ada --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldradio.md @@ -0,0 +1,11 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldRadio + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [models.TemplateCreateDocumentFromTemplatePrefillFieldTypeRadio](../models/templatecreatedocumentfromtemplateprefillfieldtyperadio.md) | :heavy_check_mark: | N/A | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldtext.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldtext.md new file mode 100644 index 0000000..1c191f2 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldtext.md @@ -0,0 +1,12 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldText + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `type` | [models.TemplateCreateDocumentFromTemplatePrefillFieldTypeText](../models/templatecreatedocumentfromtemplateprefillfieldtypetext.md) | :heavy_check_mark: | N/A | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldtypecheckbox.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldtypecheckbox.md new file mode 100644 index 0000000..d07e464 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldtypecheckbox.md @@ -0,0 +1,8 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldTypeCheckbox + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldtypedate.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldtypedate.md new file mode 100644 index 0000000..bb6fb88 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldtypedate.md @@ -0,0 +1,8 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldTypeDate + + +## Values + +| Name | Value | +| ------ | ------ | +| `DATE` | date | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldtypedropdown.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldtypedropdown.md new file mode 100644 index 0000000..853055d --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldtypedropdown.md @@ -0,0 +1,8 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldTypeDropdown + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DROPDOWN` | dropdown | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldtypenumber.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldtypenumber.md new file mode 100644 index 0000000..fd46a21 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldtypenumber.md @@ -0,0 +1,8 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldTypeNumber + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldtyperadio.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldtyperadio.md new file mode 100644 index 0000000..ddc312c --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldtyperadio.md @@ -0,0 +1,8 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldTypeRadio + + +## Values + +| Name | Value | +| ------- | ------- | +| `RADIO` | radio | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldtypetext.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldtypetext.md new file mode 100644 index 0000000..1ae367d --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldtypetext.md @@ -0,0 +1,8 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldTypeText + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateprefillfieldunion.md b/docs/models/templatecreatedocumentfromtemplateprefillfieldunion.md new file mode 100644 index 0000000..e5dabf2 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateprefillfieldunion.md @@ -0,0 +1,41 @@ +# TemplateCreateDocumentFromTemplatePrefillFieldUnion + + +## Supported Types + +### `models.TemplateCreateDocumentFromTemplatePrefillFieldText` + +```python +value: models.TemplateCreateDocumentFromTemplatePrefillFieldText = /* values here */ +``` + +### `models.TemplateCreateDocumentFromTemplatePrefillFieldNumber` + +```python +value: models.TemplateCreateDocumentFromTemplatePrefillFieldNumber = /* values here */ +``` + +### `models.TemplateCreateDocumentFromTemplatePrefillFieldRadio` + +```python +value: models.TemplateCreateDocumentFromTemplatePrefillFieldRadio = /* values here */ +``` + +### `models.TemplateCreateDocumentFromTemplatePrefillFieldCheckbox` + +```python +value: models.TemplateCreateDocumentFromTemplatePrefillFieldCheckbox = /* values here */ +``` + +### `models.TemplateCreateDocumentFromTemplatePrefillFieldDropdown` + +```python +value: models.TemplateCreateDocumentFromTemplatePrefillFieldDropdown = /* values here */ +``` + +### `models.TemplateCreateDocumentFromTemplatePrefillFieldDate` + +```python +value: models.TemplateCreateDocumentFromTemplatePrefillFieldDate = /* values here */ +``` + diff --git a/docs/models/templatecreatedocumentfromtemplaterecipientrequest.md b/docs/models/templatecreatedocumentfromtemplaterecipientrequest.md index d67b025..931d508 100644 --- a/docs/models/templatecreatedocumentfromtemplaterecipientrequest.md +++ b/docs/models/templatecreatedocumentfromtemplaterecipientrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `id` | *float* | :heavy_check_mark: | The ID of the recipient in the template. | -| `email` | *str* | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *float* | :heavy_check_mark: | N/A | +| `email` | *str* | :heavy_check_mark: | N/A | +| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplaterecipientresponse.md b/docs/models/templatecreatedocumentfromtemplaterecipientresponse.md index 5f421a2..ebc9b63 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 | @@ -19,5 +18,7 @@ | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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 +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `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..b03022f 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: | N/A | +| `distribute_document` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `custom_document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `custom_document_data` | List[[models.TemplateCreateDocumentFromTemplateCustomDocumentDatum](../models/templatecreatedocumentfromtemplatecustomdocumentdatum.md)] | :heavy_minus_sign: | N/A | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `prefill_fields` | List[[models.TemplateCreateDocumentFromTemplatePrefillFieldUnion](../models/templatecreatedocumentfromtemplateprefillfieldunion.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateresponse.md b/docs/models/templatecreatedocumentfromtemplateresponse.md index 909b578..a34bc90 100644 --- a/docs/models/templatecreatedocumentfromtemplateresponse.md +++ b/docs/models/templatecreatedocumentfromtemplateresponse.md @@ -11,21 +11,24 @@ Successful response | `status` | [models.TemplateCreateDocumentFromTemplateStatus](../models/templatecreatedocumentfromtemplatestatus.md) | :heavy_check_mark: | N/A | | `source` | [models.TemplateCreateDocumentFromTemplateSource](../models/templatecreatedocumentfromtemplatesource.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. | +| `external_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `user_id` | *float* | :heavy_check_mark: | N/A | | `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 | +| `internal_version` | *float* | :heavy_check_mark: | N/A | +| `template_id` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `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 | +| `envelope_items` | List[[models.TemplateCreateDocumentFromTemplateEnvelopeItem](../models/templatecreatedocumentfromtemplateenvelopeitem.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/templatecreatedocumentfromtemplatetypesignature.md b/docs/models/templatecreatedocumentfromtemplatetypesignature.md new file mode 100644 index 0000000..bef8573 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplatetypesignature.md @@ -0,0 +1,8 @@ +# TemplateCreateDocumentFromTemplateTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateunauthorizederror.md b/docs/models/templatecreatedocumentfromtemplateunauthorizederror.md new file mode 100644 index 0000000..df0cc00 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateCreateDocumentFromTemplateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateCreateDocumentFromTemplateUnauthorizedIssue](../models/templatecreatedocumentfromtemplateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateunauthorizedissue.md b/docs/models/templatecreatedocumentfromtemplateunauthorizedissue.md new file mode 100644 index 0000000..ed5b8a3 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateCreateDocumentFromTemplateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateverticalalign1.md b/docs/models/templatecreatedocumentfromtemplateverticalalign1.md new file mode 100644 index 0000000..f3332a0 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateverticalalign1.md @@ -0,0 +1,10 @@ +# TemplateCreateDocumentFromTemplateVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/templatecreatedocumentfromtemplateverticalalign2.md b/docs/models/templatecreatedocumentfromtemplateverticalalign2.md new file mode 100644 index 0000000..cb9bfb6 --- /dev/null +++ b/docs/models/templatecreatedocumentfromtemplateverticalalign2.md @@ -0,0 +1,10 @@ +# TemplateCreateDocumentFromTemplateVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/templatecreatetemplateattachment.md b/docs/models/templatecreatetemplateattachment.md new file mode 100644 index 0000000..d41a4eb --- /dev/null +++ b/docs/models/templatecreatetemplateattachment.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateAttachment + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | +| `type` | [Optional[models.TemplateCreateTemplateTypeLink]](../models/templatecreatetemplatetypelink.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatebadrequesterror.md b/docs/models/templatecreatetemplatebadrequesterror.md new file mode 100644 index 0000000..e900bdd --- /dev/null +++ b/docs/models/templatecreatetemplatebadrequesterror.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateBadRequestError + +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.TemplateCreateTemplateBadRequestIssue](../models/templatecreatetemplatebadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatebadrequestissue.md b/docs/models/templatecreatetemplatebadrequestissue.md new file mode 100644 index 0000000..258d9a8 --- /dev/null +++ b/docs/models/templatecreatetemplatebadrequestissue.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatedateformat.md b/docs/models/templatecreatetemplatedateformat.md new file mode 100644 index 0000000..24c46d6 --- /dev/null +++ b/docs/models/templatecreatetemplatedateformat.md @@ -0,0 +1,29 @@ +# TemplateCreateTemplateDateFormat + + +## 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/templatecreatetemplatedirectlinkforbiddenerror.md b/docs/models/templatecreatetemplatedirectlinkforbiddenerror.md new file mode 100644 index 0000000..ca37ef9 --- /dev/null +++ b/docs/models/templatecreatetemplatedirectlinkforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateDirectLinkForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateCreateTemplateDirectLinkForbiddenIssue](../models/templatecreatetemplatedirectlinkforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatedirectlinkforbiddenissue.md b/docs/models/templatecreatetemplatedirectlinkforbiddenissue.md new file mode 100644 index 0000000..da70c75 --- /dev/null +++ b/docs/models/templatecreatetemplatedirectlinkforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateDirectLinkForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatedirectlinkrequest.md b/docs/models/templatecreatetemplatedirectlinkrequest.md index 46036e1..e23a3db 100644 --- a/docs/models/templatecreatetemplatedirectlinkrequest.md +++ b/docs/models/templatecreatetemplatedirectlinkrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `template_id` | *float* | :heavy_check_mark: | N/A | -| `direct_recipient_id` | *Optional[float]* | :heavy_minus_sign: | The of the recipient in the current template to transform into the primary recipient when the template is used. | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------- | --------------------- | --------------------- | --------------------- | +| `template_id` | *float* | :heavy_check_mark: | N/A | +| `direct_recipient_id` | *Optional[float]* | :heavy_minus_sign: | 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/templatecreatetemplatedirectlinkunauthorizederror.md b/docs/models/templatecreatetemplatedirectlinkunauthorizederror.md new file mode 100644 index 0000000..5649ae6 --- /dev/null +++ b/docs/models/templatecreatetemplatedirectlinkunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateDirectLinkUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateCreateTemplateDirectLinkUnauthorizedIssue](../models/templatecreatetemplatedirectlinkunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatedirectlinkunauthorizedissue.md b/docs/models/templatecreatetemplatedirectlinkunauthorizedissue.md new file mode 100644 index 0000000..5124dc0 --- /dev/null +++ b/docs/models/templatecreatetemplatedirectlinkunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateDirectLinkUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatedistributionmethod.md b/docs/models/templatecreatetemplatedistributionmethod.md new file mode 100644 index 0000000..fd26619 --- /dev/null +++ b/docs/models/templatecreatetemplatedistributionmethod.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/templatecreatetemplateemailsettings.md b/docs/models/templatecreatetemplateemailsettings.md new file mode 100644 index 0000000..560d102 --- /dev/null +++ b/docs/models/templatecreatetemplateemailsettings.md @@ -0,0 +1,14 @@ +# TemplateCreateTemplateEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatefile.md b/docs/models/templatecreatetemplatefile.md new file mode 100644 index 0000000..6938ec1 --- /dev/null +++ b/docs/models/templatecreatetemplatefile.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateFile + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `file_name` | *str* | :heavy_check_mark: | N/A | +| `content` | *Union[bytes, IO[bytes], io.BufferedReader]* | :heavy_check_mark: | N/A | +| `content_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplateforbiddenerror.md b/docs/models/templatecreatetemplateforbiddenerror.md new file mode 100644 index 0000000..79572c9 --- /dev/null +++ b/docs/models/templatecreatetemplateforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateCreateTemplateForbiddenIssue](../models/templatecreatetemplateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplateforbiddenissue.md b/docs/models/templatecreatetemplateforbiddenissue.md new file mode 100644 index 0000000..d78b128 --- /dev/null +++ b/docs/models/templatecreatetemplateforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplateglobalaccessauth.md b/docs/models/templatecreatetemplateglobalaccessauth.md new file mode 100644 index 0000000..3704fb4 --- /dev/null +++ b/docs/models/templatecreatetemplateglobalaccessauth.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateGlobalAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templatecreatetemplateglobalactionauth.md b/docs/models/templatecreatetemplateglobalactionauth.md new file mode 100644 index 0000000..a7aeb87 --- /dev/null +++ b/docs/models/templatecreatetemplateglobalactionauth.md @@ -0,0 +1,11 @@ +# TemplateCreateTemplateGlobalActionAuth + + +## 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/templatecreatetemplateinternalservererror.md b/docs/models/templatecreatetemplateinternalservererror.md new file mode 100644 index 0000000..07c6abc --- /dev/null +++ b/docs/models/templatecreatetemplateinternalservererror.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateInternalServerError + +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.TemplateCreateTemplateInternalServerErrorIssue](../models/templatecreatetemplateinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplateinternalservererrorissue.md b/docs/models/templatecreatetemplateinternalservererrorissue.md new file mode 100644 index 0000000..5c65e7c --- /dev/null +++ b/docs/models/templatecreatetemplateinternalservererrorissue.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatelanguage.md b/docs/models/templatecreatetemplatelanguage.md new file mode 100644 index 0000000..b44b667 --- /dev/null +++ b/docs/models/templatecreatetemplatelanguage.md @@ -0,0 +1,13 @@ +# TemplateCreateTemplateLanguage + + +## 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/documentupdatedocumentmeta.md b/docs/models/templatecreatetemplatemeta.md similarity index 63% rename from docs/models/documentupdatedocumentmeta.md rename to docs/models/templatecreatetemplatemeta.md index fe1c92a..ef4cf3c 100644 --- a/docs/models/documentupdatedocumentmeta.md +++ b/docs/models/templatecreatetemplatemeta.md @@ -1,20 +1,22 @@ -# DocumentUpdateDocumentMeta +# TemplateCreateTemplateMeta ## 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 +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.TemplateCreateTemplateDateFormat]](../models/templatecreatetemplatedateformat.md) | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.TemplateCreateTemplateDistributionMethod]](../models/templatecreatetemplatedistributionmethod.md) | :heavy_minus_sign: | N/A | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [Optional[models.TemplateCreateTemplateEmailSettings]](../models/templatecreatetemplateemailsettings.md) | :heavy_minus_sign: | N/A | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `language` | [Optional[models.TemplateCreateTemplateLanguage]](../models/templatecreatetemplatelanguage.md) | :heavy_minus_sign: | N/A | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `signing_order` | [Optional[models.TemplateCreateTemplateSigningOrder]](../models/templatecreatetemplatesigningorder.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/templatecreatetemplatepayload.md b/docs/models/templatecreatetemplatepayload.md new file mode 100644 index 0000000..1a1f4c8 --- /dev/null +++ b/docs/models/templatecreatetemplatepayload.md @@ -0,0 +1,18 @@ +# TemplateCreateTemplatePayload + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `title` | *str* | :heavy_check_mark: | N/A | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.TemplateCreateTemplateVisibility]](../models/templatecreatetemplatevisibility.md) | :heavy_minus_sign: | N/A | +| `global_access_auth` | List[[models.TemplateCreateTemplateGlobalAccessAuth](../models/templatecreatetemplateglobalaccessauth.md)] | :heavy_minus_sign: | N/A | +| `global_action_auth` | List[[models.TemplateCreateTemplateGlobalActionAuth](../models/templatecreatetemplateglobalactionauth.md)] | :heavy_minus_sign: | N/A | +| `public_title` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `public_description` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[models.TemplateCreateTemplateType]](../models/templatecreatetemplatetype.md) | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.TemplateCreateTemplateMeta]](../models/templatecreatetemplatemeta.md) | :heavy_minus_sign: | N/A | +| `attachments` | List[[models.TemplateCreateTemplateAttachment](../models/templatecreatetemplateattachment.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplaterequest.md b/docs/models/templatecreatetemplaterequest.md new file mode 100644 index 0000000..13401c9 --- /dev/null +++ b/docs/models/templatecreatetemplaterequest.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `payload` | [models.TemplateCreateTemplatePayload](../models/templatecreatetemplatepayload.md) | :heavy_check_mark: | N/A | +| `file` | [models.TemplateCreateTemplateFile](../models/templatecreatetemplatefile.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplateresponse.md b/docs/models/templatecreatetemplateresponse.md new file mode 100644 index 0000000..296d14f --- /dev/null +++ b/docs/models/templatecreatetemplateresponse.md @@ -0,0 +1,11 @@ +# TemplateCreateTemplateResponse + +Successful response + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `id` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatesigningorder.md b/docs/models/templatecreatetemplatesigningorder.md new file mode 100644 index 0000000..deb51b0 --- /dev/null +++ b/docs/models/templatecreatetemplatesigningorder.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateSigningOrder + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `PARALLEL` | PARALLEL | +| `SEQUENTIAL` | SEQUENTIAL | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryaccessauth.md b/docs/models/templatecreatetemplatetemporaryaccessauth.md new file mode 100644 index 0000000..fd04922 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryaccessauth.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryAccessAuth + + +## 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..8321e47 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryactionauth.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateTemporaryActionAuth + + +## 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/templatecreatetemplatetemporaryattachment.md b/docs/models/templatecreatetemplatetemporaryattachment.md new file mode 100644 index 0000000..6a756d5 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryattachment.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryAttachment + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `label` | *str* | :heavy_check_mark: | N/A | +| `data` | *str* | :heavy_check_mark: | N/A | +| `type` | [Optional[models.TemplateCreateTemplateTemporaryTypeLink]](../models/templatecreatetemplatetemporarytypelink.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryauthoptions.md b/docs/models/templatecreatetemplatetemporaryauthoptions.md new file mode 100644 index 0000000..fd331e9 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryauthoptions.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryAuthOptions + + +## Fields + +| 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/templatecreatetemplatetemporarybadrequesterror.md b/docs/models/templatecreatetemplatetemporarybadrequesterror.md new file mode 100644 index 0000000..be1c8ac --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarybadrequesterror.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateTemporaryBadRequestError + +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.TemplateCreateTemplateTemporaryBadRequestIssue](../models/templatecreatetemplatetemporarybadrequestissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarybadrequestissue.md b/docs/models/templatecreatetemplatetemporarybadrequestissue.md new file mode 100644 index 0000000..0dffa60 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarybadrequestissue.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryBadRequestIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarydateformat.md b/docs/models/templatecreatetemplatetemporarydateformat.md new file mode 100644 index 0000000..56819f6 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarydateformat.md @@ -0,0 +1,29 @@ +# TemplateCreateTemplateTemporaryDateFormat + + +## 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/templatecreatetemplatetemporarydirection1.md b/docs/models/templatecreatetemplatetemporarydirection1.md new file mode 100644 index 0000000..4321133 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarydirection1.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarydirection2.md b/docs/models/templatecreatetemplatetemporarydirection2.md new file mode 100644 index 0000000..eb4e71f --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarydirection2.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryDirection2 + + +## 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/templatecreatetemplatetemporaryenvelopeitem.md b/docs/models/templatecreatetemplatetemporaryenvelopeitem.md new file mode 100644 index 0000000..b4e9131 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryenvelopeitem.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryEnvelopeItem + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfield.md b/docs/models/templatecreatetemplatetemporaryfield.md new file mode 100644 index 0000000..0f12b22 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfield.md @@ -0,0 +1,23 @@ +# TemplateCreateTemplateTemporaryField + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `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: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..4dcf43d --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetacheckbox.md @@ -0,0 +1,17 @@ +# 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 | +| `font_size` | *Optional[float]* | :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.TemplateCreateTemplateTemporaryDirection2]](../models/templatecreatetemplatetemporarydirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfieldmetadate.md b/docs/models/templatecreatetemplatetemporaryfieldmetadate.md new file mode 100644 index 0000000..43ac99c --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetadate.md @@ -0,0 +1,14 @@ +# TemplateCreateTemplateTemporaryFieldMetaDate + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeDate](../models/templatecreatetemplatetemporarytypedate.md) | :heavy_check_mark: | 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/templatecreatetemplatetemporaryfieldmetadropdown.md b/docs/models/templatecreatetemplatetemporaryfieldmetadropdown.md new file mode 100644 index 0000000..300f33f --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetadropdown.md @@ -0,0 +1,15 @@ +# TemplateCreateTemplateTemporaryFieldMetaDropdown + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `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..01f432b --- /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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeEmail](../models/templatecreatetemplatetemporarytypeemail.md) | :heavy_check_mark: | 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..3a0c40a --- /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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeInitials](../models/templatecreatetemplatetemporarytypeinitials.md) | :heavy_check_mark: | 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..49cef74 --- /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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeName](../models/templatecreatetemplatetemporarytypename.md) | :heavy_check_mark: | 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..b1a4f1b --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetanumber.md @@ -0,0 +1,21 @@ +# 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 | +| `font_size` | *Optional[float]* | :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 | +| `text_align` | [Optional[models.TemplateCreateTemplateTemporaryTextAlign6]](../models/templatecreatetemplatetemporarytextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.TemplateCreateTemplateTemporaryVerticalAlign2]](../models/templatecreatetemplatetemporaryverticalalign2.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..6dbc1cc --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetaradio.md @@ -0,0 +1,15 @@ +# 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 | +| `font_size` | *Optional[float]* | :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 | +| `direction` | [Optional[models.TemplateCreateTemplateTemporaryDirection1]](../models/templatecreatetemplatetemporarydirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfieldmetasignature.md b/docs/models/templatecreatetemplatetemporaryfieldmetasignature.md new file mode 100644 index 0000000..f2a3342 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetasignature.md @@ -0,0 +1,13 @@ +# TemplateCreateTemplateTemporaryFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateCreateTemplateTemporaryTypeSignature](../models/templatecreatetemplatetemporarytypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryfieldmetatext.md b/docs/models/templatecreatetemplatetemporaryfieldmetatext.md new file mode 100644 index 0000000..f008240 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetatext.md @@ -0,0 +1,19 @@ +# TemplateCreateTemplateTemporaryFieldMetaText + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `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 | +| `text_align` | [Optional[models.TemplateCreateTemplateTemporaryTextAlign5]](../models/templatecreatetemplatetemporarytextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.TemplateCreateTemplateTemporaryVerticalAlign1]](../models/templatecreatetemplatetemporaryverticalalign1.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..0cc5642 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryfieldmetaunion.md @@ -0,0 +1,65 @@ +# TemplateCreateTemplateTemporaryFieldMetaUnion + + +## Supported Types + +### `models.TemplateCreateTemplateTemporaryFieldMetaSignature` + +```python +value: models.TemplateCreateTemplateTemporaryFieldMetaSignature = /* values here */ +``` + +### `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/documentgetdocumentwithdetailsbyidvisibility.md b/docs/models/templatecreatetemplatetemporaryfoldervisibility.md similarity index 82% rename from docs/models/documentgetdocumentwithdetailsbyidvisibility.md rename to docs/models/templatecreatetemplatetemporaryfoldervisibility.md index 0c58c0a..722aeb2 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidvisibility.md +++ b/docs/models/templatecreatetemplatetemporaryfoldervisibility.md @@ -1,4 +1,4 @@ -# DocumentGetDocumentWithDetailsByIDVisibility +# TemplateCreateTemplateTemporaryFolderVisibility ## Values diff --git a/docs/models/templatecreatetemplatetemporaryforbiddenerror.md b/docs/models/templatecreatetemplatetemporaryforbiddenerror.md new file mode 100644 index 0000000..ba7afda --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateTemporaryForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateCreateTemplateTemporaryForbiddenIssue](../models/templatecreatetemplatetemporaryforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryforbiddenissue.md b/docs/models/templatecreatetemplatetemporaryforbiddenissue.md new file mode 100644 index 0000000..9c17b97 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryglobalaccessauthrequest.md b/docs/models/templatecreatetemplatetemporaryglobalaccessauthrequest.md new file mode 100644 index 0000000..4d3c65f --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryglobalaccessauthrequest.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryGlobalAccessAuthRequest + + +## 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..c0ec263 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryglobalaccessauthresponse.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryGlobalAccessAuthResponse + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryglobalactionauthrequest.md b/docs/models/templatecreatetemplatetemporaryglobalactionauthrequest.md new file mode 100644 index 0000000..aa26027 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryglobalactionauthrequest.md @@ -0,0 +1,11 @@ +# TemplateCreateTemplateTemporaryGlobalActionAuthRequest + + +## 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/templatecreatetemplatetemporaryglobalactionauthresponse.md b/docs/models/templatecreatetemplatetemporaryglobalactionauthresponse.md new file mode 100644 index 0000000..0368b1d --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryglobalactionauthresponse.md @@ -0,0 +1,11 @@ +# TemplateCreateTemplateTemporaryGlobalActionAuthResponse + + +## 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/templatecreatetemplatetemporaryinternalservererror.md b/docs/models/templatecreatetemplatetemporaryinternalservererror.md new file mode 100644 index 0000000..12ce456 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryinternalservererror.md @@ -0,0 +1,12 @@ +# 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.TemplateCreateTemplateTemporaryInternalServerErrorIssue](../models/templatecreatetemplatetemporaryinternalservererrorissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryinternalservererrorissue.md b/docs/models/templatecreatetemplatetemporaryinternalservererrorissue.md new file mode 100644 index 0000000..2bf65ee --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryinternalservererrorissue.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryInternalServerErrorIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarylanguage.md b/docs/models/templatecreatetemplatetemporarylanguage.md new file mode 100644 index 0000000..1b6cf44 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarylanguage.md @@ -0,0 +1,13 @@ +# TemplateCreateTemplateTemporaryLanguage + + +## 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/documentgetdocumentwithdetailsbyiddocumentmeta.md b/docs/models/templatecreatetemplatetemporarymeta.md similarity index 51% rename from docs/models/documentgetdocumentwithdetailsbyiddocumentmeta.md rename to docs/models/templatecreatetemplatetemporarymeta.md index f8d11d9..3dd319a 100644 --- a/docs/models/documentgetdocumentwithdetailsbyiddocumentmeta.md +++ b/docs/models/templatecreatetemplatetemporarymeta.md @@ -1,23 +1,22 @@ -# DocumentGetDocumentWithDetailsByIDDocumentMeta +# TemplateCreateTemplateTemporaryMeta ## 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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.TemplateCreateTemplateTemporaryDateFormat]](../models/templatecreatetemplatetemporarydateformat.md) | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.TemplateCreateTemplateTemporaryMetaDistributionMethod]](../models/templatecreatetemplatetemporarymetadistributionmethod.md) | :heavy_minus_sign: | N/A | +| `email_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_reply_to` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `email_settings` | [Optional[models.TemplateCreateTemplateTemporaryMetaEmailSettings]](../models/templatecreatetemplatetemporarymetaemailsettings.md) | :heavy_minus_sign: | N/A | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `language` | [Optional[models.TemplateCreateTemplateTemporaryLanguage]](../models/templatecreatetemplatetemporarylanguage.md) | :heavy_minus_sign: | N/A | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `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/templatecreatetemplatetemporarymetadistributionmethod.md b/docs/models/templatecreatetemplatetemporarymetadistributionmethod.md new file mode 100644 index 0000000..e67b73e --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarymetadistributionmethod.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateTemporaryMetaDistributionMethod + + +## Values + +| Name | Value | +| ------- | ------- | +| `EMAIL` | EMAIL | +| `NONE` | NONE | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporarymetaemailsettings.md b/docs/models/templatecreatetemplatetemporarymetaemailsettings.md new file mode 100644 index 0000000..fc3de46 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarymetaemailsettings.md @@ -0,0 +1,14 @@ +# TemplateCreateTemplateTemporaryMetaEmailSettings + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *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 53% rename from docs/models/documentgetdocumentwithdetailsbyidrecipient.md rename to docs/models/templatecreatetemplatetemporaryrecipient.md index 4d301e0..35976de 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: | N/A | +| `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..7a976e3 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryrequest.md @@ -0,0 +1,18 @@ +# TemplateCreateTemplateTemporaryRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `title` | *str* | :heavy_check_mark: | N/A | +| `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: | N/A | +| `public_description` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[models.TemplateCreateTemplateTemporaryTypeRequest]](../models/templatecreatetemplatetemporarytyperequest.md) | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.TemplateCreateTemplateTemporaryMeta]](../models/templatecreatetemplatetemporarymeta.md) | :heavy_minus_sign: | N/A | +| `attachments` | List[[models.TemplateCreateTemplateTemporaryAttachment](../models/templatecreatetemplatetemporaryattachment.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 78% rename from docs/models/documentgetdocumentwithdetailsbyidresponse.md rename to docs/models/templatecreatetemplatetemporarytemplate.md index ccc1a58..b080445 100644 --- a/docs/models/documentgetdocumentwithdetailsbyidresponse.md +++ b/docs/models/templatecreatetemplatetemporarytemplate.md @@ -1,31 +1,30 @@ -# 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 | +| `envelope_items` | List[[models.TemplateCreateTemplateTemporaryEnvelopeItem](../models/templatecreatetemplatetemporaryenvelopeitem.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..d49ead9 --- /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: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ 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/templatecreatetemplatetemporarytypelink.md b/docs/models/templatecreatetemplatetemporarytypelink.md new file mode 100644 index 0000000..8a8de9b --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytypelink.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeLink + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ 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/templatecreatetemplatetemporarytypesignature.md b/docs/models/templatecreatetemplatetemporarytypesignature.md new file mode 100644 index 0000000..978ab22 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporarytypesignature.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ 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/templatecreatetemplatetemporaryunauthorizederror.md b/docs/models/templatecreatetemplatetemporaryunauthorizederror.md new file mode 100644 index 0000000..b188ca7 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateTemporaryUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateCreateTemplateTemporaryUnauthorizedIssue](../models/templatecreatetemplatetemporaryunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryunauthorizedissue.md b/docs/models/templatecreatetemplatetemporaryunauthorizedissue.md new file mode 100644 index 0000000..7c052f6 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTemporaryUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ 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/templatecreatetemplatetemporaryverticalalign1.md b/docs/models/templatecreatetemplatetemporaryverticalalign1.md new file mode 100644 index 0000000..46868d6 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryverticalalign1.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetemporaryverticalalign2.md b/docs/models/templatecreatetemplatetemporaryverticalalign2.md new file mode 100644 index 0000000..895c566 --- /dev/null +++ b/docs/models/templatecreatetemplatetemporaryverticalalign2.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateTemporaryVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ 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/templatecreatetemplatetype.md b/docs/models/templatecreatetemplatetype.md new file mode 100644 index 0000000..6c5a8a3 --- /dev/null +++ b/docs/models/templatecreatetemplatetype.md @@ -0,0 +1,9 @@ +# TemplateCreateTemplateType + + +## Values + +| Name | Value | +| --------- | --------- | +| `PUBLIC` | PUBLIC | +| `PRIVATE` | PRIVATE | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatetypelink.md b/docs/models/templatecreatetemplatetypelink.md new file mode 100644 index 0000000..4be5f77 --- /dev/null +++ b/docs/models/templatecreatetemplatetypelink.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateTypeLink + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/docs/models/templatecreatetemplateunauthorizederror.md b/docs/models/templatecreatetemplateunauthorizederror.md new file mode 100644 index 0000000..44bb460 --- /dev/null +++ b/docs/models/templatecreatetemplateunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateCreateTemplateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateCreateTemplateUnauthorizedIssue](../models/templatecreatetemplateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplateunauthorizedissue.md b/docs/models/templatecreatetemplateunauthorizedissue.md new file mode 100644 index 0000000..c8b2ddd --- /dev/null +++ b/docs/models/templatecreatetemplateunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateCreateTemplateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatecreatetemplatevisibility.md b/docs/models/templatecreatetemplatevisibility.md new file mode 100644 index 0000000..38e9ff7 --- /dev/null +++ b/docs/models/templatecreatetemplatevisibility.md @@ -0,0 +1,10 @@ +# TemplateCreateTemplateVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/templatedeletetemplatedirectlinkforbiddenerror.md b/docs/models/templatedeletetemplatedirectlinkforbiddenerror.md new file mode 100644 index 0000000..144337e --- /dev/null +++ b/docs/models/templatedeletetemplatedirectlinkforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateDeleteTemplateDirectLinkForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateDeleteTemplateDirectLinkForbiddenIssue](../models/templatedeletetemplatedirectlinkforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatedeletetemplatedirectlinkforbiddenissue.md b/docs/models/templatedeletetemplatedirectlinkforbiddenissue.md new file mode 100644 index 0000000..662ba98 --- /dev/null +++ b/docs/models/templatedeletetemplatedirectlinkforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateDeleteTemplateDirectLinkForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatedeletetemplatedirectlinkunauthorizederror.md b/docs/models/templatedeletetemplatedirectlinkunauthorizederror.md new file mode 100644 index 0000000..6f91f76 --- /dev/null +++ b/docs/models/templatedeletetemplatedirectlinkunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateDeleteTemplateDirectLinkUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateDeleteTemplateDirectLinkUnauthorizedIssue](../models/templatedeletetemplatedirectlinkunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatedeletetemplatedirectlinkunauthorizedissue.md b/docs/models/templatedeletetemplatedirectlinkunauthorizedissue.md new file mode 100644 index 0000000..d1e4724 --- /dev/null +++ b/docs/models/templatedeletetemplatedirectlinkunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateDeleteTemplateDirectLinkUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatedeletetemplateforbiddenerror.md b/docs/models/templatedeletetemplateforbiddenerror.md new file mode 100644 index 0000000..65601bb --- /dev/null +++ b/docs/models/templatedeletetemplateforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateDeleteTemplateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateDeleteTemplateForbiddenIssue](../models/templatedeletetemplateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatedeletetemplateforbiddenissue.md b/docs/models/templatedeletetemplateforbiddenissue.md new file mode 100644 index 0000000..df5768e --- /dev/null +++ b/docs/models/templatedeletetemplateforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateDeleteTemplateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatedeletetemplateunauthorizederror.md b/docs/models/templatedeletetemplateunauthorizederror.md new file mode 100644 index 0000000..71a71f7 --- /dev/null +++ b/docs/models/templatedeletetemplateunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateDeleteTemplateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateDeleteTemplateUnauthorizedIssue](../models/templatedeletetemplateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatedeletetemplateunauthorizedissue.md b/docs/models/templatedeletetemplateunauthorizedissue.md new file mode 100644 index 0000000..56e757d --- /dev/null +++ b/docs/models/templatedeletetemplateunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateDeleteTemplateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templateduplicatetemplateforbiddenerror.md b/docs/models/templateduplicatetemplateforbiddenerror.md new file mode 100644 index 0000000..72630fe --- /dev/null +++ b/docs/models/templateduplicatetemplateforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateDuplicateTemplateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateDuplicateTemplateForbiddenIssue](../models/templateduplicatetemplateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templateduplicatetemplateforbiddenissue.md b/docs/models/templateduplicatetemplateforbiddenissue.md new file mode 100644 index 0000000..b0990be --- /dev/null +++ b/docs/models/templateduplicatetemplateforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateDuplicateTemplateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *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..03d6513 100644 --- a/docs/models/templateduplicatetemplateglobalaccessauth.md +++ b/docs/models/templateduplicatetemplateglobalaccessauth.md @@ -1,10 +1,9 @@ # TemplateDuplicateTemplateGlobalAccessAuth -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/templateduplicatetemplateglobalactionauth.md b/docs/models/templateduplicatetemplateglobalactionauth.md index 1b45166..6e88d4f 100644 --- a/docs/models/templateduplicatetemplateglobalactionauth.md +++ b/docs/models/templateduplicatetemplateglobalactionauth.md @@ -1,7 +1,5 @@ # TemplateDuplicateTemplateGlobalActionAuth -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. - ## Values 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/templateduplicatetemplateunauthorizederror.md b/docs/models/templateduplicatetemplateunauthorizederror.md new file mode 100644 index 0000000..61e1b81 --- /dev/null +++ b/docs/models/templateduplicatetemplateunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateDuplicateTemplateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateDuplicateTemplateUnauthorizedIssue](../models/templateduplicatetemplateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templateduplicatetemplateunauthorizedissue.md b/docs/models/templateduplicatetemplateunauthorizedissue.md new file mode 100644 index 0000000..2841cd4 --- /dev/null +++ b/docs/models/templateduplicatetemplateunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateDuplicateTemplateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesaccessauth.md b/docs/models/templatefindtemplatesaccessauth.md index a178d35..75f05c7 100644 --- a/docs/models/templatefindtemplatesaccessauth.md +++ b/docs/models/templatefindtemplatesaccessauth.md @@ -1,10 +1,9 @@ # TemplateFindTemplatesAccessAuth -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/templatefindtemplatesactionauth.md b/docs/models/templatefindtemplatesactionauth.md index 5e19e83..1c1c474 100644 --- a/docs/models/templatefindtemplatesactionauth.md +++ b/docs/models/templatefindtemplatesactionauth.md @@ -1,7 +1,5 @@ # TemplateFindTemplatesActionAuth -The type of authentication required for the recipient to sign the document. - ## Values 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/templatefindtemplatesdirection1.md b/docs/models/templatefindtemplatesdirection1.md new file mode 100644 index 0000000..d3f892d --- /dev/null +++ b/docs/models/templatefindtemplatesdirection1.md @@ -0,0 +1,9 @@ +# TemplateFindTemplatesDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesdirection2.md b/docs/models/templatefindtemplatesdirection2.md new file mode 100644 index 0000000..f10391d --- /dev/null +++ b/docs/models/templatefindtemplatesdirection2.md @@ -0,0 +1,9 @@ +# TemplateFindTemplatesDirection2 + + +## 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..cd014d5 100644 --- a/docs/models/templatefindtemplatesfield.md +++ b/docs/models/templatefindtemplatesfield.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..fd2c341 100644 --- a/docs/models/templatefindtemplatesfieldmetacheckbox.md +++ b/docs/models/templatefindtemplatesfieldmetacheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.TemplateFindTemplatesDirection2]](../models/templatefindtemplatesdirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfieldmetadate.md b/docs/models/templatefindtemplatesfieldmetadate.md index d7868b9..774189b 100644 --- a/docs/models/templatefindtemplatesfieldmetadate.md +++ b/docs/models/templatefindtemplatesfieldmetadate.md @@ -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.TemplateFindTemplatesTypeDate](../models/templatefindtemplatestypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateFindTemplatesTypeDate](../models/templatefindtemplatestypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateFindTemplatesTextAlign4]](../models/templatefindtemplatestextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfieldmetadropdown.md b/docs/models/templatefindtemplatesfieldmetadropdown.md index 051b799..2023389 100644 --- a/docs/models/templatefindtemplatesfieldmetadropdown.md +++ b/docs/models/templatefindtemplatesfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.TemplateFindTemplatesTypeDropdown](../models/templatefindtemplatestypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.TemplateFindTemplatesValue3](../models/templatefindtemplatesvalue3.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/templatefindtemplatesfieldmetaemail.md b/docs/models/templatefindtemplatesfieldmetaemail.md index 4448cca..9766d0b 100644 --- a/docs/models/templatefindtemplatesfieldmetaemail.md +++ b/docs/models/templatefindtemplatesfieldmetaemail.md @@ -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.TemplateFindTemplatesTypeEmail](../models/templatefindtemplatestypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateFindTemplatesTypeEmail](../models/templatefindtemplatestypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateFindTemplatesTextAlign3]](../models/templatefindtemplatestextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfieldmetainitials.md b/docs/models/templatefindtemplatesfieldmetainitials.md index 38fa3db..36575ad 100644 --- a/docs/models/templatefindtemplatesfieldmetainitials.md +++ b/docs/models/templatefindtemplatesfieldmetainitials.md @@ -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.TemplateFindTemplatesTypeInitials](../models/templatefindtemplatestypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateFindTemplatesTypeInitials](../models/templatefindtemplatestypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateFindTemplatesTextAlign1]](../models/templatefindtemplatestextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfieldmetaname.md b/docs/models/templatefindtemplatesfieldmetaname.md index eaa04f2..ec276fe 100644 --- a/docs/models/templatefindtemplatesfieldmetaname.md +++ b/docs/models/templatefindtemplatesfieldmetaname.md @@ -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.TemplateFindTemplatesTypeName](../models/templatefindtemplatestypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateFindTemplatesTypeName](../models/templatefindtemplatestypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateFindTemplatesTextAlign2]](../models/templatefindtemplatestextalign2.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..865b410 100644 --- a/docs/models/templatefindtemplatesfieldmetanumber.md +++ b/docs/models/templatefindtemplatesfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.TemplateFindTemplatesTypeNumber](../models/templatefindtemplatestypenumber.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.TemplateFindTemplatesTextAlign6]](../models/templatefindtemplatestextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateFindTemplatesTypeNumber](../models/templatefindtemplatestypenumber.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 | +| `text_align` | [Optional[models.TemplateFindTemplatesTextAlign6]](../models/templatefindtemplatestextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.TemplateFindTemplatesVerticalAlign2]](../models/templatefindtemplatesverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfieldmetaradio.md b/docs/models/templatefindtemplatesfieldmetaradio.md index e6277f8..5dc8b11 100644 --- a/docs/models/templatefindtemplatesfieldmetaradio.md +++ b/docs/models/templatefindtemplatesfieldmetaradio.md @@ -3,11 +3,13 @@ ## 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.TemplateFindTemplatesTypeRadio](../models/templatefindtemplatestyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.TemplateFindTemplatesValue1](../models/templatefindtemplatesvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateFindTemplatesTypeRadio](../models/templatefindtemplatestyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.TemplateFindTemplatesValue1](../models/templatefindtemplatesvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.TemplateFindTemplatesDirection1]](../models/templatefindtemplatesdirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfieldmetasignature.md b/docs/models/templatefindtemplatesfieldmetasignature.md new file mode 100644 index 0000000..210c4ef --- /dev/null +++ b/docs/models/templatefindtemplatesfieldmetasignature.md @@ -0,0 +1,13 @@ +# TemplateFindTemplatesFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateFindTemplatesTypeSignature](../models/templatefindtemplatestypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfieldmetatext.md b/docs/models/templatefindtemplatesfieldmetatext.md index d5d9f3c..7fab1cc 100644 --- a/docs/models/templatefindtemplatesfieldmetatext.md +++ b/docs/models/templatefindtemplatesfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.TemplateFindTemplatesTypeText](../models/templatefindtemplatestypetext.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.TemplateFindTemplatesTextAlign5]](../models/templatefindtemplatestextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateFindTemplatesTypeText](../models/templatefindtemplatestypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.TemplateFindTemplatesTextAlign5]](../models/templatefindtemplatestextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.TemplateFindTemplatesVerticalAlign1]](../models/templatefindtemplatesverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesfieldmetaunion.md b/docs/models/templatefindtemplatesfieldmetaunion.md index d7f56dd..0b54a38 100644 --- a/docs/models/templatefindtemplatesfieldmetaunion.md +++ b/docs/models/templatefindtemplatesfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.TemplateFindTemplatesFieldMetaSignature` + +```python +value: models.TemplateFindTemplatesFieldMetaSignature = /* values here */ +``` + ### `models.TemplateFindTemplatesFieldMetaInitials` ```python diff --git a/docs/models/templatefindtemplatesforbiddenerror.md b/docs/models/templatefindtemplatesforbiddenerror.md new file mode 100644 index 0000000..ced6918 --- /dev/null +++ b/docs/models/templatefindtemplatesforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateFindTemplatesForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateFindTemplatesForbiddenIssue](../models/templatefindtemplatesforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesforbiddenissue.md b/docs/models/templatefindtemplatesforbiddenissue.md new file mode 100644 index 0000000..7d6cf4a --- /dev/null +++ b/docs/models/templatefindtemplatesforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateFindTemplatesForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesglobalaccessauth.md b/docs/models/templatefindtemplatesglobalaccessauth.md index bb3e24d..aff39cd 100644 --- a/docs/models/templatefindtemplatesglobalaccessauth.md +++ b/docs/models/templatefindtemplatesglobalaccessauth.md @@ -1,10 +1,9 @@ # TemplateFindTemplatesGlobalAccessAuth -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/templatefindtemplatesglobalactionauth.md b/docs/models/templatefindtemplatesglobalactionauth.md index dd0807b..7776dfa 100644 --- a/docs/models/templatefindtemplatesglobalactionauth.md +++ b/docs/models/templatefindtemplatesglobalactionauth.md @@ -1,7 +1,5 @@ # TemplateFindTemplatesGlobalActionAuth -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. - ## Values diff --git a/docs/models/queryparamtype.md b/docs/models/templatefindtemplatesqueryparamtype.md similarity index 79% rename from docs/models/queryparamtype.md rename to docs/models/templatefindtemplatesqueryparamtype.md index 8f0381d..720a756 100644 --- a/docs/models/queryparamtype.md +++ b/docs/models/templatefindtemplatesqueryparamtype.md @@ -1,4 +1,4 @@ -# QueryParamType +# TemplateFindTemplatesQueryParamType Filter templates by type. diff --git a/docs/models/templatefindtemplatesrecipient.md b/docs/models/templatefindtemplatesrecipient.md index 51d0101..6ce4208 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 | @@ -19,5 +18,7 @@ | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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 +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `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/templatefindtemplatesrequest.md b/docs/models/templatefindtemplatesrequest.md index 71ebbb8..8580a63 100644 --- a/docs/models/templatefindtemplatesrequest.md +++ b/docs/models/templatefindtemplatesrequest.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `query` | *Optional[str]* | :heavy_minus_sign: | The search query. | -| `page` | *Optional[float]* | :heavy_minus_sign: | The pagination page number, starts at 1. | -| `per_page` | *Optional[float]* | :heavy_minus_sign: | The number of items per page. | -| `type` | [Optional[models.QueryParamType]](../models/queryparamtype.md) | :heavy_minus_sign: | Filter templates by type. | -| `folder_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the folder to filter templates by. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `query` | *Optional[str]* | :heavy_minus_sign: | The search query. | +| `page` | *Optional[float]* | :heavy_minus_sign: | The pagination page number, starts at 1. | +| `per_page` | *Optional[float]* | :heavy_minus_sign: | The number of items per page. | +| `type` | [Optional[models.TemplateFindTemplatesQueryParamType]](../models/templatefindtemplatesqueryparamtype.md) | :heavy_minus_sign: | Filter templates by type. | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the folder to filter templates by. | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesresponse.md b/docs/models/templatefindtemplatesresponse.md index 8851e33..be7d83a 100644 --- a/docs/models/templatefindtemplatesresponse.md +++ b/docs/models/templatefindtemplatesresponse.md @@ -8,7 +8,7 @@ Successful response | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | `data` | List[[models.TemplateFindTemplatesData](../models/templatefindtemplatesdata.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 +| `count` | *float* | :heavy_check_mark: | N/A | +| `current_page` | *float* | :heavy_check_mark: | N/A | +| `per_page` | *float* | :heavy_check_mark: | N/A | +| `total_pages` | *float* | :heavy_check_mark: | 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/templatefindtemplatestypesignature.md b/docs/models/templatefindtemplatestypesignature.md new file mode 100644 index 0000000..d88578d --- /dev/null +++ b/docs/models/templatefindtemplatestypesignature.md @@ -0,0 +1,8 @@ +# TemplateFindTemplatesTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesunauthorizederror.md b/docs/models/templatefindtemplatesunauthorizederror.md new file mode 100644 index 0000000..c6e0138 --- /dev/null +++ b/docs/models/templatefindtemplatesunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateFindTemplatesUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateFindTemplatesUnauthorizedIssue](../models/templatefindtemplatesunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesunauthorizedissue.md b/docs/models/templatefindtemplatesunauthorizedissue.md new file mode 100644 index 0000000..332ca7c --- /dev/null +++ b/docs/models/templatefindtemplatesunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateFindTemplatesUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesverticalalign1.md b/docs/models/templatefindtemplatesverticalalign1.md new file mode 100644 index 0000000..ddf4271 --- /dev/null +++ b/docs/models/templatefindtemplatesverticalalign1.md @@ -0,0 +1,10 @@ +# TemplateFindTemplatesVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/templatefindtemplatesverticalalign2.md b/docs/models/templatefindtemplatesverticalalign2.md new file mode 100644 index 0000000..bb2db4c --- /dev/null +++ b/docs/models/templatefindtemplatesverticalalign2.md @@ -0,0 +1,10 @@ +# TemplateFindTemplatesVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidaccessauth.md b/docs/models/templategettemplatebyidaccessauth.md index e6f5902..44dcb07 100644 --- a/docs/models/templategettemplatebyidaccessauth.md +++ b/docs/models/templategettemplatebyidaccessauth.md @@ -1,10 +1,9 @@ # TemplateGetTemplateByIDAccessAuth -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/templategettemplatebyidactionauth.md b/docs/models/templategettemplatebyidactionauth.md index 9d7b365..fe3cd1f 100644 --- a/docs/models/templategettemplatebyidactionauth.md +++ b/docs/models/templategettemplatebyidactionauth.md @@ -1,7 +1,5 @@ # TemplateGetTemplateByIDActionAuth -The type of authentication required for the recipient to sign the document. - ## Values diff --git a/docs/models/templategettemplatebyiddirection1.md b/docs/models/templategettemplatebyiddirection1.md new file mode 100644 index 0000000..ddd0356 --- /dev/null +++ b/docs/models/templategettemplatebyiddirection1.md @@ -0,0 +1,9 @@ +# TemplateGetTemplateByIDDirection1 + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `VERTICAL` | vertical | +| `HORIZONTAL` | horizontal | \ No newline at end of file diff --git a/docs/models/templategettemplatebyiddirection2.md b/docs/models/templategettemplatebyiddirection2.md new file mode 100644 index 0000000..7ea804f --- /dev/null +++ b/docs/models/templategettemplatebyiddirection2.md @@ -0,0 +1,9 @@ +# TemplateGetTemplateByIDDirection2 + + +## 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/templategettemplatebyidemailsettings.md b/docs/models/templategettemplatebyidemailsettings.md index c857c87..3d90147 100644 --- a/docs/models/templategettemplatebyidemailsettings.md +++ b/docs/models/templategettemplatebyidemailsettings.md @@ -3,12 +3,12 @@ ## 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 +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidenvelopeitem.md b/docs/models/templategettemplatebyidenvelopeitem.md new file mode 100644 index 0000000..a640df9 --- /dev/null +++ b/docs/models/templategettemplatebyidenvelopeitem.md @@ -0,0 +1,9 @@ +# TemplateGetTemplateByIDEnvelopeItem + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | N/A | +| `envelope_id` | *str* | :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..013116e 100644 --- a/docs/models/templategettemplatebyidfield.md +++ b/docs/models/templategettemplatebyidfield.md @@ -5,17 +5,19 @@ | 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 | -| `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 | +| `page` | *float* | :heavy_check_mark: | N/A | +| `position_x` | *Any* | :heavy_check_mark: | N/A | +| `position_y` | *Any* | :heavy_check_mark: | N/A | +| `width` | *Any* | :heavy_check_mark: | N/A | +| `height` | *Any* | :heavy_check_mark: | 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..4ccfa48 100644 --- a/docs/models/templategettemplatebyidfieldmetacheckbox.md +++ b/docs/models/templategettemplatebyidfieldmetacheckbox.md @@ -3,13 +3,15 @@ ## 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 | +| `font_size` | *Optional[float]* | :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.TemplateGetTemplateByIDDirection2]](../models/templategettemplatebyiddirection2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfieldmetadate.md b/docs/models/templategettemplatebyidfieldmetadate.md index 62f8e99..84a763c 100644 --- a/docs/models/templategettemplatebyidfieldmetadate.md +++ b/docs/models/templategettemplatebyidfieldmetadate.md @@ -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.TemplateGetTemplateByIDTypeDate](../models/templategettemplatebyidtypedate.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateGetTemplateByIDTypeDate](../models/templategettemplatebyidtypedate.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateGetTemplateByIDTextAlign4]](../models/templategettemplatebyidtextalign4.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfieldmetadropdown.md b/docs/models/templategettemplatebyidfieldmetadropdown.md index 37d6727..eb2cbdc 100644 --- a/docs/models/templategettemplatebyidfieldmetadropdown.md +++ b/docs/models/templategettemplatebyidfieldmetadropdown.md @@ -9,6 +9,7 @@ | `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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | `type` | [models.TemplateGetTemplateByIDTypeDropdown](../models/templategettemplatebyidtypedropdown.md) | :heavy_check_mark: | N/A | | `values` | List[[models.TemplateGetTemplateByIDValue3](../models/templategettemplatebyidvalue3.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/templategettemplatebyidfieldmetaemail.md b/docs/models/templategettemplatebyidfieldmetaemail.md index e48a4b8..a010038 100644 --- a/docs/models/templategettemplatebyidfieldmetaemail.md +++ b/docs/models/templategettemplatebyidfieldmetaemail.md @@ -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.TemplateGetTemplateByIDTypeEmail](../models/templategettemplatebyidtypeemail.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateGetTemplateByIDTypeEmail](../models/templategettemplatebyidtypeemail.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateGetTemplateByIDTextAlign3]](../models/templategettemplatebyidtextalign3.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfieldmetainitials.md b/docs/models/templategettemplatebyidfieldmetainitials.md index 6d4fbeb..d321de3 100644 --- a/docs/models/templategettemplatebyidfieldmetainitials.md +++ b/docs/models/templategettemplatebyidfieldmetainitials.md @@ -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.TemplateGetTemplateByIDTypeInitials](../models/templategettemplatebyidtypeinitials.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateGetTemplateByIDTypeInitials](../models/templategettemplatebyidtypeinitials.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateGetTemplateByIDTextAlign1]](../models/templategettemplatebyidtextalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfieldmetaname.md b/docs/models/templategettemplatebyidfieldmetaname.md index 72bafef..44ce7dc 100644 --- a/docs/models/templategettemplatebyidfieldmetaname.md +++ b/docs/models/templategettemplatebyidfieldmetaname.md @@ -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.TemplateGetTemplateByIDTypeName](../models/templategettemplatebyidtypename.md) | :heavy_check_mark: | N/A | | `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateGetTemplateByIDTypeName](../models/templategettemplatebyidtypename.md) | :heavy_check_mark: | N/A | | `text_align` | [Optional[models.TemplateGetTemplateByIDTextAlign2]](../models/templategettemplatebyidtextalign2.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..3983c13 100644 --- a/docs/models/templategettemplatebyidfieldmetanumber.md +++ b/docs/models/templategettemplatebyidfieldmetanumber.md @@ -3,16 +3,19 @@ ## 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.TemplateGetTemplateByIDTypeNumber](../models/templategettemplatebyidtypenumber.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.TemplateGetTemplateByIDTextAlign6]](../models/templategettemplatebyidtextalign6.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateGetTemplateByIDTypeNumber](../models/templategettemplatebyidtypenumber.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 | +| `text_align` | [Optional[models.TemplateGetTemplateByIDTextAlign6]](../models/templategettemplatebyidtextalign6.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.TemplateGetTemplateByIDVerticalAlign2]](../models/templategettemplatebyidverticalalign2.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfieldmetaradio.md b/docs/models/templategettemplatebyidfieldmetaradio.md index 7961637..440618e 100644 --- a/docs/models/templategettemplatebyidfieldmetaradio.md +++ b/docs/models/templategettemplatebyidfieldmetaradio.md @@ -3,11 +3,13 @@ ## 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.TemplateGetTemplateByIDTypeRadio](../models/templategettemplatebyidtyperadio.md) | :heavy_check_mark: | N/A | -| `values` | List[[models.TemplateGetTemplateByIDValue1](../models/templategettemplatebyidvalue1.md)] | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateGetTemplateByIDTypeRadio](../models/templategettemplatebyidtyperadio.md) | :heavy_check_mark: | N/A | +| `values` | List[[models.TemplateGetTemplateByIDValue1](../models/templategettemplatebyidvalue1.md)] | :heavy_minus_sign: | N/A | +| `direction` | [Optional[models.TemplateGetTemplateByIDDirection1]](../models/templategettemplatebyiddirection1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfieldmetasignature.md b/docs/models/templategettemplatebyidfieldmetasignature.md new file mode 100644 index 0000000..9442803 --- /dev/null +++ b/docs/models/templategettemplatebyidfieldmetasignature.md @@ -0,0 +1,13 @@ +# TemplateGetTemplateByIDFieldMetaSignature + + +## 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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateGetTemplateByIDTypeSignature](../models/templategettemplatebyidtypesignature.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfieldmetatext.md b/docs/models/templategettemplatebyidfieldmetatext.md index 423253f..3549fda 100644 --- a/docs/models/templategettemplatebyidfieldmetatext.md +++ b/docs/models/templategettemplatebyidfieldmetatext.md @@ -3,14 +3,17 @@ ## 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.TemplateGetTemplateByIDTypeText](../models/templategettemplatebyidtypetext.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.TemplateGetTemplateByIDTextAlign5]](../models/templategettemplatebyidtextalign5.md) | :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 | +| `font_size` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `type` | [models.TemplateGetTemplateByIDTypeText](../models/templategettemplatebyidtypetext.md) | :heavy_check_mark: | N/A | +| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `character_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `text_align` | [Optional[models.TemplateGetTemplateByIDTextAlign5]](../models/templategettemplatebyidtextalign5.md) | :heavy_minus_sign: | N/A | +| `line_height` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `letter_spacing` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `vertical_align` | [OptionalNullable[models.TemplateGetTemplateByIDVerticalAlign1]](../models/templategettemplatebyidverticalalign1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidfieldmetaunion.md b/docs/models/templategettemplatebyidfieldmetaunion.md index 7d87e10..24c4b4a 100644 --- a/docs/models/templategettemplatebyidfieldmetaunion.md +++ b/docs/models/templategettemplatebyidfieldmetaunion.md @@ -3,6 +3,12 @@ ## Supported Types +### `models.TemplateGetTemplateByIDFieldMetaSignature` + +```python +value: models.TemplateGetTemplateByIDFieldMetaSignature = /* values here */ +``` + ### `models.TemplateGetTemplateByIDFieldMetaInitials` ```python diff --git a/docs/models/templategettemplatebyidforbiddenerror.md b/docs/models/templategettemplatebyidforbiddenerror.md new file mode 100644 index 0000000..b9030a8 --- /dev/null +++ b/docs/models/templategettemplatebyidforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateGetTemplateByIDForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateGetTemplateByIDForbiddenIssue](../models/templategettemplatebyidforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidforbiddenissue.md b/docs/models/templategettemplatebyidforbiddenissue.md new file mode 100644 index 0000000..8beb0e6 --- /dev/null +++ b/docs/models/templategettemplatebyidforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateGetTemplateByIDForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidglobalaccessauth.md b/docs/models/templategettemplatebyidglobalaccessauth.md index 5cdb7a4..1d21e6a 100644 --- a/docs/models/templategettemplatebyidglobalaccessauth.md +++ b/docs/models/templategettemplatebyidglobalaccessauth.md @@ -1,10 +1,9 @@ # TemplateGetTemplateByIDGlobalAccessAuth -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/templategettemplatebyidglobalactionauth.md b/docs/models/templategettemplatebyidglobalactionauth.md index c5e8f59..d24904b 100644 --- a/docs/models/templategettemplatebyidglobalactionauth.md +++ b/docs/models/templategettemplatebyidglobalactionauth.md @@ -1,7 +1,5 @@ # TemplateGetTemplateByIDGlobalActionAuth -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. - ## Values diff --git a/docs/models/templategettemplatebyidrecipient.md b/docs/models/templategettemplatebyidrecipient.md index 6bc2a10..d08b997 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 | @@ -19,5 +18,7 @@ | `expired` | *Nullable[str]* | :heavy_check_mark: | N/A | | `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 +| `signing_order` | *Nullable[float]* | :heavy_check_mark: | N/A | +| `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..d2143ed 100644 --- a/docs/models/templategettemplatebyidresponse.md +++ b/docs/models/templategettemplatebyidresponse.md @@ -5,26 +5,28 @@ 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 | +| `envelope_items` | List[[models.TemplateGetTemplateByIDEnvelopeItem](../models/templategettemplatebyidenvelopeitem.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/templategettemplatebyidtypesignature.md b/docs/models/templategettemplatebyidtypesignature.md new file mode 100644 index 0000000..bbe02c3 --- /dev/null +++ b/docs/models/templategettemplatebyidtypesignature.md @@ -0,0 +1,8 @@ +# TemplateGetTemplateByIDTypeSignature + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SIGNATURE` | signature | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidunauthorizederror.md b/docs/models/templategettemplatebyidunauthorizederror.md new file mode 100644 index 0000000..e6d4627 --- /dev/null +++ b/docs/models/templategettemplatebyidunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateGetTemplateByIDUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateGetTemplateByIDUnauthorizedIssue](../models/templategettemplatebyidunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidunauthorizedissue.md b/docs/models/templategettemplatebyidunauthorizedissue.md new file mode 100644 index 0000000..058db9e --- /dev/null +++ b/docs/models/templategettemplatebyidunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateGetTemplateByIDUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidverticalalign1.md b/docs/models/templategettemplatebyidverticalalign1.md new file mode 100644 index 0000000..29b0fe0 --- /dev/null +++ b/docs/models/templategettemplatebyidverticalalign1.md @@ -0,0 +1,10 @@ +# TemplateGetTemplateByIDVerticalAlign1 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/templategettemplatebyidverticalalign2.md b/docs/models/templategettemplatebyidverticalalign2.md new file mode 100644 index 0000000..d766679 --- /dev/null +++ b/docs/models/templategettemplatebyidverticalalign2.md @@ -0,0 +1,10 @@ +# TemplateGetTemplateByIDVerticalAlign2 + + +## Values + +| Name | Value | +| -------- | -------- | +| `TOP` | top | +| `MIDDLE` | middle | +| `BOTTOM` | bottom | \ No newline at end of file diff --git a/docs/models/templatetoggletemplatedirectlinkforbiddenerror.md b/docs/models/templatetoggletemplatedirectlinkforbiddenerror.md new file mode 100644 index 0000000..189f091 --- /dev/null +++ b/docs/models/templatetoggletemplatedirectlinkforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateToggleTemplateDirectLinkForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateToggleTemplateDirectLinkForbiddenIssue](../models/templatetoggletemplatedirectlinkforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatetoggletemplatedirectlinkforbiddenissue.md b/docs/models/templatetoggletemplatedirectlinkforbiddenissue.md new file mode 100644 index 0000000..bc277b7 --- /dev/null +++ b/docs/models/templatetoggletemplatedirectlinkforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateToggleTemplateDirectLinkForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :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/templatetoggletemplatedirectlinkunauthorizederror.md b/docs/models/templatetoggletemplatedirectlinkunauthorizederror.md new file mode 100644 index 0000000..bf6ede4 --- /dev/null +++ b/docs/models/templatetoggletemplatedirectlinkunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateToggleTemplateDirectLinkUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateToggleTemplateDirectLinkUnauthorizedIssue](../models/templatetoggletemplatedirectlinkunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templatetoggletemplatedirectlinkunauthorizedissue.md b/docs/models/templatetoggletemplatedirectlinkunauthorizedissue.md new file mode 100644 index 0000000..7b8a311 --- /dev/null +++ b/docs/models/templatetoggletemplatedirectlinkunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateToggleTemplateDirectLinkUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :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..a857b33 100644 --- a/docs/models/templateupdatetemplatedata.md +++ b/docs/models/templateupdatetemplatedata.md @@ -3,14 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `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 | -| `global_action_auth` | List[[models.TemplateUpdateTemplateGlobalActionAuthRequest](../models/templateupdatetemplateglobalactionauthrequest.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.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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.TemplateUpdateTemplateDataVisibility]](../models/templateupdatetemplatedatavisibility.md) | :heavy_minus_sign: | N/A | +| `global_access_auth` | List[[models.TemplateUpdateTemplateDataGlobalAccessAuth](../models/templateupdatetemplatedataglobalaccessauth.md)] | :heavy_minus_sign: | N/A | +| `global_action_auth` | List[[models.TemplateUpdateTemplateDataGlobalActionAuth](../models/templateupdatetemplatedataglobalactionauth.md)] | :heavy_minus_sign: | N/A | +| `public_title` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `public_description` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[models.TemplateUpdateTemplateDataType]](../models/templateupdatetemplatedatatype.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/templateupdatetemplatedataglobalaccessauth.md b/docs/models/templateupdatetemplatedataglobalaccessauth.md new file mode 100644 index 0000000..9baa13b --- /dev/null +++ b/docs/models/templateupdatetemplatedataglobalaccessauth.md @@ -0,0 +1,9 @@ +# TemplateUpdateTemplateDataGlobalAccessAuth + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACCOUNT` | ACCOUNT | +| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH | \ No newline at end of file diff --git a/docs/models/templateupdatetemplatedataglobalactionauth.md b/docs/models/templateupdatetemplatedataglobalactionauth.md new file mode 100644 index 0000000..d313e80 --- /dev/null +++ b/docs/models/templateupdatetemplatedataglobalactionauth.md @@ -0,0 +1,11 @@ +# TemplateUpdateTemplateDataGlobalActionAuth + + +## 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/templateupdatetemplatedatavisibility.md b/docs/models/templateupdatetemplatedatavisibility.md new file mode 100644 index 0000000..30b2068 --- /dev/null +++ b/docs/models/templateupdatetemplatedatavisibility.md @@ -0,0 +1,10 @@ +# TemplateUpdateTemplateDataVisibility + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EVERYONE` | EVERYONE | +| `MANAGER_AND_ABOVE` | MANAGER_AND_ABOVE | +| `ADMIN` | ADMIN | \ No newline at end of file diff --git a/docs/models/templateupdatetemplatedateformat.md b/docs/models/templateupdatetemplatedateformat.md index 4c5aaf2..b2f079f 100644 --- a/docs/models/templateupdatetemplatedateformat.md +++ b/docs/models/templateupdatetemplatedateformat.md @@ -1,19 +1,29 @@ # TemplateUpdateTemplateDateFormat -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/templateupdatetemplatedistributionmethod.md b/docs/models/templateupdatetemplatedistributionmethod.md index fb20d16..abf5f5c 100644 --- a/docs/models/templateupdatetemplatedistributionmethod.md +++ b/docs/models/templateupdatetemplatedistributionmethod.md @@ -1,7 +1,5 @@ # TemplateUpdateTemplateDistributionMethod -The distribution method to use when sending the document to the recipients. - ## Values diff --git a/docs/models/templateupdatetemplateemailsettings.md b/docs/models/templateupdatetemplateemailsettings.md index 6767c61..ab0f99c 100644 --- a/docs/models/templateupdatetemplateemailsettings.md +++ b/docs/models/templateupdatetemplateemailsettings.md @@ -3,12 +3,12 @@ ## 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 +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `recipient_signing_request` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_removed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `recipient_signed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_pending` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `document_deleted` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `owner_document_completed` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templateupdatetemplateforbiddenerror.md b/docs/models/templateupdatetemplateforbiddenerror.md new file mode 100644 index 0000000..59e17d4 --- /dev/null +++ b/docs/models/templateupdatetemplateforbiddenerror.md @@ -0,0 +1,12 @@ +# TemplateUpdateTemplateForbiddenError + +Insufficient access + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateUpdateTemplateForbiddenIssue](../models/templateupdatetemplateforbiddenissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templateupdatetemplateforbiddenissue.md b/docs/models/templateupdatetemplateforbiddenissue.md new file mode 100644 index 0000000..b1ce722 --- /dev/null +++ b/docs/models/templateupdatetemplateforbiddenissue.md @@ -0,0 +1,8 @@ +# TemplateUpdateTemplateForbiddenIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/templateupdatetemplateglobalaccessauthrequest.md b/docs/models/templateupdatetemplateglobalaccessauthrequest.md deleted file mode 100644 index 5719ae1..0000000 --- a/docs/models/templateupdatetemplateglobalaccessauthrequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# TemplateUpdateTemplateGlobalAccessAuthRequest - -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/templateupdatetemplateglobalaccessauthresponse.md b/docs/models/templateupdatetemplateglobalaccessauthresponse.md index f0dce78..8a2fd05 100644 --- a/docs/models/templateupdatetemplateglobalaccessauthresponse.md +++ b/docs/models/templateupdatetemplateglobalaccessauthresponse.md @@ -1,10 +1,9 @@ # TemplateUpdateTemplateGlobalAccessAuthResponse -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/templateupdatetemplateglobalactionauthresponse.md b/docs/models/templateupdatetemplateglobalactionauthresponse.md index 7ec3526..f79755c 100644 --- a/docs/models/templateupdatetemplateglobalactionauthresponse.md +++ b/docs/models/templateupdatetemplateglobalactionauthresponse.md @@ -1,7 +1,5 @@ # TemplateUpdateTemplateGlobalActionAuthResponse -The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. - ## Values diff --git a/docs/models/templateupdatetemplatelanguage.md b/docs/models/templateupdatetemplatelanguage.md index 5444ab5..3b6da28 100644 --- a/docs/models/templateupdatetemplatelanguage.md +++ b/docs/models/templateupdatetemplatelanguage.md @@ -1,7 +1,5 @@ # TemplateUpdateTemplateLanguage -The language to use for email communications with recipients. - ## Values diff --git a/docs/models/templateupdatetemplatemeta.md b/docs/models/templateupdatetemplatemeta.md index 331f611..bd94296 100644 --- a/docs/models/templateupdatetemplatemeta.md +++ b/docs/models/templateupdatetemplatemeta.md @@ -5,16 +5,18 @@ | 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.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. | +| `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `date_format` | [Optional[models.TemplateUpdateTemplateDateFormat]](../models/templateupdatetemplatedateformat.md) | :heavy_minus_sign: | N/A | +| `distribution_method` | [Optional[models.TemplateUpdateTemplateDistributionMethod]](../models/templateupdatetemplatedistributionmethod.md) | :heavy_minus_sign: | N/A | +| `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. | -| `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. | +| `redirect_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `language` | [Optional[models.TemplateUpdateTemplateLanguage]](../models/templateupdatetemplatelanguage.md) | :heavy_minus_sign: | N/A | +| `typed_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `upload_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `draw_signature_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `signing_order` | [Optional[models.TemplateUpdateTemplateSigningOrder]](../models/templateupdatetemplatesigningorder.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/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/templateupdatetemplateunauthorizederror.md b/docs/models/templateupdatetemplateunauthorizederror.md new file mode 100644 index 0000000..a5a3956 --- /dev/null +++ b/docs/models/templateupdatetemplateunauthorizederror.md @@ -0,0 +1,12 @@ +# TemplateUpdateTemplateUnauthorizedError + +Authorization not provided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `issues` | List[[models.TemplateUpdateTemplateUnauthorizedIssue](../models/templateupdatetemplateunauthorizedissue.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/templateupdatetemplateunauthorizedissue.md b/docs/models/templateupdatetemplateunauthorizedissue.md new file mode 100644 index 0000000..d9a0531 --- /dev/null +++ b/docs/models/templateupdatetemplateunauthorizedissue.md @@ -0,0 +1,8 @@ +# TemplateUpdateTemplateUnauthorizedIssue + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdks/directlinksdk/README.md b/docs/sdks/directlinksdk/README.md index ffe0742..fe046de 100644 --- a/docs/sdks/directlinksdk/README.md +++ b/docs/sdks/directlinksdk/README.md @@ -34,11 +34,11 @@ with Documenso( ### Parameters -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `template_id` | *float* | :heavy_check_mark: | N/A | -| `direct_recipient_id` | *Optional[float]* | :heavy_minus_sign: | The of the recipient in the current template to transform into the primary recipient when the template is used. | -| `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 | +| `direct_recipient_id` | *Optional[float]* | :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 @@ -49,6 +49,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | models.TemplateCreateTemplateDirectLinkBadRequestError | 400 | application/json | +| models.TemplateCreateTemplateDirectLinkUnauthorizedError | 401 | application/json | +| models.TemplateCreateTemplateDirectLinkForbiddenError | 403 | application/json | | models.TemplateCreateTemplateDirectLinkInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -91,6 +93,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | models.TemplateDeleteTemplateDirectLinkBadRequestError | 400 | application/json | +| models.TemplateDeleteTemplateDirectLinkUnauthorizedError | 401 | application/json | +| models.TemplateDeleteTemplateDirectLinkForbiddenError | 403 | application/json | | models.TemplateDeleteTemplateDirectLinkInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -134,5 +138,7 @@ with Documenso( | Error Type | Status Code | Content Type | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | models.TemplateToggleTemplateDirectLinkBadRequestError | 400 | application/json | +| models.TemplateToggleTemplateDirectLinkUnauthorizedError | 401 | application/json | +| models.TemplateToggleTemplateDirectLinkForbiddenError | 403 | application/json | | models.TemplateToggleTemplateDirectLinkInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | \ 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..42b6113 100644 --- a/docs/sdks/documents/README.md +++ b/docs/sdks/documents/README.md @@ -5,22 +5,24 @@ ### Available Operations -* [update](#update) - Update document -* [find](#find) - Find documents * [get](#get) - Get document -* [create_v0](#create_v0) - Create document +* [find](#find) - Find documents +* [create](#create) - Create document +* [update](#update) - Update document * [delete](#delete) - Delete document +* [duplicate](#duplicate) - Duplicate document * [distribute](#distribute) - Distribute document * [redistribute](#redistribute) - Redistribute document -* [duplicate](#duplicate) - Duplicate document +* [download](#download) - Download 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 +32,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 +41,25 @@ 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.DocumentGetUnauthorizedError | 401 | application/json | +| models.DocumentGetForbiddenError | 403 | application/json | +| models.DocumentGetNotFoundError | 404 | application/json | +| models.DocumentGetInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | ## find @@ -64,7 +67,7 @@ Find documents based on a search criteria ### Example Usage - + ```python import documenso_sdk from documenso_sdk import Documenso @@ -99,24 +102,26 @@ 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.DocumentFindUnauthorizedError | 401 | application/json | +| models.DocumentFindForbiddenError | 403 | application/json | +| models.DocumentFindNotFoundError | 404 | application/json | +| models.DocumentFindInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | -## get +## create -Returns a document given an ID +Create a document using form data. ### Example Usage - + ```python from documenso_sdk import Documenso import os @@ -126,7 +131,12 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.get(document_id=7491.86) + res = documenso.documents.create(payload={ + "title": "", + }, file={ + "file_name": "example.file", + "content": open("example.file", "rb"), + }) # Handle response print(res) @@ -135,32 +145,33 @@ 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 | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `payload` | [models.DocumentCreatePayload](../../models/documentcreatepayload.md) | :heavy_check_mark: | N/A | +| `file` | [models.DocumentCreateFile](../../models/documentcreatefile.md) | :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.DocumentGetDocumentWithDetailsByIDResponse](../../models/documentgetdocumentwithdetailsbyidresponse.md)** +**[models.DocumentCreateResponse](../../models/documentcreateresponse.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.DocumentCreateBadRequestError | 400 | application/json | +| models.DocumentCreateUnauthorizedError | 401 | application/json | +| models.DocumentCreateForbiddenError | 403 | application/json | +| models.DocumentCreateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | -## create_v0 +## update -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. +Update document ### Example Usage - + ```python from documenso_sdk import Documenso import os @@ -170,7 +181,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.create_v0(title="") + res = documenso.documents.update(document_id=3428.95) # Handle response print(res) @@ -179,29 +190,26 @@ 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 | +| `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.DocumentCreateDocumentTemporaryResponse](../../models/documentcreatedocumenttemporaryresponse.md)** +**[models.DocumentUpdateResponse](../../models/documentupdateresponse.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.DocumentUpdateBadRequestError | 400 | application/json | +| models.DocumentUpdateUnauthorizedError | 401 | application/json | +| models.DocumentUpdateForbiddenError | 403 | application/json | +| models.DocumentUpdateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | ## delete @@ -209,7 +217,51 @@ Delete document ### Example Usage - + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.documents.delete(document_id=3963.4) + + # Handle response + print(res) + +``` + +### 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. | + +### Response + +**[models.DocumentDeleteResponse](../../models/documentdeleteresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| models.DocumentDeleteBadRequestError | 400 | application/json | +| models.DocumentDeleteUnauthorizedError | 401 | application/json | +| models.DocumentDeleteForbiddenError | 403 | application/json | +| models.DocumentDeleteInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## duplicate + +Duplicate document + +### Example Usage + + ```python from documenso_sdk import Documenso import os @@ -219,7 +271,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 +287,17 @@ 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.DocumentDuplicateUnauthorizedError | 401 | application/json | +| models.DocumentDuplicateForbiddenError | 403 | application/json | +| models.DocumentDuplicateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | ## distribute @@ -251,7 +305,7 @@ Send the document out to recipients based on your distribution method ### Example Usage - + ```python from documenso_sdk import Documenso import os @@ -261,7 +315,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 +324,25 @@ 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: | N/A | +| `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.DocumentDistributeUnauthorizedError | 401 | application/json | +| models.DocumentDistributeForbiddenError | 403 | application/json | +| models.DocumentDistributeInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | ## redistribute @@ -294,7 +350,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 +360,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) @@ -316,29 +376,32 @@ with Documenso( | Parameter | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `document_id` | *float* | :heavy_check_mark: | N/A | -| `recipients` | List[*float*] | :heavy_check_mark: | The IDs of the recipients to redistribute the document to. | +| `recipients` | List[*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.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.DocumentRedistributeUnauthorizedError | 401 | application/json | +| models.DocumentRedistributeForbiddenError | 403 | application/json | +| models.DocumentRedistributeInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | -## duplicate +## download -Duplicate document +Download document ### Example Usage - + ```python +import documenso_sdk from documenso_sdk import Documenso import os @@ -347,7 +410,7 @@ with Documenso( api_key=os.getenv("DOCUMENSO_API_KEY", ""), ) as documenso: - res = documenso.documents.duplicate(document_id=309.05) + res = documenso.documents.download(document_id=5396.97, version=documenso_sdk.DocumentDownloadVersion.SIGNED) # Handle response print(res) @@ -356,19 +419,76 @@ 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 | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | The ID of the document to download. | +| `version` | [Optional[models.DocumentDownloadVersion]](../../models/documentdownloadversion.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.DocumentDuplicateDocumentResponse](../../models/documentduplicatedocumentresponse.md)** +**[models.DocumentDownloadResponse](../../models/documentdownloadresponse.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.DocumentDownloadBadRequestError | 400 | application/json | +| models.DocumentDownloadUnauthorizedError | 401 | application/json | +| models.DocumentDownloadForbiddenError | 403 | application/json | +| models.DocumentDownloadNotFoundError | 404 | application/json | +| models.DocumentDownloadInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## create_v0 + +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.documents.create_v0(title="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| `title` | *str* | :heavy_check_mark: | N/A | +| `external_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `visibility` | [Optional[models.DocumentCreateDocumentTemporaryVisibilityRequest]](../../models/documentcreatedocumenttemporaryvisibilityrequest.md) | :heavy_minus_sign: | N/A | +| `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.DocumentCreateDocumentTemporaryFormValuesRequest](../../models/documentcreatedocumenttemporaryformvaluesrequest.md)] | :heavy_minus_sign: | N/A | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `recipients` | List[[models.DocumentCreateDocumentTemporaryRecipientRequest](../../models/documentcreatedocumenttemporaryrecipientrequest.md)] | :heavy_minus_sign: | N/A | +| `attachments` | List[[models.DocumentCreateDocumentTemporaryAttachment](../../models/documentcreatedocumenttemporaryattachment.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.DocumentCreateDocumentTemporaryResponse](../../models/documentcreatedocumenttemporaryresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| models.DocumentCreateDocumentTemporaryBadRequestError | 400 | application/json | +| models.DocumentCreateDocumentTemporaryUnauthorizedError | 401 | application/json | +| models.DocumentCreateDocumentTemporaryForbiddenError | 403 | application/json | +| models.DocumentCreateDocumentTemporaryInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/documentsattachments/README.md b/docs/sdks/documentsattachments/README.md new file mode 100644 index 0000000..c24294f --- /dev/null +++ b/docs/sdks/documentsattachments/README.md @@ -0,0 +1,196 @@ +# DocumentsAttachments +(*documents.attachments*) + +## Overview + +### Available Operations + +* [create](#create) - Create attachment +* [update](#update) - Update attachment +* [delete](#delete) - Delete attachment +* [find](#find) - Find attachments + +## create + +Create a new attachment for a document + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.documents.attachments.create(document_id=7014.36, data={ + "label": "", + "data": "https://cheerful-bourgeoisie.org/", + }) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `document_id` | *float* | :heavy_check_mark: | N/A | +| `data` | [models.DocumentAttachmentCreateData](../../models/documentattachmentcreatedata.md) | :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.DocumentAttachmentCreateResponse](../../models/documentattachmentcreateresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| models.DocumentAttachmentCreateBadRequestError | 400 | application/json | +| models.DocumentAttachmentCreateUnauthorizedError | 401 | application/json | +| models.DocumentAttachmentCreateForbiddenError | 403 | application/json | +| models.DocumentAttachmentCreateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## update + +Update an existing attachment + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.documents.attachments.update(id="", data={ + "label": "", + "data": "https://tinted-ceramics.biz", + }) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | N/A | +| `data` | [models.DocumentAttachmentUpdateData](../../models/documentattachmentupdatedata.md) | :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.DocumentAttachmentUpdateResponse](../../models/documentattachmentupdateresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| models.DocumentAttachmentUpdateBadRequestError | 400 | application/json | +| models.DocumentAttachmentUpdateUnauthorizedError | 401 | application/json | +| models.DocumentAttachmentUpdateForbiddenError | 403 | application/json | +| models.DocumentAttachmentUpdateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## delete + +Delete an attachment from a document + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.documents.attachments.delete(id="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `id` | *str* | :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.DocumentAttachmentDeleteResponse](../../models/documentattachmentdeleteresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| models.DocumentAttachmentDeleteBadRequestError | 400 | application/json | +| models.DocumentAttachmentDeleteUnauthorizedError | 401 | application/json | +| models.DocumentAttachmentDeleteForbiddenError | 403 | application/json | +| models.DocumentAttachmentDeleteInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## find + +Find all attachments for a document + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.documents.attachments.find(document_id=965.17) + + # Handle response + print(res) + +``` + +### 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. | + +### Response + +**[models.DocumentAttachmentFindResponse](../../models/documentattachmentfindresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | +| models.DocumentAttachmentFindBadRequestError | 400 | application/json | +| models.DocumentAttachmentFindUnauthorizedError | 401 | application/json | +| models.DocumentAttachmentFindForbiddenError | 403 | application/json | +| models.DocumentAttachmentFindNotFoundError | 404 | application/json | +| models.DocumentAttachmentFindInternalServerError | 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..de749c3 --- /dev/null +++ b/docs/sdks/documentsdk/README.md @@ -0,0 +1,55 @@ +# 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=9550.11, version=documenso_sdk.DocumentDownloadBetaVersion.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.DocumentDownloadBetaVersion]](../../models/documentdownloadbetaversion.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.DocumentDownloadBetaResponse](../../models/documentdownloadbetaresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| models.DocumentDownloadBetaBadRequestError | 400 | application/json | +| models.DocumentDownloadBetaUnauthorizedError | 401 | application/json | +| models.DocumentDownloadBetaForbiddenError | 403 | application/json | +| models.DocumentDownloadBetaNotFoundError | 404 | application/json | +| models.DocumentDownloadBetaInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/documentsfields/README.md b/docs/sdks/documentsfields/README.md index d498777..c0587e4 100644 --- a/docs/sdks/documentsfields/README.md +++ b/docs/sdks/documentsfields/README.md @@ -51,6 +51,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | | models.FieldGetDocumentFieldBadRequestError | 400 | application/json | +| models.FieldGetDocumentFieldUnauthorizedError | 401 | application/json | +| models.FieldGetDocumentFieldForbiddenError | 403 | application/json | | models.FieldGetDocumentFieldNotFoundError | 404 | application/json | | models.FieldGetDocumentFieldInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -104,6 +106,8 @@ with Documenso( | Error Type | Status Code | Content Type | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | | models.FieldCreateDocumentFieldBadRequestError | 400 | application/json | +| models.FieldCreateDocumentFieldUnauthorizedError | 401 | application/json | +| models.FieldCreateDocumentFieldForbiddenError | 403 | application/json | | models.FieldCreateDocumentFieldInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -158,6 +162,8 @@ with Documenso( | Error Type | Status Code | Content Type | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | | models.FieldCreateDocumentFieldsBadRequestError | 400 | application/json | +| models.FieldCreateDocumentFieldsUnauthorizedError | 401 | application/json | +| models.FieldCreateDocumentFieldsForbiddenError | 403 | application/json | | models.FieldCreateDocumentFieldsInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -205,6 +211,8 @@ with Documenso( | Error Type | Status Code | Content Type | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | | models.FieldUpdateDocumentFieldBadRequestError | 400 | application/json | +| models.FieldUpdateDocumentFieldUnauthorizedError | 401 | application/json | +| models.FieldUpdateDocumentFieldForbiddenError | 403 | application/json | | models.FieldUpdateDocumentFieldInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -248,6 +256,8 @@ with Documenso( | Error Type | Status Code | Content Type | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | | models.FieldUpdateDocumentFieldsBadRequestError | 400 | application/json | +| models.FieldUpdateDocumentFieldsUnauthorizedError | 401 | application/json | +| models.FieldUpdateDocumentFieldsForbiddenError | 403 | application/json | | models.FieldUpdateDocumentFieldsInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -290,5 +300,7 @@ with Documenso( | Error Type | Status Code | Content Type | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | | models.FieldDeleteDocumentFieldBadRequestError | 400 | application/json | +| models.FieldDeleteDocumentFieldUnauthorizedError | 401 | application/json | +| models.FieldDeleteDocumentFieldForbiddenError | 403 | application/json | | models.FieldDeleteDocumentFieldInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/documentsrecipients/README.md b/docs/sdks/documentsrecipients/README.md index eaab57d..10d129d 100644 --- a/docs/sdks/documentsrecipients/README.md +++ b/docs/sdks/documentsrecipients/README.md @@ -51,6 +51,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | models.RecipientGetDocumentRecipientBadRequestError | 400 | application/json | +| models.RecipientGetDocumentRecipientUnauthorizedError | 401 | application/json | +| models.RecipientGetDocumentRecipientForbiddenError | 403 | application/json | | models.RecipientGetDocumentRecipientNotFoundError | 404 | application/json | | models.RecipientGetDocumentRecipientInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -100,6 +102,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | models.RecipientCreateDocumentRecipientBadRequestError | 400 | application/json | +| models.RecipientCreateDocumentRecipientUnauthorizedError | 401 | application/json | +| models.RecipientCreateDocumentRecipientForbiddenError | 403 | application/json | | models.RecipientCreateDocumentRecipientInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -150,6 +154,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | models.RecipientCreateDocumentRecipientsBadRequestError | 400 | application/json | +| models.RecipientCreateDocumentRecipientsUnauthorizedError | 401 | application/json | +| models.RecipientCreateDocumentRecipientsForbiddenError | 403 | application/json | | models.RecipientCreateDocumentRecipientsInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -195,6 +201,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | models.RecipientUpdateDocumentRecipientBadRequestError | 400 | application/json | +| models.RecipientUpdateDocumentRecipientUnauthorizedError | 401 | application/json | +| models.RecipientUpdateDocumentRecipientForbiddenError | 403 | application/json | | models.RecipientUpdateDocumentRecipientInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -238,6 +246,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | models.RecipientUpdateDocumentRecipientsBadRequestError | 400 | application/json | +| models.RecipientUpdateDocumentRecipientsUnauthorizedError | 401 | application/json | +| models.RecipientUpdateDocumentRecipientsForbiddenError | 403 | application/json | | models.RecipientUpdateDocumentRecipientsInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -280,5 +290,7 @@ with Documenso( | Error Type | Status Code | Content Type | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | models.RecipientDeleteDocumentRecipientBadRequestError | 400 | application/json | +| models.RecipientDeleteDocumentRecipientUnauthorizedError | 401 | application/json | +| models.RecipientDeleteDocumentRecipientForbiddenError | 403 | application/json | | models.RecipientDeleteDocumentRecipientInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/embedding/README.md b/docs/sdks/embedding/README.md index fb9790b..3a37d34 100644 --- a/docs/sdks/embedding/README.md +++ b/docs/sdks/embedding/README.md @@ -35,7 +35,7 @@ with Documenso( | Parameter | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `expires_in` | *Optional[float]* | :heavy_minus_sign: | Expiration time in minutes (default: 60, max: 10,080) | +| `expires_in` | *Optional[float]* | :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 @@ -47,6 +47,8 @@ with Documenso( | Error Type | Status Code | Content Type | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | models.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError | 400 | application/json | +| models.EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError | 401 | application/json | +| models.EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError | 403 | application/json | | models.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -77,7 +79,7 @@ with Documenso( | Parameter | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `token` | *str* | :heavy_check_mark: | The presign token to verify | +| `token` | *str* | :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 @@ -89,5 +91,7 @@ with Documenso( | Error Type | Status Code | Content Type | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | models.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError | 400 | application/json | +| models.EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError | 401 | application/json | +| models.EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError | 403 | application/json | | models.EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/envelopes/README.md b/docs/sdks/envelopes/README.md new file mode 100644 index 0000000..8f5983a --- /dev/null +++ b/docs/sdks/envelopes/README.md @@ -0,0 +1,381 @@ +# Envelopes +(*envelopes*) + +## Overview + +### Available Operations + +* [get](#get) - Get envelope +* [create](#create) - Create envelope +* [use](#use) - Use envelope +* [update](#update) - Update envelope +* [delete](#delete) - Delete envelope +* [duplicate](#duplicate) - Duplicate envelope +* [distribute](#distribute) - Distribute envelope +* [redistribute](#redistribute) - Redistribute envelope + +## get + +Returns an envelope given an ID + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.get(envelope_id="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `envelope_id` | *str* | :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.EnvelopeGetResponse](../../models/envelopegetresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | +| models.EnvelopeGetBadRequestError | 400 | application/json | +| models.EnvelopeGetUnauthorizedError | 401 | application/json | +| models.EnvelopeGetForbiddenError | 403 | application/json | +| models.EnvelopeGetNotFoundError | 404 | application/json | +| models.EnvelopeGetInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## create + +Create an envelope using form data. + +### 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.envelopes.create(payload={ + "title": "", + "type": documenso_sdk.EnvelopeCreateType.TEMPLATE, + }) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `payload` | [models.EnvelopeCreatePayload](../../models/envelopecreatepayload.md) | :heavy_check_mark: | N/A | +| `files` | List[[models.EnvelopeCreateFile](../../models/envelopecreatefile.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.EnvelopeCreateResponse](../../models/envelopecreateresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| models.EnvelopeCreateBadRequestError | 400 | application/json | +| models.EnvelopeCreateUnauthorizedError | 401 | application/json | +| models.EnvelopeCreateForbiddenError | 403 | application/json | +| models.EnvelopeCreateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## use + +Create a document envelope from a template envelope. Upload custom files to replace the template PDFs and map them to specific envelope items using identifiers. + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.use(payload={ + "envelope_id": "", + "recipients": [], + }) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `payload` | [models.EnvelopeUsePayload](../../models/envelopeusepayload.md) | :heavy_check_mark: | N/A | +| `files` | List[[models.EnvelopeUseFile](../../models/envelopeusefile.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.EnvelopeUseResponse](../../models/envelopeuseresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | +| models.EnvelopeUseBadRequestError | 400 | application/json | +| models.EnvelopeUseUnauthorizedError | 401 | application/json | +| models.EnvelopeUseForbiddenError | 403 | application/json | +| models.EnvelopeUseInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## update + +Update envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.update(envelope_id="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | [Optional[models.EnvelopeUpdateData]](../../models/envelopeupdatedata.md) | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.EnvelopeUpdateMeta]](../../models/envelopeupdatemeta.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.EnvelopeUpdateResponse](../../models/envelopeupdateresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| models.EnvelopeUpdateBadRequestError | 400 | application/json | +| models.EnvelopeUpdateUnauthorizedError | 401 | application/json | +| models.EnvelopeUpdateForbiddenError | 403 | application/json | +| models.EnvelopeUpdateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## delete + +Delete envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.delete(envelope_id="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `envelope_id` | *str* | :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.EnvelopeDeleteResponse](../../models/envelopedeleteresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| models.EnvelopeDeleteBadRequestError | 400 | application/json | +| models.EnvelopeDeleteUnauthorizedError | 401 | application/json | +| models.EnvelopeDeleteForbiddenError | 403 | application/json | +| models.EnvelopeDeleteInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## duplicate + +Duplicate an envelope with all its settings + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.duplicate(envelope_id="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `envelope_id` | *str* | :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.EnvelopeDuplicateResponse](../../models/envelopeduplicateresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| models.EnvelopeDuplicateBadRequestError | 400 | application/json | +| models.EnvelopeDuplicateUnauthorizedError | 401 | application/json | +| models.EnvelopeDuplicateForbiddenError | 403 | application/json | +| models.EnvelopeDuplicateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## distribute + +Send the envelope to recipients based on your distribution method + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.distribute(envelope_id="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `meta` | [Optional[models.EnvelopeDistributeMeta]](../../models/envelopedistributemeta.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.EnvelopeDistributeResponse](../../models/envelopedistributeresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| models.EnvelopeDistributeBadRequestError | 400 | application/json | +| models.EnvelopeDistributeUnauthorizedError | 401 | application/json | +| models.EnvelopeDistributeForbiddenError | 403 | application/json | +| models.EnvelopeDistributeInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## redistribute + +Redistribute the envelope to the provided recipients who have not actioned the envelope. Will use the distribution method set in the envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.redistribute(envelope_id="", recipients=[]) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `recipients` | List[*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.EnvelopeRedistributeResponse](../../models/enveloperedistributeresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| models.EnvelopeRedistributeBadRequestError | 400 | application/json | +| models.EnvelopeRedistributeUnauthorizedError | 401 | application/json | +| models.EnvelopeRedistributeForbiddenError | 403 | application/json | +| models.EnvelopeRedistributeInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/envelopesattachments/README.md b/docs/sdks/envelopesattachments/README.md new file mode 100644 index 0000000..9eb55ba --- /dev/null +++ b/docs/sdks/envelopesattachments/README.md @@ -0,0 +1,197 @@ +# EnvelopesAttachments +(*envelopes.attachments*) + +## Overview + +### Available Operations + +* [find](#find) - Find attachments +* [create](#create) - Create attachment +* [update](#update) - Update attachment +* [delete](#delete) - Delete attachment + +## find + +Find all attachments for an envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.attachments.find(envelope_id="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `token` | *Optional[str]* | :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.EnvelopeAttachmentFindResponse](../../models/envelopeattachmentfindresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | +| models.EnvelopeAttachmentFindBadRequestError | 400 | application/json | +| models.EnvelopeAttachmentFindUnauthorizedError | 401 | application/json | +| models.EnvelopeAttachmentFindForbiddenError | 403 | application/json | +| models.EnvelopeAttachmentFindNotFoundError | 404 | application/json | +| models.EnvelopeAttachmentFindInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## create + +Create a new attachment for an envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.attachments.create(envelope_id="", data={ + "label": "", + "data": "https://lustrous-skeleton.info", + }) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | [models.EnvelopeAttachmentCreateData](../../models/envelopeattachmentcreatedata.md) | :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.EnvelopeAttachmentCreateResponse](../../models/envelopeattachmentcreateresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| models.EnvelopeAttachmentCreateBadRequestError | 400 | application/json | +| models.EnvelopeAttachmentCreateUnauthorizedError | 401 | application/json | +| models.EnvelopeAttachmentCreateForbiddenError | 403 | application/json | +| models.EnvelopeAttachmentCreateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## update + +Update an existing attachment + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.attachments.update(id="", data={ + "label": "", + "data": "https://tough-premier.biz", + }) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | N/A | +| `data` | [models.EnvelopeAttachmentUpdateData](../../models/envelopeattachmentupdatedata.md) | :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.EnvelopeAttachmentUpdateResponse](../../models/envelopeattachmentupdateresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| models.EnvelopeAttachmentUpdateBadRequestError | 400 | application/json | +| models.EnvelopeAttachmentUpdateUnauthorizedError | 401 | application/json | +| models.EnvelopeAttachmentUpdateForbiddenError | 403 | application/json | +| models.EnvelopeAttachmentUpdateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## delete + +Delete an attachment from an envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.attachments.delete(id="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `id` | *str* | :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.EnvelopeAttachmentDeleteResponse](../../models/envelopeattachmentdeleteresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| models.EnvelopeAttachmentDeleteBadRequestError | 400 | application/json | +| models.EnvelopeAttachmentDeleteUnauthorizedError | 401 | application/json | +| models.EnvelopeAttachmentDeleteForbiddenError | 403 | application/json | +| models.EnvelopeAttachmentDeleteInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/envelopesfields/README.md b/docs/sdks/envelopesfields/README.md new file mode 100644 index 0000000..00df8ef --- /dev/null +++ b/docs/sdks/envelopesfields/README.md @@ -0,0 +1,190 @@ +# EnvelopesFields +(*envelopes.fields*) + +## Overview + +### Available Operations + +* [get](#get) - Get envelope field +* [create_many](#create_many) - Create envelope fields +* [update_many](#update_many) - Update envelope fields +* [delete](#delete) - Delete envelope field + +## get + +Returns an envelope field given an ID + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.fields.get(field_id=6981.76) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `field_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.EnvelopeFieldGetResponse](../../models/envelopefieldgetresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | +| models.EnvelopeFieldGetBadRequestError | 400 | application/json | +| models.EnvelopeFieldGetUnauthorizedError | 401 | application/json | +| models.EnvelopeFieldGetForbiddenError | 403 | application/json | +| models.EnvelopeFieldGetNotFoundError | 404 | application/json | +| models.EnvelopeFieldGetInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## create_many + +Create multiple fields for an envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.fields.create_many(envelope_id="", data=[]) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | List[[models.EnvelopeFieldCreateManyDataUnion](../../models/envelopefieldcreatemanydataunion.md)] | :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.EnvelopeFieldCreateManyResponse](../../models/envelopefieldcreatemanyresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | +| models.EnvelopeFieldCreateManyBadRequestError | 400 | application/json | +| models.EnvelopeFieldCreateManyUnauthorizedError | 401 | application/json | +| models.EnvelopeFieldCreateManyForbiddenError | 403 | application/json | +| models.EnvelopeFieldCreateManyInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## update_many + +Update multiple envelope fields for an envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.fields.update_many(envelope_id="", data=[]) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | List[[models.EnvelopeFieldUpdateManyDataUnion](../../models/envelopefieldupdatemanydataunion.md)] | :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.EnvelopeFieldUpdateManyResponse](../../models/envelopefieldupdatemanyresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | +| models.EnvelopeFieldUpdateManyBadRequestError | 400 | application/json | +| models.EnvelopeFieldUpdateManyUnauthorizedError | 401 | application/json | +| models.EnvelopeFieldUpdateManyForbiddenError | 403 | application/json | +| models.EnvelopeFieldUpdateManyInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## delete + +Delete an envelope field + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.fields.delete(field_id=2481.37) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `field_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.EnvelopeFieldDeleteResponse](../../models/envelopefielddeleteresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| models.EnvelopeFieldDeleteBadRequestError | 400 | application/json | +| models.EnvelopeFieldDeleteUnauthorizedError | 401 | application/json | +| models.EnvelopeFieldDeleteForbiddenError | 403 | application/json | +| models.EnvelopeFieldDeleteInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/envelopesrecipients/README.md b/docs/sdks/envelopesrecipients/README.md new file mode 100644 index 0000000..d612f94 --- /dev/null +++ b/docs/sdks/envelopesrecipients/README.md @@ -0,0 +1,201 @@ +# EnvelopesRecipients +(*envelopes.recipients*) + +## Overview + +### Available Operations + +* [get](#get) - Get envelope recipient +* [create_many](#create_many) - Create envelope recipients +* [update_many](#update_many) - Update envelope recipients +* [delete](#delete) - Delete envelope recipient + +## get + +Returns an envelope recipient given an ID + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.recipients.get(recipient_id=8771.72) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `recipient_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.EnvelopeRecipientGetResponse](../../models/enveloperecipientgetresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| models.EnvelopeRecipientGetBadRequestError | 400 | application/json | +| models.EnvelopeRecipientGetUnauthorizedError | 401 | application/json | +| models.EnvelopeRecipientGetForbiddenError | 403 | application/json | +| models.EnvelopeRecipientGetNotFoundError | 404 | application/json | +| models.EnvelopeRecipientGetInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## create_many + +Create multiple recipients for an envelope + +### 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.envelopes.recipients.create_many(envelope_id="", data=[ + { + "email": "Ed16@yahoo.com", + "name": "", + "role": documenso_sdk.EnvelopeRecipientCreateManyRoleRequest.SIGNER, + }, + ]) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | List[[models.EnvelopeRecipientCreateManyDataRequest](../../models/enveloperecipientcreatemanydatarequest.md)] | :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.EnvelopeRecipientCreateManyResponse](../../models/enveloperecipientcreatemanyresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| models.EnvelopeRecipientCreateManyBadRequestError | 400 | application/json | +| models.EnvelopeRecipientCreateManyUnauthorizedError | 401 | application/json | +| models.EnvelopeRecipientCreateManyForbiddenError | 403 | application/json | +| models.EnvelopeRecipientCreateManyInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## update_many + +Update multiple recipients for an envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.recipients.update_many(envelope_id="", data=[ + { + "id": 8894.57, + }, + ]) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | List[[models.EnvelopeRecipientUpdateManyDataRequest](../../models/enveloperecipientupdatemanydatarequest.md)] | :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.EnvelopeRecipientUpdateManyResponse](../../models/enveloperecipientupdatemanyresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| models.EnvelopeRecipientUpdateManyBadRequestError | 400 | application/json | +| models.EnvelopeRecipientUpdateManyUnauthorizedError | 401 | application/json | +| models.EnvelopeRecipientUpdateManyForbiddenError | 403 | application/json | +| models.EnvelopeRecipientUpdateManyInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## delete + +Delete an envelope recipient + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.recipients.delete(recipient_id=4834.93) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `recipient_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.EnvelopeRecipientDeleteResponse](../../models/enveloperecipientdeleteresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | +| models.EnvelopeRecipientDeleteBadRequestError | 400 | application/json | +| models.EnvelopeRecipientDeleteUnauthorizedError | 401 | application/json | +| models.EnvelopeRecipientDeleteForbiddenError | 403 | application/json | +| models.EnvelopeRecipientDeleteInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/folders/README.md b/docs/sdks/folders/README.md new file mode 100644 index 0000000..046d361 --- /dev/null +++ b/docs/sdks/folders/README.md @@ -0,0 +1,195 @@ +# Folders +(*folders*) + +## Overview + +### Available Operations + +* [find](#find) - Find folders +* [create](#create) - Create new folder +* [update](#update) - Update folder +* [delete](#delete) - Delete folder + +## find + +Find folders based on a search criteria + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.folders.find() + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `query` | *Optional[str]* | :heavy_minus_sign: | The search query. | +| `page` | *Optional[float]* | :heavy_minus_sign: | The pagination page number, starts at 1. | +| `per_page` | *Optional[float]* | :heavy_minus_sign: | The number of items per page. | +| `parent_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[models.FolderFindFoldersQueryParamType]](../../models/folderfindfoldersqueryparamtype.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.FolderFindFoldersResponse](../../models/folderfindfoldersresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| models.FolderFindFoldersBadRequestError | 400 | application/json | +| models.FolderFindFoldersUnauthorizedError | 401 | application/json | +| models.FolderFindFoldersForbiddenError | 403 | application/json | +| models.FolderFindFoldersNotFoundError | 404 | application/json | +| models.FolderFindFoldersInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## create + +Creates a new folder in your team + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.folders.create(name="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `name` | *str* | :heavy_check_mark: | N/A | +| `parent_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[models.FolderCreateFolderTypeRequest]](../../models/foldercreatefoldertyperequest.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.FolderCreateFolderResponse](../../models/foldercreatefolderresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| models.FolderCreateFolderBadRequestError | 400 | application/json | +| models.FolderCreateFolderUnauthorizedError | 401 | application/json | +| models.FolderCreateFolderForbiddenError | 403 | application/json | +| models.FolderCreateFolderInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## update + +Updates an existing folder + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.folders.update(folder_id="", data={}) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `folder_id` | *str* | :heavy_check_mark: | N/A | +| `data` | [models.FolderUpdateFolderData](../../models/folderupdatefolderdata.md) | :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.FolderUpdateFolderResponse](../../models/folderupdatefolderresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| models.FolderUpdateFolderBadRequestError | 400 | application/json | +| models.FolderUpdateFolderUnauthorizedError | 401 | application/json | +| models.FolderUpdateFolderForbiddenError | 403 | application/json | +| models.FolderUpdateFolderInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## delete + +Deletes an existing folder + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.folders.delete(folder_id="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `folder_id` | *str* | :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.FolderDeleteFolderResponse](../../models/folderdeletefolderresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| models.FolderDeleteFolderBadRequestError | 400 | application/json | +| models.FolderDeleteFolderUnauthorizedError | 401 | application/json | +| models.FolderDeleteFolderForbiddenError | 403 | application/json | +| models.FolderDeleteFolderInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/items/README.md b/docs/sdks/items/README.md new file mode 100644 index 0000000..adc4cbe --- /dev/null +++ b/docs/sdks/items/README.md @@ -0,0 +1,195 @@ +# Items +(*envelopes.items*) + +## Overview + +### Available Operations + +* [create_many](#create_many) - Create envelope items +* [update_many](#update_many) - Update envelope items +* [delete](#delete) - Delete envelope item +* [download](#download) - Download an envelope item + +## create_many + +Create multiple envelope items for an envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.items.create_many(payload={ + "envelope_id": "", + }) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `payload` | [models.EnvelopeItemCreateManyPayload](../../models/envelopeitemcreatemanypayload.md) | :heavy_check_mark: | N/A | +| `files` | List[[models.EnvelopeItemCreateManyFile](../../models/envelopeitemcreatemanyfile.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.EnvelopeItemCreateManyResponse](../../models/envelopeitemcreatemanyresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | +| models.EnvelopeItemCreateManyBadRequestError | 400 | application/json | +| models.EnvelopeItemCreateManyUnauthorizedError | 401 | application/json | +| models.EnvelopeItemCreateManyForbiddenError | 403 | application/json | +| models.EnvelopeItemCreateManyInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## update_many + +Update multiple envelope items for an envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.items.update_many(envelope_id="", data=[]) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `data` | List[[models.EnvelopeItemUpdateManyDataRequest](../../models/envelopeitemupdatemanydatarequest.md)] | :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.EnvelopeItemUpdateManyResponse](../../models/envelopeitemupdatemanyresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | +| models.EnvelopeItemUpdateManyBadRequestError | 400 | application/json | +| models.EnvelopeItemUpdateManyUnauthorizedError | 401 | application/json | +| models.EnvelopeItemUpdateManyForbiddenError | 403 | application/json | +| models.EnvelopeItemUpdateManyInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## delete + +Delete an envelope item from an envelope + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.envelopes.items.delete(envelope_id="", envelope_item_id="") + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `envelope_id` | *str* | :heavy_check_mark: | N/A | +| `envelope_item_id` | *str* | :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.EnvelopeItemDeleteResponse](../../models/envelopeitemdeleteresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| models.EnvelopeItemDeleteBadRequestError | 400 | application/json | +| models.EnvelopeItemDeleteUnauthorizedError | 401 | application/json | +| models.EnvelopeItemDeleteForbiddenError | 403 | application/json | +| models.EnvelopeItemDeleteInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + +## download + +Download an envelope item by its ID + +### 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.envelopes.items.download(envelope_item_id="", version=documenso_sdk.EnvelopeItemDownloadVersion.SIGNED) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `envelope_item_id` | *str* | :heavy_check_mark: | The ID of the envelope item to download. | +| `version` | [Optional[models.EnvelopeItemDownloadVersion]](../../models/envelopeitemdownloadversion.md) | :heavy_minus_sign: | The version of the envelope item 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.EnvelopeItemDownloadResponse](../../models/envelopeitemdownloadresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| models.EnvelopeItemDownloadBadRequestError | 400 | application/json | +| models.EnvelopeItemDownloadUnauthorizedError | 401 | application/json | +| models.EnvelopeItemDownloadForbiddenError | 403 | application/json | +| models.EnvelopeItemDownloadNotFoundError | 404 | application/json | +| models.EnvelopeItemDownloadInternalServerError | 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..d7b5c77 100644 --- a/docs/sdks/templates/README.md +++ b/docs/sdks/templates/README.md @@ -7,6 +7,7 @@ * [find](#find) - Find templates * [get](#get) - Get template +* [create](#create) - Create template * [update](#update) - Update template * [duplicate](#duplicate) - Duplicate template * [delete](#delete) - Delete template @@ -37,14 +38,14 @@ with Documenso( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `query` | *Optional[str]* | :heavy_minus_sign: | The search query. | -| `page` | *Optional[float]* | :heavy_minus_sign: | The pagination page number, starts at 1. | -| `per_page` | *Optional[float]* | :heavy_minus_sign: | The number of items per page. | -| `type` | [Optional[models.QueryParamType]](../../models/queryparamtype.md) | :heavy_minus_sign: | Filter templates by type. | -| `folder_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the folder to filter templates by. | -| `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 | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `query` | *Optional[str]* | :heavy_minus_sign: | The search query. | +| `page` | *Optional[float]* | :heavy_minus_sign: | The pagination page number, starts at 1. | +| `per_page` | *Optional[float]* | :heavy_minus_sign: | The number of items per page. | +| `type` | [Optional[models.TemplateFindTemplatesQueryParamType]](../../models/templatefindtemplatesqueryparamtype.md) | :heavy_minus_sign: | Filter templates by type. | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the folder to filter templates by. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -55,6 +56,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | | models.TemplateFindTemplatesBadRequestError | 400 | application/json | +| models.TemplateFindTemplatesUnauthorizedError | 401 | application/json | +| models.TemplateFindTemplatesForbiddenError | 403 | application/json | | models.TemplateFindTemplatesNotFoundError | 404 | application/json | | models.TemplateFindTemplatesInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -98,10 +101,62 @@ with Documenso( | Error Type | Status Code | Content Type | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | | models.TemplateGetTemplateByIDBadRequestError | 400 | application/json | +| models.TemplateGetTemplateByIDUnauthorizedError | 401 | application/json | +| models.TemplateGetTemplateByIDForbiddenError | 403 | application/json | | models.TemplateGetTemplateByIDNotFoundError | 404 | application/json | | models.TemplateGetTemplateByIDInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | +## create + +Create a new template + +### Example Usage + + +```python +from documenso_sdk import Documenso +import os + + +with Documenso( + api_key=os.getenv("DOCUMENSO_API_KEY", ""), +) as documenso: + + res = documenso.templates.create(payload={ + "title": "", + }, file={ + "file_name": "example.file", + "content": open("example.file", "rb"), + }) + + # Handle response + print(res) + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `payload` | [models.TemplateCreateTemplatePayload](../../models/templatecreatetemplatepayload.md) | :heavy_check_mark: | N/A | +| `file` | [models.TemplateCreateTemplateFile](../../models/templatecreatetemplatefile.md) | :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.TemplateCreateTemplateResponse](../../models/templatecreatetemplateresponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | +| models.TemplateCreateTemplateBadRequestError | 400 | application/json | +| models.TemplateCreateTemplateUnauthorizedError | 401 | application/json | +| models.TemplateCreateTemplateForbiddenError | 403 | application/json | +| models.TemplateCreateTemplateInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | + ## update Update template @@ -143,6 +198,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | | models.TemplateUpdateTemplateBadRequestError | 400 | application/json | +| models.TemplateUpdateTemplateUnauthorizedError | 401 | application/json | +| models.TemplateUpdateTemplateForbiddenError | 403 | application/json | | models.TemplateUpdateTemplateInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -185,6 +242,8 @@ with Documenso( | Error Type | Status Code | Content Type | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | | models.TemplateDuplicateTemplateBadRequestError | 400 | application/json | +| models.TemplateDuplicateTemplateUnauthorizedError | 401 | application/json | +| models.TemplateDuplicateTemplateForbiddenError | 403 | application/json | | models.TemplateDuplicateTemplateInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -227,6 +286,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | | models.TemplateDeleteTemplateBadRequestError | 400 | application/json | +| models.TemplateDeleteTemplateUnauthorizedError | 401 | application/json | +| models.TemplateDeleteTemplateForbiddenError | 403 | application/json | | models.TemplateDeleteTemplateInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -255,14 +316,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: | N/A | +| `distribute_document` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `custom_document_data_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `custom_document_data` | List[[models.TemplateCreateDocumentFromTemplateCustomDocumentDatum](../../models/templatecreatedocumentfromtemplatecustomdocumentdatum.md)] | :heavy_minus_sign: | N/A | +| `folder_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `prefill_fields` | List[[models.TemplateCreateDocumentFromTemplatePrefillFieldUnion](../../models/templatecreatedocumentfromtemplateprefillfieldunion.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 @@ -273,5 +336,7 @@ with Documenso( | Error Type | Status Code | Content Type | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | | models.TemplateCreateDocumentFromTemplateBadRequestError | 400 | application/json | +| models.TemplateCreateDocumentFromTemplateUnauthorizedError | 401 | application/json | +| models.TemplateCreateDocumentFromTemplateForbiddenError | 403 | application/json | | models.TemplateCreateDocumentFromTemplateInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/templatesdk/README.md b/docs/sdks/templatesdk/README.md new file mode 100644 index 0000000..7eb994c --- /dev/null +++ b/docs/sdks/templatesdk/README.md @@ -0,0 +1,62 @@ +# 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: | N/A | +| `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: | N/A | +| `public_description` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[models.TemplateCreateTemplateTemporaryTypeRequest]](../../models/templatecreatetemplatetemporarytyperequest.md) | :heavy_minus_sign: | N/A | +| `meta` | [Optional[models.TemplateCreateTemplateTemporaryMeta]](../../models/templatecreatetemplatetemporarymeta.md) | :heavy_minus_sign: | N/A | +| `attachments` | List[[models.TemplateCreateTemplateTemporaryAttachment](../../models/templatecreatetemplatetemporaryattachment.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.TemplateCreateTemplateTemporaryUnauthorizedError | 401 | application/json | +| models.TemplateCreateTemplateTemporaryForbiddenError | 403 | application/json | +| models.TemplateCreateTemplateTemporaryInternalServerError | 500 | application/json | +| models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/templatesfields/README.md b/docs/sdks/templatesfields/README.md index 8f52dda..d81f52c 100644 --- a/docs/sdks/templatesfields/README.md +++ b/docs/sdks/templatesfields/README.md @@ -61,6 +61,8 @@ with Documenso( | Error Type | Status Code | Content Type | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | | models.FieldCreateTemplateFieldBadRequestError | 400 | application/json | +| models.FieldCreateTemplateFieldUnauthorizedError | 401 | application/json | +| models.FieldCreateTemplateFieldForbiddenError | 403 | application/json | | models.FieldCreateTemplateFieldInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -103,6 +105,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | | models.FieldGetTemplateFieldBadRequestError | 400 | application/json | +| models.FieldGetTemplateFieldUnauthorizedError | 401 | application/json | +| models.FieldGetTemplateFieldForbiddenError | 403 | application/json | | models.FieldGetTemplateFieldNotFoundError | 404 | application/json | | models.FieldGetTemplateFieldInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -126,7 +130,7 @@ with Documenso( res = documenso.templates.fields.create_many(template_id=586.2, fields=[ { - "type": documenso_sdk.FieldCreateTemplateFieldsTypeSignature.SIGNATURE, + "type": documenso_sdk.FieldCreateTemplateFieldsTypeSignatureRequest1.SIGNATURE, "recipient_id": 6990.12, "page_number": 3472.45, "page_x": 4747.87, @@ -158,6 +162,8 @@ with Documenso( | Error Type | Status Code | Content Type | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | | models.FieldCreateTemplateFieldsBadRequestError | 400 | application/json | +| models.FieldCreateTemplateFieldsUnauthorizedError | 401 | application/json | +| models.FieldCreateTemplateFieldsForbiddenError | 403 | application/json | | models.FieldCreateTemplateFieldsInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -205,6 +211,8 @@ with Documenso( | Error Type | Status Code | Content Type | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | | models.FieldUpdateTemplateFieldBadRequestError | 400 | application/json | +| models.FieldUpdateTemplateFieldUnauthorizedError | 401 | application/json | +| models.FieldUpdateTemplateFieldForbiddenError | 403 | application/json | | models.FieldUpdateTemplateFieldInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -254,6 +262,8 @@ with Documenso( | Error Type | Status Code | Content Type | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | | models.FieldUpdateTemplateFieldsBadRequestError | 400 | application/json | +| models.FieldUpdateTemplateFieldsUnauthorizedError | 401 | application/json | +| models.FieldUpdateTemplateFieldsForbiddenError | 403 | application/json | | models.FieldUpdateTemplateFieldsInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -296,5 +306,7 @@ with Documenso( | Error Type | Status Code | Content Type | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | | models.FieldDeleteTemplateFieldBadRequestError | 400 | application/json | +| models.FieldDeleteTemplateFieldUnauthorizedError | 401 | application/json | +| models.FieldDeleteTemplateFieldForbiddenError | 403 | application/json | | models.FieldDeleteTemplateFieldInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/templatesrecipients/README.md b/docs/sdks/templatesrecipients/README.md index 71af92d..4b479cf 100644 --- a/docs/sdks/templatesrecipients/README.md +++ b/docs/sdks/templatesrecipients/README.md @@ -51,6 +51,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | models.RecipientGetTemplateRecipientBadRequestError | 400 | application/json | +| models.RecipientGetTemplateRecipientUnauthorizedError | 401 | application/json | +| models.RecipientGetTemplateRecipientForbiddenError | 403 | application/json | | models.RecipientGetTemplateRecipientNotFoundError | 404 | application/json | | models.RecipientGetTemplateRecipientInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -100,6 +102,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | models.RecipientCreateTemplateRecipientBadRequestError | 400 | application/json | +| models.RecipientCreateTemplateRecipientUnauthorizedError | 401 | application/json | +| models.RecipientCreateTemplateRecipientForbiddenError | 403 | application/json | | models.RecipientCreateTemplateRecipientInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -143,6 +147,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | models.RecipientCreateTemplateRecipientsBadRequestError | 400 | application/json | +| models.RecipientCreateTemplateRecipientsUnauthorizedError | 401 | application/json | +| models.RecipientCreateTemplateRecipientsForbiddenError | 403 | application/json | | models.RecipientCreateTemplateRecipientsInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -188,6 +194,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | models.RecipientUpdateTemplateRecipientBadRequestError | 400 | application/json | +| models.RecipientUpdateTemplateRecipientUnauthorizedError | 401 | application/json | +| models.RecipientUpdateTemplateRecipientForbiddenError | 403 | application/json | | models.RecipientUpdateTemplateRecipientInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -235,6 +243,8 @@ with Documenso( | Error Type | Status Code | Content Type | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | models.RecipientUpdateTemplateRecipientsBadRequestError | 400 | application/json | +| models.RecipientUpdateTemplateRecipientsUnauthorizedError | 401 | application/json | +| models.RecipientUpdateTemplateRecipientsForbiddenError | 403 | application/json | | models.RecipientUpdateTemplateRecipientsInternalServerError | 500 | application/json | | models.APIError | 4XX, 5XX | \*/\* | @@ -277,5 +287,7 @@ with Documenso( | Error Type | Status Code | Content Type | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | models.RecipientDeleteTemplateRecipientBadRequestError | 400 | application/json | +| models.RecipientDeleteTemplateRecipientUnauthorizedError | 401 | application/json | +| models.RecipientDeleteTemplateRecipientForbiddenError | 403 | application/json | | models.RecipientDeleteTemplateRecipientInternalServerError | 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..56774de 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" -__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" +__version__: str = "0.4.0" +__openapi_doc_version__: str = "1.0.0" +__gen_version__: str = "2.750.0" +__user_agent__: str = "speakeasy-sdk/python 0.4.0 2.750.0 1.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..a41be3d 100644 --- a/src/documenso_sdk/directlink_sdk.py +++ b/src/documenso_sdk/directlink_sdk.py @@ -25,7 +25,7 @@ def create( Create a direct link for a template :param template_id: - :param direct_recipient_id: The of the recipient in the current template to transform into the primary recipient when the template is used. + :param direct_recipient_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 @@ -82,13 +82,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -104,6 +104,20 @@ def create( raise models.TemplateCreateTemplateDirectLinkBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateDirectLinkUnauthorizedErrorData, http_res + ) + raise models.TemplateCreateTemplateDirectLinkUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateDirectLinkForbiddenErrorData, http_res + ) + raise models.TemplateCreateTemplateDirectLinkForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateCreateTemplateDirectLinkInternalServerErrorData, http_res @@ -135,7 +149,7 @@ async def create_async( Create a direct link for a template :param template_id: - :param direct_recipient_id: The of the recipient in the current template to transform into the primary recipient when the template is used. + :param direct_recipient_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 @@ -192,13 +206,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -214,6 +228,20 @@ async def create_async( raise models.TemplateCreateTemplateDirectLinkBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateDirectLinkUnauthorizedErrorData, http_res + ) + raise models.TemplateCreateTemplateDirectLinkUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateDirectLinkForbiddenErrorData, http_res + ) + raise models.TemplateCreateTemplateDirectLinkForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateCreateTemplateDirectLinkInternalServerErrorData, http_res @@ -299,13 +327,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -321,6 +349,20 @@ def delete( raise models.TemplateDeleteTemplateDirectLinkBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDeleteTemplateDirectLinkUnauthorizedErrorData, http_res + ) + raise models.TemplateDeleteTemplateDirectLinkUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDeleteTemplateDirectLinkForbiddenErrorData, http_res + ) + raise models.TemplateDeleteTemplateDirectLinkForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateDeleteTemplateDirectLinkInternalServerErrorData, http_res @@ -406,13 +448,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -428,6 +470,20 @@ async def delete_async( raise models.TemplateDeleteTemplateDirectLinkBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDeleteTemplateDirectLinkUnauthorizedErrorData, http_res + ) + raise models.TemplateDeleteTemplateDirectLinkUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDeleteTemplateDirectLinkForbiddenErrorData, http_res + ) + raise models.TemplateDeleteTemplateDirectLinkForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateDeleteTemplateDirectLinkInternalServerErrorData, http_res @@ -516,13 +572,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -538,6 +594,20 @@ def toggle( raise models.TemplateToggleTemplateDirectLinkBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateToggleTemplateDirectLinkUnauthorizedErrorData, http_res + ) + raise models.TemplateToggleTemplateDirectLinkUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateToggleTemplateDirectLinkForbiddenErrorData, http_res + ) + raise models.TemplateToggleTemplateDirectLinkForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateToggleTemplateDirectLinkInternalServerErrorData, http_res @@ -626,13 +696,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -648,6 +718,20 @@ async def toggle_async( raise models.TemplateToggleTemplateDirectLinkBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateToggleTemplateDirectLinkUnauthorizedErrorData, http_res + ) + raise models.TemplateToggleTemplateDirectLinkUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateToggleTemplateDirectLinkForbiddenErrorData, http_res + ) + raise models.TemplateToggleTemplateDirectLinkForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateToggleTemplateDirectLinkInternalServerErrorData, http_res diff --git a/src/documenso_sdk/document_sdk.py b/src/documenso_sdk/document_sdk.py new file mode 100644 index 0000000..d522065 --- /dev/null +++ b/src/documenso_sdk/document_sdk.py @@ -0,0 +1,247 @@ +"""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.DocumentDownloadBetaVersion + ] = models.DocumentDownloadBetaVersion.SIGNED, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.DocumentDownloadBetaResponse: + 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.DocumentDownloadBetaRequest( + 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-downloadBeta", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentDownloadBetaResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBetaBadRequestErrorData, http_res + ) + raise models.DocumentDownloadBetaBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBetaUnauthorizedErrorData, http_res + ) + raise models.DocumentDownloadBetaUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBetaForbiddenErrorData, http_res + ) + raise models.DocumentDownloadBetaForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBetaNotFoundErrorData, http_res + ) + raise models.DocumentDownloadBetaNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBetaInternalServerErrorData, http_res + ) + raise models.DocumentDownloadBetaInternalServerError( + 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.DocumentDownloadBetaVersion + ] = models.DocumentDownloadBetaVersion.SIGNED, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.DocumentDownloadBetaResponse: + 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.DocumentDownloadBetaRequest( + 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-downloadBeta", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentDownloadBetaResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBetaBadRequestErrorData, http_res + ) + raise models.DocumentDownloadBetaBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBetaUnauthorizedErrorData, http_res + ) + raise models.DocumentDownloadBetaUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBetaForbiddenErrorData, http_res + ) + raise models.DocumentDownloadBetaForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBetaNotFoundErrorData, http_res + ) + raise models.DocumentDownloadBetaNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadBetaInternalServerErrorData, http_res + ) + raise models.DocumentDownloadBetaInternalServerError( + 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..04dee33 100644 --- a/src/documenso_sdk/documents.py +++ b/src/documenso_sdk/documents.py @@ -4,6 +4,7 @@ from .sdkconfiguration import SDKConfiguration from documenso_sdk import models, utils from documenso_sdk._hooks import HookContext +from documenso_sdk.documents_attachments import DocumentsAttachments from documenso_sdk.documents_fields import DocumentsFields from documenso_sdk.documents_recipients import DocumentsRecipients from documenso_sdk.types import OptionalNullable, UNSET @@ -13,6 +14,7 @@ class Documents(BaseSDK): + attachments: DocumentsAttachments fields: DocumentsFields recipients: DocumentsRecipients @@ -24,6 +26,9 @@ def __init__( self._init_sdks() def _init_sdks(self): + self.attachments = DocumentsAttachments( + self.sdk_configuration, parent_ref=self.parent_ref + ) self.fields = DocumentsFields( self.sdk_configuration, parent_ref=self.parent_ref ) @@ -31,32 +36,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 +65,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 +97,45 @@ 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", "401", "403", "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, "401", "application/json"): response_data = unmarshal_json_response( - models.DocumentUpdateDocumentInternalServerErrorData, http_res + models.DocumentGetUnauthorizedErrorData, http_res ) - raise models.DocumentUpdateDocumentInternalServerError( - response_data, http_res + raise models.DocumentGetUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentGetForbiddenErrorData, http_res + ) + raise models.DocumentGetForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.DocumentGetNotFoundErrorData, 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 +145,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 +174,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 +206,45 @@ 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", "401", "403", "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, "401", "application/json"): response_data = unmarshal_json_response( - models.DocumentUpdateDocumentInternalServerErrorData, http_res + models.DocumentGetUnauthorizedErrorData, http_res ) - raise models.DocumentUpdateDocumentInternalServerError( - response_data, http_res + raise models.DocumentGetUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentGetForbiddenErrorData, http_res + ) + raise models.DocumentGetForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.DocumentGetNotFoundErrorData, 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 +272,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 +301,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,39 +341,45 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "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.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.DocumentFindBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentFindUnauthorizedErrorData, http_res + ) + raise models.DocumentFindUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentFindForbiddenErrorData, http_res ) - raise models.DocumentFindDocumentsBadRequestError(response_data, http_res) + raise models.DocumentFindForbiddenError(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 +407,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 +436,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,39 +476,45 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "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.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.DocumentFindBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentFindUnauthorizedErrorData, http_res + ) + raise models.DocumentFindUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentFindForbiddenErrorData, http_res ) - raise models.DocumentFindDocumentsBadRequestError(response_data, http_res) + raise models.DocumentFindForbiddenError(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 +524,24 @@ async def find_async( raise models.APIError("Unexpected response received", http_res) - def get( + def create( self, *, - document_id: float, - folder_id: Optional[str] = None, + payload: Union[ + models.DocumentCreatePayload, models.DocumentCreatePayloadTypedDict + ], + file: Union[models.DocumentCreateFile, models.DocumentCreateFileTypedDict], 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 + ) -> models.DocumentCreateResponse: + r"""Create document - Returns a document given an ID + Create a document using form data. - :param document_id: - :param folder_id: Filter documents by folder ID + :param payload: + :param file: :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 +557,27 @@ def get( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentGetDocumentWithDetailsByIDRequest( - document_id=document_id, - folder_id=folder_id, + request = models.DocumentCreateRequest( + payload=utils.get_pydantic_model(payload, models.DocumentCreatePayload), + file=utils.get_pydantic_model(file, models.DocumentCreateFile), ) req = self._build_request( - method="GET", - path="/document/{documentId}", + method="POST", + path="/document/create", 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, "multipart", models.DocumentCreateRequest + ), timeout_ms=timeout_ms, ) @@ -591,44 +593,40 @@ def get( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-getDocumentWithDetailsById", - oauth2_scopes=[], + operation_id="document-create", + 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", "401", "403", "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.DocumentCreateResponse, 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 + models.DocumentCreateBadRequestErrorData, http_res ) - if utils.match_response(http_res, "404", "application/json"): + raise models.DocumentCreateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): response_data = unmarshal_json_response( - models.DocumentGetDocumentWithDetailsByIDNotFoundErrorData, http_res + models.DocumentCreateUnauthorizedErrorData, http_res ) - raise models.DocumentGetDocumentWithDetailsByIDNotFoundError( - response_data, http_res + raise models.DocumentCreateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentCreateForbiddenErrorData, http_res ) + raise models.DocumentCreateForbiddenError(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.DocumentCreateInternalServerErrorData, http_res ) + raise models.DocumentCreateInternalServerError(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 +636,24 @@ def get( raise models.APIError("Unexpected response received", http_res) - async def get_async( + async def create_async( self, *, - document_id: float, - folder_id: Optional[str] = None, + payload: Union[ + models.DocumentCreatePayload, models.DocumentCreatePayloadTypedDict + ], + file: Union[models.DocumentCreateFile, models.DocumentCreateFileTypedDict], 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 + ) -> models.DocumentCreateResponse: + r"""Create document - Returns a document given an ID + Create a document using form data. - :param document_id: - :param folder_id: Filter documents by folder ID + :param payload: + :param file: :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 +669,27 @@ async def get_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentGetDocumentWithDetailsByIDRequest( - document_id=document_id, - folder_id=folder_id, + request = models.DocumentCreateRequest( + payload=utils.get_pydantic_model(payload, models.DocumentCreatePayload), + file=utils.get_pydantic_model(file, models.DocumentCreateFile), ) req = self._build_request_async( - method="GET", - path="/document/{documentId}", + method="POST", + path="/document/create", 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, "multipart", models.DocumentCreateRequest + ), timeout_ms=timeout_ms, ) @@ -702,44 +705,40 @@ 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-create", + 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", "401", "403", "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.DocumentCreateResponse, 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 + models.DocumentCreateBadRequestErrorData, http_res ) - if utils.match_response(http_res, "404", "application/json"): + raise models.DocumentCreateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): response_data = unmarshal_json_response( - models.DocumentGetDocumentWithDetailsByIDNotFoundErrorData, http_res + models.DocumentCreateUnauthorizedErrorData, http_res ) - raise models.DocumentGetDocumentWithDetailsByIDNotFoundError( - response_data, http_res + raise models.DocumentCreateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentCreateForbiddenErrorData, http_res ) + raise models.DocumentCreateForbiddenError(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.DocumentCreateInternalServerErrorData, http_res ) + raise models.DocumentCreateInternalServerError(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,54 +748,25 @@ async def get_async( raise models.APIError("Unexpected response received", http_res) - def create_v0( + def update( 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], - ] + document_id: float, + data: Optional[ + Union[models.DocumentUpdateData, models.DocumentUpdateDataTypedDict] ] = None, meta: Optional[ - Union[ - models.DocumentCreateDocumentTemporaryMeta, - models.DocumentCreateDocumentTemporaryMetaTypedDict, - ] + 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.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.DocumentUpdateResponse: + r"""Update 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 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 @@ -813,25 +783,15 @@ 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.DocumentUpdateRequest( + document_id=document_id, + data=utils.get_pydantic_model(data, Optional[models.DocumentUpdateData]), + meta=utils.get_pydantic_model(meta, Optional[models.DocumentUpdateMeta]), ) req = self._build_request( method="POST", - path="/document/create/beta", + path="/document/update", base_url=base_url, url_variables=url_variables, request=request, @@ -843,11 +803,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.DocumentUpdateRequest ), timeout_ms=timeout_ms, ) @@ -864,36 +820,40 @@ def create_v0( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-createDocumentTemporary", - 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", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "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.DocumentCreateDocumentTemporaryResponse, 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.DocumentCreateDocumentTemporaryBadRequestErrorData, http_res + models.DocumentUpdateBadRequestErrorData, http_res ) - raise models.DocumentCreateDocumentTemporaryBadRequestError( - response_data, http_res + raise models.DocumentUpdateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentUpdateUnauthorizedErrorData, http_res ) - if utils.match_response(http_res, "500", "application/json"): + raise models.DocumentUpdateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): response_data = unmarshal_json_response( - models.DocumentCreateDocumentTemporaryInternalServerErrorData, http_res + models.DocumentUpdateForbiddenErrorData, http_res ) - raise models.DocumentCreateDocumentTemporaryInternalServerError( - response_data, http_res + raise models.DocumentUpdateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + 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) @@ -903,54 +863,25 @@ def create_v0( raise models.APIError("Unexpected response received", http_res) - async def create_v0_async( + async def update_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], - ] + document_id: float, + data: Optional[ + Union[models.DocumentUpdateData, models.DocumentUpdateDataTypedDict] ] = None, meta: Optional[ - Union[ - models.DocumentCreateDocumentTemporaryMeta, - models.DocumentCreateDocumentTemporaryMetaTypedDict, - ] + 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.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.DocumentUpdateResponse: + r"""Update 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 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 @@ -967,25 +898,15 @@ 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.DocumentUpdateRequest( + document_id=document_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="POST", - path="/document/create/beta", + path="/document/update", base_url=base_url, url_variables=url_variables, request=request, @@ -997,11 +918,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.DocumentUpdateRequest ), timeout_ms=timeout_ms, ) @@ -1018,36 +935,40 @@ 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-update", + 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", "401", "403", "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.DocumentCreateDocumentTemporaryResponse, 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.DocumentCreateDocumentTemporaryBadRequestErrorData, http_res + models.DocumentUpdateBadRequestErrorData, http_res ) - raise models.DocumentCreateDocumentTemporaryBadRequestError( - response_data, http_res + raise models.DocumentUpdateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentUpdateUnauthorizedErrorData, http_res ) - if utils.match_response(http_res, "500", "application/json"): + raise models.DocumentUpdateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): response_data = unmarshal_json_response( - models.DocumentCreateDocumentTemporaryInternalServerErrorData, http_res + models.DocumentUpdateForbiddenErrorData, http_res ) - raise models.DocumentCreateDocumentTemporaryInternalServerError( - response_data, http_res + raise models.DocumentUpdateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + 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) @@ -1065,7 +986,7 @@ def delete( server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentDeleteDocumentResponse: + ) -> models.DocumentDeleteResponse: r"""Delete document :param document_id: @@ -1084,7 +1005,7 @@ def delete( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentDeleteDocumentRequest( + request = models.DocumentDeleteRequest( document_id=document_id, ) @@ -1102,7 +1023,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.DocumentDeleteRequest ), timeout_ms=timeout_ms, ) @@ -1119,34 +1040,40 @@ def delete( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-deleteDocument", - oauth2_scopes=[], + operation_id="document-delete", + 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", "401", "403", "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.DocumentDeleteDocumentResponse, 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.DocumentDeleteDocumentBadRequestErrorData, http_res + models.DocumentDeleteBadRequestErrorData, http_res ) - raise models.DocumentDeleteDocumentBadRequestError(response_data, http_res) - if utils.match_response(http_res, "500", "application/json"): + raise models.DocumentDeleteBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): response_data = unmarshal_json_response( - models.DocumentDeleteDocumentInternalServerErrorData, http_res + models.DocumentDeleteUnauthorizedErrorData, http_res ) - raise models.DocumentDeleteDocumentInternalServerError( - response_data, http_res + raise models.DocumentDeleteUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDeleteForbiddenErrorData, http_res + ) + raise models.DocumentDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + 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) @@ -1164,7 +1091,7 @@ async def delete_async( server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, - ) -> models.DocumentDeleteDocumentResponse: + ) -> models.DocumentDeleteResponse: r"""Delete document :param document_id: @@ -1183,7 +1110,7 @@ async def delete_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentDeleteDocumentRequest( + request = models.DocumentDeleteRequest( document_id=document_id, ) @@ -1201,7 +1128,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.DocumentDeleteRequest ), timeout_ms=timeout_ms, ) @@ -1218,34 +1145,40 @@ 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-delete", + 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", "401", "403", "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.DocumentDeleteDocumentResponse, 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.DocumentDeleteDocumentBadRequestErrorData, http_res + models.DocumentDeleteBadRequestErrorData, http_res ) - raise models.DocumentDeleteDocumentBadRequestError(response_data, http_res) - if utils.match_response(http_res, "500", "application/json"): + raise models.DocumentDeleteBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): response_data = unmarshal_json_response( - models.DocumentDeleteDocumentInternalServerErrorData, http_res + models.DocumentDeleteUnauthorizedErrorData, http_res ) - raise models.DocumentDeleteDocumentInternalServerError( - response_data, http_res + raise models.DocumentDeleteUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDeleteForbiddenErrorData, http_res + ) + raise models.DocumentDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + 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) @@ -1255,27 +1188,18 @@ async def delete_async( raise models.APIError("Unexpected response received", http_res) - def distribute( + def duplicate( self, *, document_id: float, - meta: Optional[ - Union[ - models.DocumentSendDocumentMeta, - models.DocumentSendDocumentMetaTypedDict, - ] - ] = 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: - r"""Distribute document - - Send the document out to recipients based on your distribution method + ) -> models.DocumentDuplicateResponse: + r"""Duplicate document - :param document_id: The ID of the document to send. - :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 @@ -1291,16 +1215,13 @@ def distribute( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentSendDocumentRequest( + request = models.DocumentDuplicateRequest( document_id=document_id, - meta=utils.get_pydantic_model( - meta, Optional[models.DocumentSendDocumentMeta] - ), ) req = self._build_request( method="POST", - path="/document/distribute", + path="/document/duplicate", base_url=base_url, url_variables=url_variables, request=request, @@ -1312,7 +1233,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.DocumentDuplicateRequest ), timeout_ms=timeout_ms, ) @@ -1329,34 +1250,40 @@ def distribute( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-sendDocument", - oauth2_scopes=[], + operation_id="document-duplicate", + 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", "401", "403", "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.DocumentSendDocumentResponse, 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.DocumentSendDocumentBadRequestErrorData, http_res + models.DocumentDuplicateBadRequestErrorData, http_res ) - raise models.DocumentSendDocumentBadRequestError(response_data, http_res) - if utils.match_response(http_res, "500", "application/json"): + raise models.DocumentDuplicateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): response_data = unmarshal_json_response( - models.DocumentSendDocumentInternalServerErrorData, http_res + models.DocumentDuplicateUnauthorizedErrorData, http_res ) - raise models.DocumentSendDocumentInternalServerError( - response_data, http_res + raise models.DocumentDuplicateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDuplicateForbiddenErrorData, http_res + ) + raise models.DocumentDuplicateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + 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) @@ -1366,27 +1293,18 @@ def distribute( raise models.APIError("Unexpected response received", http_res) - async def distribute_async( + async def duplicate_async( self, *, document_id: float, - meta: Optional[ - Union[ - models.DocumentSendDocumentMeta, - models.DocumentSendDocumentMetaTypedDict, - ] - ] = 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: - r"""Distribute document - - Send the document out to recipients based on your distribution method + ) -> models.DocumentDuplicateResponse: + r"""Duplicate document - :param document_id: The ID of the document to send. - :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 @@ -1402,16 +1320,13 @@ async def distribute_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentSendDocumentRequest( + request = models.DocumentDuplicateRequest( document_id=document_id, - meta=utils.get_pydantic_model( - meta, Optional[models.DocumentSendDocumentMeta] - ), ) req = self._build_request_async( method="POST", - path="/document/distribute", + path="/document/duplicate", base_url=base_url, url_variables=url_variables, request=request, @@ -1423,7 +1338,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.DocumentDuplicateRequest ), timeout_ms=timeout_ms, ) @@ -1440,34 +1355,40 @@ 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-duplicate", + 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", "401", "403", "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.DocumentSendDocumentResponse, 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.DocumentSendDocumentBadRequestErrorData, http_res + models.DocumentDuplicateBadRequestErrorData, http_res ) - raise models.DocumentSendDocumentBadRequestError(response_data, http_res) - if utils.match_response(http_res, "500", "application/json"): + raise models.DocumentDuplicateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): response_data = unmarshal_json_response( - models.DocumentSendDocumentInternalServerErrorData, http_res + models.DocumentDuplicateUnauthorizedErrorData, http_res ) - raise models.DocumentSendDocumentInternalServerError( - response_data, http_res + raise models.DocumentDuplicateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDuplicateForbiddenErrorData, http_res + ) + raise models.DocumentDuplicateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + 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) @@ -1477,22 +1398,24 @@ async def distribute_async( raise models.APIError("Unexpected response received", http_res) - def redistribute( + def distribute( self, *, document_id: float, - recipients: List[float], + meta: Optional[ + 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.DocumentResendDocumentResponse: - r"""Redistribute document + ) -> models.DocumentDistributeResponse: + r"""Distribute document - Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document + Send the document out to recipients based on your distribution method :param document_id: - :param recipients: The IDs of the recipients to redistribute the document to. + :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 @@ -1508,14 +1431,16 @@ def redistribute( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentResendDocumentRequest( + request = models.DocumentDistributeRequest( document_id=document_id, - recipients=recipients, + meta=utils.get_pydantic_model( + meta, Optional[models.DocumentDistributeMeta] + ), ) req = self._build_request( method="POST", - path="/document/redistribute", + path="/document/distribute", base_url=base_url, url_variables=url_variables, request=request, @@ -1527,7 +1452,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.DocumentDistributeRequest ), timeout_ms=timeout_ms, ) @@ -1544,34 +1469,40 @@ def redistribute( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-resendDocument", - oauth2_scopes=[], + operation_id="document-distribute", + 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", "401", "403", "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.DocumentResendDocumentResponse, 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.DocumentResendDocumentBadRequestErrorData, http_res + models.DocumentDistributeBadRequestErrorData, http_res ) - raise models.DocumentResendDocumentBadRequestError(response_data, http_res) - if utils.match_response(http_res, "500", "application/json"): + raise models.DocumentDistributeBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): response_data = unmarshal_json_response( - models.DocumentResendDocumentInternalServerErrorData, http_res + models.DocumentDistributeUnauthorizedErrorData, http_res ) - raise models.DocumentResendDocumentInternalServerError( - response_data, http_res + raise models.DocumentDistributeUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDistributeForbiddenErrorData, http_res ) + raise models.DocumentDistributeForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + 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) @@ -1581,22 +1512,24 @@ def redistribute( raise models.APIError("Unexpected response received", http_res) - async def redistribute_async( + async def distribute_async( self, *, document_id: float, - recipients: List[float], + meta: Optional[ + 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.DocumentResendDocumentResponse: - r"""Redistribute document + ) -> models.DocumentDistributeResponse: + r"""Distribute document - Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document + Send the document out to recipients based on your distribution method :param document_id: - :param recipients: The IDs of the recipients to redistribute the document to. + :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 @@ -1612,14 +1545,16 @@ async def redistribute_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentResendDocumentRequest( + request = models.DocumentDistributeRequest( document_id=document_id, - recipients=recipients, + meta=utils.get_pydantic_model( + meta, Optional[models.DocumentDistributeMeta] + ), ) req = self._build_request_async( method="POST", - path="/document/redistribute", + path="/document/distribute", base_url=base_url, url_variables=url_variables, request=request, @@ -1631,7 +1566,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.DocumentDistributeRequest ), timeout_ms=timeout_ms, ) @@ -1648,34 +1583,40 @@ 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-distribute", + 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", "401", "403", "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.DocumentResendDocumentResponse, 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.DocumentResendDocumentBadRequestErrorData, http_res + models.DocumentDistributeBadRequestErrorData, http_res ) - raise models.DocumentResendDocumentBadRequestError(response_data, http_res) - if utils.match_response(http_res, "500", "application/json"): + raise models.DocumentDistributeBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): response_data = unmarshal_json_response( - models.DocumentResendDocumentInternalServerErrorData, http_res + models.DocumentDistributeUnauthorizedErrorData, http_res ) - raise models.DocumentResendDocumentInternalServerError( - response_data, http_res + raise models.DocumentDistributeUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDistributeForbiddenErrorData, http_res + ) + raise models.DocumentDistributeForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + 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) @@ -1685,18 +1626,22 @@ async def redistribute_async( raise models.APIError("Unexpected response received", http_res) - def duplicate( + def redistribute( self, *, document_id: float, + recipients: List[float], 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.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 :param document_id: + :param recipients: :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 +1657,14 @@ def duplicate( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentDuplicateDocumentRequest( + request = models.DocumentRedistributeRequest( document_id=document_id, + recipients=recipients, ) req = self._build_request( method="POST", - path="/document/duplicate", + path="/document/redistribute", base_url=base_url, url_variables=url_variables, request=request, @@ -1730,7 +1676,7 @@ 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.DocumentRedistributeRequest ), timeout_ms=timeout_ms, ) @@ -1747,34 +1693,42 @@ def duplicate( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", - operation_id="document-duplicateDocument", - oauth2_scopes=[], + operation_id="document-redistribute", + 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", "401", "403", "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.DocumentDuplicateDocumentResponse, http_res + models.DocumentRedistributeResponse, http_res ) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentDuplicateDocumentBadRequestErrorData, http_res + models.DocumentRedistributeBadRequestErrorData, http_res ) - raise models.DocumentDuplicateDocumentBadRequestError( - response_data, http_res + raise models.DocumentRedistributeBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentRedistributeUnauthorizedErrorData, http_res + ) + raise models.DocumentRedistributeUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentRedistributeForbiddenErrorData, http_res ) + raise models.DocumentRedistributeForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentDuplicateDocumentInternalServerErrorData, http_res + models.DocumentRedistributeInternalServerErrorData, http_res ) - raise models.DocumentDuplicateDocumentInternalServerError( + raise models.DocumentRedistributeInternalServerError( response_data, http_res ) if utils.match_response(http_res, "4XX", "*"): @@ -1786,18 +1740,22 @@ def duplicate( raise models.APIError("Unexpected response received", http_res) - async def duplicate_async( + async def redistribute_async( self, *, document_id: float, + recipients: List[float], 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.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 :param document_id: + :param recipients: :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 +1771,14 @@ async def duplicate_async( else: base_url = self._get_url(base_url, url_variables) - request = models.DocumentDuplicateDocumentRequest( + request = models.DocumentRedistributeRequest( document_id=document_id, + recipients=recipients, ) req = self._build_request_async( method="POST", - path="/document/duplicate", + path="/document/redistribute", base_url=base_url, url_variables=url_variables, request=request, @@ -1831,7 +1790,7 @@ 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.DocumentRedistributeRequest ), timeout_ms=timeout_ms, ) @@ -1848,34 +1807,642 @@ 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-redistribute", + 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", "401", "403", "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.DocumentDuplicateDocumentResponse, http_res + models.DocumentRedistributeResponse, http_res ) if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( - models.DocumentDuplicateDocumentBadRequestErrorData, http_res + models.DocumentRedistributeBadRequestErrorData, http_res ) - raise models.DocumentDuplicateDocumentBadRequestError( - response_data, http_res + raise models.DocumentRedistributeBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentRedistributeUnauthorizedErrorData, http_res + ) + raise models.DocumentRedistributeUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentRedistributeForbiddenErrorData, http_res ) + raise models.DocumentRedistributeForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( - models.DocumentDuplicateDocumentInternalServerErrorData, http_res + models.DocumentRedistributeInternalServerErrorData, http_res ) - raise models.DocumentDuplicateDocumentInternalServerError( + raise models.DocumentRedistributeInternalServerError( + 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) + + def download( + self, + *, + document_id: float, + version: Optional[ + models.DocumentDownloadVersion + ] = models.DocumentDownloadVersion.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 + + :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", + 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", "401", "403", "404", "4XX", "500", "5XX"], + retry_config=retry_config, + ) + + response_data: Any = None + if utils.match_response(http_res, "200", "application/json"): + return models.DocumentDownloadResponse( + result=unmarshal_json_response(Any, http_res), + headers=utils.get_response_headers(http_res.headers), + ) + 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, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadUnauthorizedErrorData, http_res + ) + raise models.DocumentDownloadUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadForbiddenErrorData, http_res + ) + raise models.DocumentDownloadForbiddenError(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 download_async( + self, + *, + document_id: float, + version: Optional[ + models.DocumentDownloadVersion + ] = models.DocumentDownloadVersion.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 + + :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", + 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", "401", "403", "404", "4XX", "500", "5XX"], + retry_config=retry_config, + ) + + response_data: Any = None + if utils.match_response(http_res, "200", "application/json"): + return models.DocumentDownloadResponse( + result=unmarshal_json_response(Any, http_res), + headers=utils.get_response_headers(http_res.headers), + ) + 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, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadUnauthorizedErrorData, http_res + ) + raise models.DocumentDownloadUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentDownloadForbiddenErrorData, http_res + ) + raise models.DocumentDownloadForbiddenError(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) + + def create_v0( + 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.DocumentCreateDocumentTemporaryFormValuesRequest], + Dict[ + str, + models.DocumentCreateDocumentTemporaryFormValuesRequestTypedDict, + ], + ] + ] = None, + folder_id: Optional[str] = None, + recipients: Optional[ + Union[ + List[models.DocumentCreateDocumentTemporaryRecipientRequest], + List[models.DocumentCreateDocumentTemporaryRecipientRequestTypedDict], + ] + ] = None, + attachments: Optional[ + Union[ + List[models.DocumentCreateDocumentTemporaryAttachment], + List[models.DocumentCreateDocumentTemporaryAttachmentTypedDict], + ] + ] = 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.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. + + :param title: + :param external_id: + :param visibility: + :param global_access_auth: + :param global_action_auth: + :param form_values: + :param folder_id: + :param recipients: + :param attachments: + :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.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]], + ), + attachments=utils.get_pydantic_model( + attachments, + Optional[List[models.DocumentCreateDocumentTemporaryAttachment]], + ), + meta=utils.get_pydantic_model( + meta, Optional[models.DocumentCreateDocumentTemporaryMeta] + ), + ) + + req = self._build_request( + method="POST", + path="/document/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.DocumentCreateDocumentTemporaryRequest, + ), + 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-createDocumentTemporary", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentCreateDocumentTemporaryResponse, 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 + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentCreateDocumentTemporaryUnauthorizedErrorData, http_res + ) + raise models.DocumentCreateDocumentTemporaryUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentCreateDocumentTemporaryForbiddenErrorData, http_res + ) + raise models.DocumentCreateDocumentTemporaryForbiddenError( + 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 + ) + 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 create_v0_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.DocumentCreateDocumentTemporaryFormValuesRequest], + Dict[ + str, + models.DocumentCreateDocumentTemporaryFormValuesRequestTypedDict, + ], + ] + ] = None, + folder_id: Optional[str] = None, + recipients: Optional[ + Union[ + List[models.DocumentCreateDocumentTemporaryRecipientRequest], + List[models.DocumentCreateDocumentTemporaryRecipientRequestTypedDict], + ] + ] = None, + attachments: Optional[ + Union[ + List[models.DocumentCreateDocumentTemporaryAttachment], + List[models.DocumentCreateDocumentTemporaryAttachmentTypedDict], + ] + ] = 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.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. + + :param title: + :param external_id: + :param visibility: + :param global_access_auth: + :param global_action_auth: + :param form_values: + :param folder_id: + :param recipients: + :param attachments: + :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.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]], + ), + attachments=utils.get_pydantic_model( + attachments, + Optional[List[models.DocumentCreateDocumentTemporaryAttachment]], + ), + meta=utils.get_pydantic_model( + meta, Optional[models.DocumentCreateDocumentTemporaryMeta] + ), + ) + + req = self._build_request_async( + method="POST", + path="/document/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.DocumentCreateDocumentTemporaryRequest, + ), + 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-createDocumentTemporary", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentCreateDocumentTemporaryResponse, 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 + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentCreateDocumentTemporaryUnauthorizedErrorData, http_res + ) + raise models.DocumentCreateDocumentTemporaryUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentCreateDocumentTemporaryForbiddenErrorData, http_res + ) + raise models.DocumentCreateDocumentTemporaryForbiddenError( + 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 ) if utils.match_response(http_res, "4XX", "*"): diff --git a/src/documenso_sdk/documents_attachments.py b/src/documenso_sdk/documents_attachments.py new file mode 100644 index 0000000..b036c2b --- /dev/null +++ b/src/documenso_sdk/documents_attachments.py @@ -0,0 +1,955 @@ +"""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, Union + + +class DocumentsAttachments(BaseSDK): + def create( + self, + *, + document_id: float, + data: Union[ + models.DocumentAttachmentCreateData, + models.DocumentAttachmentCreateDataTypedDict, + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.DocumentAttachmentCreateResponse: + r"""Create attachment + + Create a new attachment for a document + + :param document_id: + :param data: + :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.DocumentAttachmentCreateRequest( + document_id=document_id, + data=utils.get_pydantic_model(data, models.DocumentAttachmentCreateData), + ) + + req = self._build_request( + method="POST", + path="/document/attachment/create", + 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.DocumentAttachmentCreateRequest + ), + 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-attachment-create", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentAttachmentCreateResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentCreateBadRequestErrorData, http_res + ) + raise models.DocumentAttachmentCreateBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentCreateUnauthorizedErrorData, http_res + ) + raise models.DocumentAttachmentCreateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentCreateForbiddenErrorData, http_res + ) + raise models.DocumentAttachmentCreateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentCreateInternalServerErrorData, http_res + ) + raise models.DocumentAttachmentCreateInternalServerError( + 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 create_async( + self, + *, + document_id: float, + data: Union[ + models.DocumentAttachmentCreateData, + models.DocumentAttachmentCreateDataTypedDict, + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.DocumentAttachmentCreateResponse: + r"""Create attachment + + Create a new attachment for a document + + :param document_id: + :param data: + :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.DocumentAttachmentCreateRequest( + document_id=document_id, + data=utils.get_pydantic_model(data, models.DocumentAttachmentCreateData), + ) + + req = self._build_request_async( + method="POST", + path="/document/attachment/create", + 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.DocumentAttachmentCreateRequest + ), + 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-attachment-create", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentAttachmentCreateResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentCreateBadRequestErrorData, http_res + ) + raise models.DocumentAttachmentCreateBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentCreateUnauthorizedErrorData, http_res + ) + raise models.DocumentAttachmentCreateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentCreateForbiddenErrorData, http_res + ) + raise models.DocumentAttachmentCreateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentCreateInternalServerErrorData, http_res + ) + raise models.DocumentAttachmentCreateInternalServerError( + 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) + + def update( + self, + *, + id: str, + data: Union[ + models.DocumentAttachmentUpdateData, + models.DocumentAttachmentUpdateDataTypedDict, + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.DocumentAttachmentUpdateResponse: + r"""Update attachment + + Update an existing attachment + + :param id: + :param data: + :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.DocumentAttachmentUpdateRequest( + id=id, + data=utils.get_pydantic_model(data, models.DocumentAttachmentUpdateData), + ) + + req = self._build_request( + method="POST", + path="/document/attachment/update", + 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.DocumentAttachmentUpdateRequest + ), + 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-attachment-update", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentAttachmentUpdateResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentUpdateBadRequestErrorData, http_res + ) + raise models.DocumentAttachmentUpdateBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentUpdateUnauthorizedErrorData, http_res + ) + raise models.DocumentAttachmentUpdateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentUpdateForbiddenErrorData, http_res + ) + raise models.DocumentAttachmentUpdateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentUpdateInternalServerErrorData, http_res + ) + raise models.DocumentAttachmentUpdateInternalServerError( + 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 update_async( + self, + *, + id: str, + data: Union[ + models.DocumentAttachmentUpdateData, + models.DocumentAttachmentUpdateDataTypedDict, + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.DocumentAttachmentUpdateResponse: + r"""Update attachment + + Update an existing attachment + + :param id: + :param data: + :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.DocumentAttachmentUpdateRequest( + id=id, + data=utils.get_pydantic_model(data, models.DocumentAttachmentUpdateData), + ) + + req = self._build_request_async( + method="POST", + path="/document/attachment/update", + 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.DocumentAttachmentUpdateRequest + ), + 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-attachment-update", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentAttachmentUpdateResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentUpdateBadRequestErrorData, http_res + ) + raise models.DocumentAttachmentUpdateBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentUpdateUnauthorizedErrorData, http_res + ) + raise models.DocumentAttachmentUpdateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentUpdateForbiddenErrorData, http_res + ) + raise models.DocumentAttachmentUpdateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentUpdateInternalServerErrorData, http_res + ) + raise models.DocumentAttachmentUpdateInternalServerError( + 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) + + def delete( + self, + *, + id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.DocumentAttachmentDeleteResponse: + r"""Delete attachment + + Delete an attachment from a document + + :param 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 + :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.DocumentAttachmentDeleteRequest( + id=id, + ) + + req = self._build_request( + method="POST", + path="/document/attachment/delete", + 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.DocumentAttachmentDeleteRequest + ), + 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-attachment-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentAttachmentDeleteResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentDeleteBadRequestErrorData, http_res + ) + raise models.DocumentAttachmentDeleteBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentDeleteUnauthorizedErrorData, http_res + ) + raise models.DocumentAttachmentDeleteUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentDeleteForbiddenErrorData, http_res + ) + raise models.DocumentAttachmentDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentDeleteInternalServerErrorData, http_res + ) + raise models.DocumentAttachmentDeleteInternalServerError( + 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 delete_async( + self, + *, + id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.DocumentAttachmentDeleteResponse: + r"""Delete attachment + + Delete an attachment from a document + + :param 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 + :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.DocumentAttachmentDeleteRequest( + id=id, + ) + + req = self._build_request_async( + method="POST", + path="/document/attachment/delete", + 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.DocumentAttachmentDeleteRequest + ), + 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-attachment-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentAttachmentDeleteResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentDeleteBadRequestErrorData, http_res + ) + raise models.DocumentAttachmentDeleteBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentDeleteUnauthorizedErrorData, http_res + ) + raise models.DocumentAttachmentDeleteUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentDeleteForbiddenErrorData, http_res + ) + raise models.DocumentAttachmentDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentDeleteInternalServerErrorData, http_res + ) + raise models.DocumentAttachmentDeleteInternalServerError( + 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) + + def find( + self, + *, + 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.DocumentAttachmentFindResponse: + r"""Find attachments + + Find all attachments for a document + + :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 + :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.DocumentAttachmentFindRequest( + document_id=document_id, + ) + + req = self._build_request( + method="GET", + path="/document/attachment", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=False, + 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, + 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-attachment-find", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentAttachmentFindResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentFindBadRequestErrorData, http_res + ) + raise models.DocumentAttachmentFindBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentFindUnauthorizedErrorData, http_res + ) + raise models.DocumentAttachmentFindUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentFindForbiddenErrorData, http_res + ) + raise models.DocumentAttachmentFindForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentFindNotFoundErrorData, http_res + ) + raise models.DocumentAttachmentFindNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentFindInternalServerErrorData, http_res + ) + raise models.DocumentAttachmentFindInternalServerError( + 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 find_async( + self, + *, + 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.DocumentAttachmentFindResponse: + r"""Find attachments + + Find all attachments for a document + + :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 + :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.DocumentAttachmentFindRequest( + document_id=document_id, + ) + + req = self._build_request_async( + method="GET", + path="/document/attachment", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=False, + 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, + 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-attachment-find", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.DocumentAttachmentFindResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentFindBadRequestErrorData, http_res + ) + raise models.DocumentAttachmentFindBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentFindUnauthorizedErrorData, http_res + ) + raise models.DocumentAttachmentFindUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentFindForbiddenErrorData, http_res + ) + raise models.DocumentAttachmentFindForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentFindNotFoundErrorData, http_res + ) + raise models.DocumentAttachmentFindNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.DocumentAttachmentFindInternalServerErrorData, http_res + ) + raise models.DocumentAttachmentFindInternalServerError( + 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_fields.py b/src/documenso_sdk/documents_fields.py index cdf2fb7..dd0b90d 100644 --- a/src/documenso_sdk/documents_fields.py +++ b/src/documenso_sdk/documents_fields.py @@ -72,13 +72,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -92,6 +92,16 @@ def get( models.FieldGetDocumentFieldBadRequestErrorData, http_res ) raise models.FieldGetDocumentFieldBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldGetDocumentFieldUnauthorizedErrorData, http_res + ) + raise models.FieldGetDocumentFieldUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldGetDocumentFieldForbiddenErrorData, http_res + ) + raise models.FieldGetDocumentFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.FieldGetDocumentFieldNotFoundErrorData, http_res @@ -175,13 +185,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -195,6 +205,16 @@ async def get_async( models.FieldGetDocumentFieldBadRequestErrorData, http_res ) raise models.FieldGetDocumentFieldBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldGetDocumentFieldUnauthorizedErrorData, http_res + ) + raise models.FieldGetDocumentFieldUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldGetDocumentFieldForbiddenErrorData, http_res + ) + raise models.FieldGetDocumentFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.FieldGetDocumentFieldNotFoundErrorData, http_res @@ -289,13 +309,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -311,6 +331,18 @@ def create( raise models.FieldCreateDocumentFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateDocumentFieldUnauthorizedErrorData, http_res + ) + raise models.FieldCreateDocumentFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateDocumentFieldForbiddenErrorData, http_res + ) + raise models.FieldCreateDocumentFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldCreateDocumentFieldInternalServerErrorData, http_res @@ -400,13 +432,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -422,6 +454,18 @@ async def create_async( raise models.FieldCreateDocumentFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateDocumentFieldUnauthorizedErrorData, http_res + ) + raise models.FieldCreateDocumentFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateDocumentFieldForbiddenErrorData, http_res + ) + raise models.FieldCreateDocumentFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldCreateDocumentFieldInternalServerErrorData, http_res @@ -511,13 +555,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -533,6 +577,20 @@ def create_many( raise models.FieldCreateDocumentFieldsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateDocumentFieldsUnauthorizedErrorData, http_res + ) + raise models.FieldCreateDocumentFieldsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateDocumentFieldsForbiddenErrorData, http_res + ) + raise models.FieldCreateDocumentFieldsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldCreateDocumentFieldsInternalServerErrorData, http_res @@ -622,13 +680,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -644,6 +702,20 @@ async def create_many_async( raise models.FieldCreateDocumentFieldsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateDocumentFieldsUnauthorizedErrorData, http_res + ) + raise models.FieldCreateDocumentFieldsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateDocumentFieldsForbiddenErrorData, http_res + ) + raise models.FieldCreateDocumentFieldsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldCreateDocumentFieldsInternalServerErrorData, http_res @@ -733,13 +805,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -755,6 +827,18 @@ def update( raise models.FieldUpdateDocumentFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateDocumentFieldUnauthorizedErrorData, http_res + ) + raise models.FieldUpdateDocumentFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateDocumentFieldForbiddenErrorData, http_res + ) + raise models.FieldUpdateDocumentFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldUpdateDocumentFieldInternalServerErrorData, http_res @@ -844,13 +928,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -866,6 +950,18 @@ async def update_async( raise models.FieldUpdateDocumentFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateDocumentFieldUnauthorizedErrorData, http_res + ) + raise models.FieldUpdateDocumentFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateDocumentFieldForbiddenErrorData, http_res + ) + raise models.FieldUpdateDocumentFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldUpdateDocumentFieldInternalServerErrorData, http_res @@ -955,13 +1051,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -977,6 +1073,20 @@ def update_many( raise models.FieldUpdateDocumentFieldsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateDocumentFieldsUnauthorizedErrorData, http_res + ) + raise models.FieldUpdateDocumentFieldsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateDocumentFieldsForbiddenErrorData, http_res + ) + raise models.FieldUpdateDocumentFieldsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldUpdateDocumentFieldsInternalServerErrorData, http_res @@ -1066,13 +1176,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1088,6 +1198,20 @@ async def update_many_async( raise models.FieldUpdateDocumentFieldsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateDocumentFieldsUnauthorizedErrorData, http_res + ) + raise models.FieldUpdateDocumentFieldsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateDocumentFieldsForbiddenErrorData, http_res + ) + raise models.FieldUpdateDocumentFieldsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldUpdateDocumentFieldsInternalServerErrorData, http_res @@ -1167,13 +1291,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1189,6 +1313,18 @@ def delete( raise models.FieldDeleteDocumentFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldDeleteDocumentFieldUnauthorizedErrorData, http_res + ) + raise models.FieldDeleteDocumentFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldDeleteDocumentFieldForbiddenErrorData, http_res + ) + raise models.FieldDeleteDocumentFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldDeleteDocumentFieldInternalServerErrorData, http_res @@ -1268,13 +1404,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1290,6 +1426,18 @@ async def delete_async( raise models.FieldDeleteDocumentFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldDeleteDocumentFieldUnauthorizedErrorData, http_res + ) + raise models.FieldDeleteDocumentFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldDeleteDocumentFieldForbiddenErrorData, http_res + ) + raise models.FieldDeleteDocumentFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldDeleteDocumentFieldInternalServerErrorData, http_res diff --git a/src/documenso_sdk/documents_recipients.py b/src/documenso_sdk/documents_recipients.py index 98ccc29..1f45c15 100644 --- a/src/documenso_sdk/documents_recipients.py +++ b/src/documenso_sdk/documents_recipients.py @@ -72,13 +72,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -94,6 +94,20 @@ def get( raise models.RecipientGetDocumentRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientGetDocumentRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientGetDocumentRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientGetDocumentRecipientForbiddenErrorData, http_res + ) + raise models.RecipientGetDocumentRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.RecipientGetDocumentRecipientNotFoundErrorData, http_res @@ -179,13 +193,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -201,6 +215,20 @@ async def get_async( raise models.RecipientGetDocumentRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientGetDocumentRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientGetDocumentRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientGetDocumentRecipientForbiddenErrorData, http_res + ) + raise models.RecipientGetDocumentRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.RecipientGetDocumentRecipientNotFoundErrorData, http_res @@ -301,13 +329,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -323,6 +351,20 @@ def create( raise models.RecipientCreateDocumentRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateDocumentRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientCreateDocumentRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateDocumentRecipientForbiddenErrorData, http_res + ) + raise models.RecipientCreateDocumentRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientCreateDocumentRecipientInternalServerErrorData, http_res @@ -416,13 +458,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -438,6 +480,20 @@ async def create_async( raise models.RecipientCreateDocumentRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateDocumentRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientCreateDocumentRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateDocumentRecipientForbiddenErrorData, http_res + ) + raise models.RecipientCreateDocumentRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientCreateDocumentRecipientInternalServerErrorData, http_res @@ -532,13 +588,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -554,6 +610,20 @@ def create_many( raise models.RecipientCreateDocumentRecipientsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateDocumentRecipientsUnauthorizedErrorData, http_res + ) + raise models.RecipientCreateDocumentRecipientsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateDocumentRecipientsForbiddenErrorData, http_res + ) + raise models.RecipientCreateDocumentRecipientsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientCreateDocumentRecipientsInternalServerErrorData, @@ -649,13 +719,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -671,6 +741,20 @@ async def create_many_async( raise models.RecipientCreateDocumentRecipientsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateDocumentRecipientsUnauthorizedErrorData, http_res + ) + raise models.RecipientCreateDocumentRecipientsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateDocumentRecipientsForbiddenErrorData, http_res + ) + raise models.RecipientCreateDocumentRecipientsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientCreateDocumentRecipientsInternalServerErrorData, @@ -765,13 +849,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -787,6 +871,20 @@ def update( raise models.RecipientUpdateDocumentRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateDocumentRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientUpdateDocumentRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateDocumentRecipientForbiddenErrorData, http_res + ) + raise models.RecipientUpdateDocumentRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientUpdateDocumentRecipientInternalServerErrorData, http_res @@ -880,13 +978,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -902,6 +1000,20 @@ async def update_async( raise models.RecipientUpdateDocumentRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateDocumentRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientUpdateDocumentRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateDocumentRecipientForbiddenErrorData, http_res + ) + raise models.RecipientUpdateDocumentRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientUpdateDocumentRecipientInternalServerErrorData, http_res @@ -996,13 +1108,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1018,6 +1130,20 @@ def update_many( raise models.RecipientUpdateDocumentRecipientsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateDocumentRecipientsUnauthorizedErrorData, http_res + ) + raise models.RecipientUpdateDocumentRecipientsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateDocumentRecipientsForbiddenErrorData, http_res + ) + raise models.RecipientUpdateDocumentRecipientsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientUpdateDocumentRecipientsInternalServerErrorData, @@ -1113,13 +1239,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1135,6 +1261,20 @@ async def update_many_async( raise models.RecipientUpdateDocumentRecipientsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateDocumentRecipientsUnauthorizedErrorData, http_res + ) + raise models.RecipientUpdateDocumentRecipientsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateDocumentRecipientsForbiddenErrorData, http_res + ) + raise models.RecipientUpdateDocumentRecipientsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientUpdateDocumentRecipientsInternalServerErrorData, @@ -1219,13 +1359,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1241,6 +1381,20 @@ def delete( raise models.RecipientDeleteDocumentRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientDeleteDocumentRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientDeleteDocumentRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientDeleteDocumentRecipientForbiddenErrorData, http_res + ) + raise models.RecipientDeleteDocumentRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientDeleteDocumentRecipientInternalServerErrorData, http_res @@ -1324,13 +1478,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1346,6 +1500,20 @@ async def delete_async( raise models.RecipientDeleteDocumentRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientDeleteDocumentRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientDeleteDocumentRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientDeleteDocumentRecipientForbiddenErrorData, http_res + ) + raise models.RecipientDeleteDocumentRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientDeleteDocumentRecipientInternalServerErrorData, http_res diff --git a/src/documenso_sdk/embedding.py b/src/documenso_sdk/embedding.py index 2e65876..7e769cf 100644 --- a/src/documenso_sdk/embedding.py +++ b/src/documenso_sdk/embedding.py @@ -23,7 +23,7 @@ def embedding_presign_create_embedding_presign_token( Creates a presign token for embedding operations with configurable expiration time - :param expires_in: Expiration time in minutes (default: 60, max: 10,080) + :param expires_in: :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 @@ -79,13 +79,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -102,6 +102,22 @@ def embedding_presign_create_embedding_presign_token( raise models.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedErrorData, + http_res, + ) + raise models.EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EmbeddingPresignCreateEmbeddingPresignTokenForbiddenErrorData, + http_res, + ) + raise models.EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData, @@ -132,7 +148,7 @@ async def embedding_presign_create_embedding_presign_token_async( Creates a presign token for embedding operations with configurable expiration time - :param expires_in: Expiration time in minutes (default: 60, max: 10,080) + :param expires_in: :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 @@ -188,13 +204,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -211,6 +227,22 @@ async def embedding_presign_create_embedding_presign_token_async( raise models.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedErrorData, + http_res, + ) + raise models.EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EmbeddingPresignCreateEmbeddingPresignTokenForbiddenErrorData, + http_res, + ) + raise models.EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData, @@ -241,7 +273,7 @@ def embedding_presign_verify_embedding_presign_token( Verifies a presign token for embedding operations and returns the associated API token - :param token: The presign token to verify + :param token: :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 @@ -297,13 +329,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -320,6 +352,22 @@ def embedding_presign_verify_embedding_presign_token( raise models.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedErrorData, + http_res, + ) + raise models.EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenErrorData, + http_res, + ) + raise models.EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData, @@ -350,7 +398,7 @@ async def embedding_presign_verify_embedding_presign_token_async( Verifies a presign token for embedding operations and returns the associated API token - :param token: The presign token to verify + :param token: :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 @@ -406,13 +454,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -429,6 +477,22 @@ async def embedding_presign_verify_embedding_presign_token_async( raise models.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedErrorData, + http_res, + ) + raise models.EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenErrorData, + http_res, + ) + raise models.EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData, diff --git a/src/documenso_sdk/envelopes.py b/src/documenso_sdk/envelopes.py new file mode 100644 index 0000000..84d70c7 --- /dev/null +++ b/src/documenso_sdk/envelopes.py @@ -0,0 +1,1834 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from .basesdk import BaseSDK +from .sdkconfiguration import SDKConfiguration +from documenso_sdk import models, utils +from documenso_sdk._hooks import HookContext +from documenso_sdk.envelopes_attachments import EnvelopesAttachments +from documenso_sdk.envelopes_fields import EnvelopesFields +from documenso_sdk.envelopes_recipients import EnvelopesRecipients +from documenso_sdk.items import Items +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 Envelopes(BaseSDK): + attachments: EnvelopesAttachments + items: Items + recipients: EnvelopesRecipients + fields: EnvelopesFields + + def __init__( + self, sdk_config: SDKConfiguration, parent_ref: Optional[object] = None + ) -> None: + BaseSDK.__init__(self, sdk_config, parent_ref=parent_ref) + self.sdk_configuration = sdk_config + self._init_sdks() + + def _init_sdks(self): + self.attachments = EnvelopesAttachments( + self.sdk_configuration, parent_ref=self.parent_ref + ) + self.items = Items(self.sdk_configuration, parent_ref=self.parent_ref) + self.recipients = EnvelopesRecipients( + self.sdk_configuration, parent_ref=self.parent_ref + ) + self.fields = EnvelopesFields( + self.sdk_configuration, parent_ref=self.parent_ref + ) + + def get( + self, + *, + envelope_id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeGetResponse: + r"""Get envelope + + Returns an envelope given an ID + + :param envelope_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 + :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.EnvelopeGetRequest( + envelope_id=envelope_id, + ) + + req = self._build_request( + method="GET", + path="/envelope/{envelopeId}", + 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="envelope-get", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeGetResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeGetBadRequestErrorData, http_res + ) + raise models.EnvelopeGetBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeGetUnauthorizedErrorData, http_res + ) + raise models.EnvelopeGetUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeGetForbiddenErrorData, http_res + ) + raise models.EnvelopeGetForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeGetNotFoundErrorData, http_res + ) + raise models.EnvelopeGetNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeGetInternalServerErrorData, http_res + ) + raise models.EnvelopeGetInternalServerError(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 get_async( + self, + *, + envelope_id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeGetResponse: + r"""Get envelope + + Returns an envelope given an ID + + :param envelope_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 + :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.EnvelopeGetRequest( + envelope_id=envelope_id, + ) + + req = self._build_request_async( + method="GET", + path="/envelope/{envelopeId}", + 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="envelope-get", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeGetResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeGetBadRequestErrorData, http_res + ) + raise models.EnvelopeGetBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeGetUnauthorizedErrorData, http_res + ) + raise models.EnvelopeGetUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeGetForbiddenErrorData, http_res + ) + raise models.EnvelopeGetForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeGetNotFoundErrorData, http_res + ) + raise models.EnvelopeGetNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeGetInternalServerErrorData, http_res + ) + raise models.EnvelopeGetInternalServerError(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) + + def create( + self, + *, + payload: Union[ + models.EnvelopeCreatePayload, models.EnvelopeCreatePayloadTypedDict + ], + files: Optional[ + Union[ + List[models.EnvelopeCreateFile], + List[models.EnvelopeCreateFileTypedDict], + ] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeCreateResponse: + r"""Create envelope + + Create an envelope using form data. + + :param payload: + :param files: + :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.EnvelopeCreateRequest( + payload=utils.get_pydantic_model(payload, models.EnvelopeCreatePayload), + files=utils.get_pydantic_model( + files, Optional[List[models.EnvelopeCreateFile]] + ), + ) + + req = self._build_request( + method="POST", + path="/envelope/create", + 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, "multipart", models.EnvelopeCreateRequest + ), + 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="envelope-create", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeCreateResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeCreateBadRequestErrorData, http_res + ) + raise models.EnvelopeCreateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeCreateUnauthorizedErrorData, http_res + ) + raise models.EnvelopeCreateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeCreateForbiddenErrorData, http_res + ) + raise models.EnvelopeCreateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeCreateInternalServerErrorData, http_res + ) + raise models.EnvelopeCreateInternalServerError(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 create_async( + self, + *, + payload: Union[ + models.EnvelopeCreatePayload, models.EnvelopeCreatePayloadTypedDict + ], + files: Optional[ + Union[ + List[models.EnvelopeCreateFile], + List[models.EnvelopeCreateFileTypedDict], + ] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeCreateResponse: + r"""Create envelope + + Create an envelope using form data. + + :param payload: + :param files: + :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.EnvelopeCreateRequest( + payload=utils.get_pydantic_model(payload, models.EnvelopeCreatePayload), + files=utils.get_pydantic_model( + files, Optional[List[models.EnvelopeCreateFile]] + ), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/create", + 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, "multipart", models.EnvelopeCreateRequest + ), + 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="envelope-create", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeCreateResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeCreateBadRequestErrorData, http_res + ) + raise models.EnvelopeCreateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeCreateUnauthorizedErrorData, http_res + ) + raise models.EnvelopeCreateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeCreateForbiddenErrorData, http_res + ) + raise models.EnvelopeCreateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeCreateInternalServerErrorData, http_res + ) + raise models.EnvelopeCreateInternalServerError(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) + + def use( + self, + *, + payload: Union[models.EnvelopeUsePayload, models.EnvelopeUsePayloadTypedDict], + files: Optional[ + Union[List[models.EnvelopeUseFile], List[models.EnvelopeUseFileTypedDict]] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeUseResponse: + r"""Use envelope + + Create a document envelope from a template envelope. Upload custom files to replace the template PDFs and map them to specific envelope items using identifiers. + + :param payload: + :param files: + :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.EnvelopeUseRequest( + payload=utils.get_pydantic_model(payload, models.EnvelopeUsePayload), + files=utils.get_pydantic_model( + files, Optional[List[models.EnvelopeUseFile]] + ), + ) + + req = self._build_request( + method="POST", + path="/envelope/use", + 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, "multipart", models.EnvelopeUseRequest + ), + 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="envelope-use", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeUseResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUseBadRequestErrorData, http_res + ) + raise models.EnvelopeUseBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUseUnauthorizedErrorData, http_res + ) + raise models.EnvelopeUseUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUseForbiddenErrorData, http_res + ) + raise models.EnvelopeUseForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUseInternalServerErrorData, http_res + ) + raise models.EnvelopeUseInternalServerError(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 use_async( + self, + *, + payload: Union[models.EnvelopeUsePayload, models.EnvelopeUsePayloadTypedDict], + files: Optional[ + Union[List[models.EnvelopeUseFile], List[models.EnvelopeUseFileTypedDict]] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeUseResponse: + r"""Use envelope + + Create a document envelope from a template envelope. Upload custom files to replace the template PDFs and map them to specific envelope items using identifiers. + + :param payload: + :param files: + :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.EnvelopeUseRequest( + payload=utils.get_pydantic_model(payload, models.EnvelopeUsePayload), + files=utils.get_pydantic_model( + files, Optional[List[models.EnvelopeUseFile]] + ), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/use", + 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, "multipart", models.EnvelopeUseRequest + ), + 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="envelope-use", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeUseResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUseBadRequestErrorData, http_res + ) + raise models.EnvelopeUseBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUseUnauthorizedErrorData, http_res + ) + raise models.EnvelopeUseUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUseForbiddenErrorData, http_res + ) + raise models.EnvelopeUseForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUseInternalServerErrorData, http_res + ) + raise models.EnvelopeUseInternalServerError(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) + + def update( + self, + *, + envelope_id: str, + data: Optional[ + Union[models.EnvelopeUpdateData, models.EnvelopeUpdateDataTypedDict] + ] = None, + meta: Optional[ + Union[models.EnvelopeUpdateMeta, models.EnvelopeUpdateMetaTypedDict] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeUpdateResponse: + r"""Update envelope + + :param envelope_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 + :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.EnvelopeUpdateRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model(data, Optional[models.EnvelopeUpdateData]), + meta=utils.get_pydantic_model(meta, Optional[models.EnvelopeUpdateMeta]), + ) + + req = self._build_request( + method="POST", + path="/envelope/update", + 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.EnvelopeUpdateRequest + ), + 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="envelope-update", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeUpdateResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUpdateBadRequestErrorData, http_res + ) + raise models.EnvelopeUpdateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUpdateUnauthorizedErrorData, http_res + ) + raise models.EnvelopeUpdateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUpdateForbiddenErrorData, http_res + ) + raise models.EnvelopeUpdateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUpdateInternalServerErrorData, http_res + ) + raise models.EnvelopeUpdateInternalServerError(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 update_async( + self, + *, + envelope_id: str, + data: Optional[ + Union[models.EnvelopeUpdateData, models.EnvelopeUpdateDataTypedDict] + ] = None, + meta: Optional[ + Union[models.EnvelopeUpdateMeta, models.EnvelopeUpdateMetaTypedDict] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeUpdateResponse: + r"""Update envelope + + :param envelope_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 + :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.EnvelopeUpdateRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model(data, Optional[models.EnvelopeUpdateData]), + meta=utils.get_pydantic_model(meta, Optional[models.EnvelopeUpdateMeta]), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/update", + 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.EnvelopeUpdateRequest + ), + 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="envelope-update", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeUpdateResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUpdateBadRequestErrorData, http_res + ) + raise models.EnvelopeUpdateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUpdateUnauthorizedErrorData, http_res + ) + raise models.EnvelopeUpdateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUpdateForbiddenErrorData, http_res + ) + raise models.EnvelopeUpdateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeUpdateInternalServerErrorData, http_res + ) + raise models.EnvelopeUpdateInternalServerError(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) + + def delete( + self, + *, + envelope_id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeDeleteResponse: + r"""Delete envelope + + :param envelope_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 + :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.EnvelopeDeleteRequest( + envelope_id=envelope_id, + ) + + req = self._build_request( + method="POST", + path="/envelope/delete", + 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.EnvelopeDeleteRequest + ), + 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="envelope-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeDeleteResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDeleteBadRequestErrorData, http_res + ) + raise models.EnvelopeDeleteBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDeleteUnauthorizedErrorData, http_res + ) + raise models.EnvelopeDeleteUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDeleteForbiddenErrorData, http_res + ) + raise models.EnvelopeDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDeleteInternalServerErrorData, http_res + ) + raise models.EnvelopeDeleteInternalServerError(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 delete_async( + self, + *, + envelope_id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeDeleteResponse: + r"""Delete envelope + + :param envelope_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 + :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.EnvelopeDeleteRequest( + envelope_id=envelope_id, + ) + + req = self._build_request_async( + method="POST", + path="/envelope/delete", + 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.EnvelopeDeleteRequest + ), + 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="envelope-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeDeleteResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDeleteBadRequestErrorData, http_res + ) + raise models.EnvelopeDeleteBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDeleteUnauthorizedErrorData, http_res + ) + raise models.EnvelopeDeleteUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDeleteForbiddenErrorData, http_res + ) + raise models.EnvelopeDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDeleteInternalServerErrorData, http_res + ) + raise models.EnvelopeDeleteInternalServerError(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) + + def duplicate( + self, + *, + envelope_id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeDuplicateResponse: + r"""Duplicate envelope + + Duplicate an envelope with all its settings + + :param envelope_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 + :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.EnvelopeDuplicateRequest( + envelope_id=envelope_id, + ) + + req = self._build_request( + method="POST", + path="/envelope/duplicate", + 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.EnvelopeDuplicateRequest + ), + 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="envelope-duplicate", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeDuplicateResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDuplicateBadRequestErrorData, http_res + ) + raise models.EnvelopeDuplicateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDuplicateUnauthorizedErrorData, http_res + ) + raise models.EnvelopeDuplicateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDuplicateForbiddenErrorData, http_res + ) + raise models.EnvelopeDuplicateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDuplicateInternalServerErrorData, http_res + ) + raise models.EnvelopeDuplicateInternalServerError(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 duplicate_async( + self, + *, + envelope_id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeDuplicateResponse: + r"""Duplicate envelope + + Duplicate an envelope with all its settings + + :param envelope_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 + :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.EnvelopeDuplicateRequest( + envelope_id=envelope_id, + ) + + req = self._build_request_async( + method="POST", + path="/envelope/duplicate", + 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.EnvelopeDuplicateRequest + ), + 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="envelope-duplicate", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeDuplicateResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDuplicateBadRequestErrorData, http_res + ) + raise models.EnvelopeDuplicateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDuplicateUnauthorizedErrorData, http_res + ) + raise models.EnvelopeDuplicateUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDuplicateForbiddenErrorData, http_res + ) + raise models.EnvelopeDuplicateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDuplicateInternalServerErrorData, http_res + ) + raise models.EnvelopeDuplicateInternalServerError(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) + + def distribute( + self, + *, + envelope_id: str, + meta: Optional[ + Union[models.EnvelopeDistributeMeta, models.EnvelopeDistributeMetaTypedDict] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeDistributeResponse: + r"""Distribute envelope + + Send the envelope to recipients based on your distribution method + + :param envelope_id: + :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.EnvelopeDistributeRequest( + envelope_id=envelope_id, + meta=utils.get_pydantic_model( + meta, Optional[models.EnvelopeDistributeMeta] + ), + ) + + req = self._build_request( + method="POST", + path="/envelope/distribute", + 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.EnvelopeDistributeRequest + ), + 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="envelope-distribute", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeDistributeResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDistributeBadRequestErrorData, http_res + ) + raise models.EnvelopeDistributeBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDistributeUnauthorizedErrorData, http_res + ) + raise models.EnvelopeDistributeUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDistributeForbiddenErrorData, http_res + ) + raise models.EnvelopeDistributeForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDistributeInternalServerErrorData, http_res + ) + raise models.EnvelopeDistributeInternalServerError(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 distribute_async( + self, + *, + envelope_id: str, + meta: Optional[ + Union[models.EnvelopeDistributeMeta, models.EnvelopeDistributeMetaTypedDict] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeDistributeResponse: + r"""Distribute envelope + + Send the envelope to recipients based on your distribution method + + :param envelope_id: + :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.EnvelopeDistributeRequest( + envelope_id=envelope_id, + meta=utils.get_pydantic_model( + meta, Optional[models.EnvelopeDistributeMeta] + ), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/distribute", + 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.EnvelopeDistributeRequest + ), + 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="envelope-distribute", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeDistributeResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDistributeBadRequestErrorData, http_res + ) + raise models.EnvelopeDistributeBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDistributeUnauthorizedErrorData, http_res + ) + raise models.EnvelopeDistributeUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDistributeForbiddenErrorData, http_res + ) + raise models.EnvelopeDistributeForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeDistributeInternalServerErrorData, http_res + ) + raise models.EnvelopeDistributeInternalServerError(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) + + def redistribute( + self, + *, + envelope_id: str, + recipients: List[float], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeRedistributeResponse: + r"""Redistribute envelope + + Redistribute the envelope to the provided recipients who have not actioned the envelope. Will use the distribution method set in the envelope + + :param envelope_id: + :param recipients: + :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.EnvelopeRedistributeRequest( + envelope_id=envelope_id, + recipients=recipients, + ) + + req = self._build_request( + method="POST", + path="/envelope/redistribute", + 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.EnvelopeRedistributeRequest + ), + 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="envelope-redistribute", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeRedistributeResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRedistributeBadRequestErrorData, http_res + ) + raise models.EnvelopeRedistributeBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRedistributeUnauthorizedErrorData, http_res + ) + raise models.EnvelopeRedistributeUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRedistributeForbiddenErrorData, http_res + ) + raise models.EnvelopeRedistributeForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRedistributeInternalServerErrorData, http_res + ) + raise models.EnvelopeRedistributeInternalServerError( + 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 redistribute_async( + self, + *, + envelope_id: str, + recipients: List[float], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeRedistributeResponse: + r"""Redistribute envelope + + Redistribute the envelope to the provided recipients who have not actioned the envelope. Will use the distribution method set in the envelope + + :param envelope_id: + :param recipients: + :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.EnvelopeRedistributeRequest( + envelope_id=envelope_id, + recipients=recipients, + ) + + req = self._build_request_async( + method="POST", + path="/envelope/redistribute", + 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.EnvelopeRedistributeRequest + ), + 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="envelope-redistribute", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeRedistributeResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRedistributeBadRequestErrorData, http_res + ) + raise models.EnvelopeRedistributeBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRedistributeUnauthorizedErrorData, http_res + ) + raise models.EnvelopeRedistributeUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRedistributeForbiddenErrorData, http_res + ) + raise models.EnvelopeRedistributeForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRedistributeInternalServerErrorData, http_res + ) + raise models.EnvelopeRedistributeInternalServerError( + 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/envelopes_attachments.py b/src/documenso_sdk/envelopes_attachments.py new file mode 100644 index 0000000..e65efcd --- /dev/null +++ b/src/documenso_sdk/envelopes_attachments.py @@ -0,0 +1,961 @@ +"""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, Union + + +class EnvelopesAttachments(BaseSDK): + def find( + self, + *, + envelope_id: str, + token: Optional[str] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeAttachmentFindResponse: + r"""Find attachments + + Find all attachments for an envelope + + :param envelope_id: + :param token: + :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.EnvelopeAttachmentFindRequest( + envelope_id=envelope_id, + token=token, + ) + + req = self._build_request( + method="GET", + path="/envelope/attachment", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=False, + 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, + 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="envelope-attachment-find", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeAttachmentFindResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentFindBadRequestErrorData, http_res + ) + raise models.EnvelopeAttachmentFindBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentFindUnauthorizedErrorData, http_res + ) + raise models.EnvelopeAttachmentFindUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentFindForbiddenErrorData, http_res + ) + raise models.EnvelopeAttachmentFindForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentFindNotFoundErrorData, http_res + ) + raise models.EnvelopeAttachmentFindNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentFindInternalServerErrorData, http_res + ) + raise models.EnvelopeAttachmentFindInternalServerError( + 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 find_async( + self, + *, + envelope_id: str, + token: Optional[str] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeAttachmentFindResponse: + r"""Find attachments + + Find all attachments for an envelope + + :param envelope_id: + :param token: + :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.EnvelopeAttachmentFindRequest( + envelope_id=envelope_id, + token=token, + ) + + req = self._build_request_async( + method="GET", + path="/envelope/attachment", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=False, + 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, + 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="envelope-attachment-find", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeAttachmentFindResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentFindBadRequestErrorData, http_res + ) + raise models.EnvelopeAttachmentFindBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentFindUnauthorizedErrorData, http_res + ) + raise models.EnvelopeAttachmentFindUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentFindForbiddenErrorData, http_res + ) + raise models.EnvelopeAttachmentFindForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentFindNotFoundErrorData, http_res + ) + raise models.EnvelopeAttachmentFindNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentFindInternalServerErrorData, http_res + ) + raise models.EnvelopeAttachmentFindInternalServerError( + 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) + + def create( + self, + *, + envelope_id: str, + data: Union[ + models.EnvelopeAttachmentCreateData, + models.EnvelopeAttachmentCreateDataTypedDict, + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeAttachmentCreateResponse: + r"""Create attachment + + Create a new attachment for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeAttachmentCreateRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model(data, models.EnvelopeAttachmentCreateData), + ) + + req = self._build_request( + method="POST", + path="/envelope/attachment/create", + 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.EnvelopeAttachmentCreateRequest + ), + 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="envelope-attachment-create", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeAttachmentCreateResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentCreateBadRequestErrorData, http_res + ) + raise models.EnvelopeAttachmentCreateBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentCreateUnauthorizedErrorData, http_res + ) + raise models.EnvelopeAttachmentCreateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentCreateForbiddenErrorData, http_res + ) + raise models.EnvelopeAttachmentCreateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentCreateInternalServerErrorData, http_res + ) + raise models.EnvelopeAttachmentCreateInternalServerError( + 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 create_async( + self, + *, + envelope_id: str, + data: Union[ + models.EnvelopeAttachmentCreateData, + models.EnvelopeAttachmentCreateDataTypedDict, + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeAttachmentCreateResponse: + r"""Create attachment + + Create a new attachment for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeAttachmentCreateRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model(data, models.EnvelopeAttachmentCreateData), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/attachment/create", + 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.EnvelopeAttachmentCreateRequest + ), + 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="envelope-attachment-create", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeAttachmentCreateResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentCreateBadRequestErrorData, http_res + ) + raise models.EnvelopeAttachmentCreateBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentCreateUnauthorizedErrorData, http_res + ) + raise models.EnvelopeAttachmentCreateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentCreateForbiddenErrorData, http_res + ) + raise models.EnvelopeAttachmentCreateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentCreateInternalServerErrorData, http_res + ) + raise models.EnvelopeAttachmentCreateInternalServerError( + 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) + + def update( + self, + *, + id: str, + data: Union[ + models.EnvelopeAttachmentUpdateData, + models.EnvelopeAttachmentUpdateDataTypedDict, + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeAttachmentUpdateResponse: + r"""Update attachment + + Update an existing attachment + + :param id: + :param data: + :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.EnvelopeAttachmentUpdateRequest( + id=id, + data=utils.get_pydantic_model(data, models.EnvelopeAttachmentUpdateData), + ) + + req = self._build_request( + method="POST", + path="/envelope/attachment/update", + 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.EnvelopeAttachmentUpdateRequest + ), + 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="envelope-attachment-update", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeAttachmentUpdateResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentUpdateBadRequestErrorData, http_res + ) + raise models.EnvelopeAttachmentUpdateBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentUpdateUnauthorizedErrorData, http_res + ) + raise models.EnvelopeAttachmentUpdateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentUpdateForbiddenErrorData, http_res + ) + raise models.EnvelopeAttachmentUpdateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentUpdateInternalServerErrorData, http_res + ) + raise models.EnvelopeAttachmentUpdateInternalServerError( + 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 update_async( + self, + *, + id: str, + data: Union[ + models.EnvelopeAttachmentUpdateData, + models.EnvelopeAttachmentUpdateDataTypedDict, + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeAttachmentUpdateResponse: + r"""Update attachment + + Update an existing attachment + + :param id: + :param data: + :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.EnvelopeAttachmentUpdateRequest( + id=id, + data=utils.get_pydantic_model(data, models.EnvelopeAttachmentUpdateData), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/attachment/update", + 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.EnvelopeAttachmentUpdateRequest + ), + 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="envelope-attachment-update", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeAttachmentUpdateResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentUpdateBadRequestErrorData, http_res + ) + raise models.EnvelopeAttachmentUpdateBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentUpdateUnauthorizedErrorData, http_res + ) + raise models.EnvelopeAttachmentUpdateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentUpdateForbiddenErrorData, http_res + ) + raise models.EnvelopeAttachmentUpdateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentUpdateInternalServerErrorData, http_res + ) + raise models.EnvelopeAttachmentUpdateInternalServerError( + 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) + + def delete( + self, + *, + id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeAttachmentDeleteResponse: + r"""Delete attachment + + Delete an attachment from an envelope + + :param 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 + :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.EnvelopeAttachmentDeleteRequest( + id=id, + ) + + req = self._build_request( + method="POST", + path="/envelope/attachment/delete", + 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.EnvelopeAttachmentDeleteRequest + ), + 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="envelope-attachment-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeAttachmentDeleteResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentDeleteBadRequestErrorData, http_res + ) + raise models.EnvelopeAttachmentDeleteBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentDeleteUnauthorizedErrorData, http_res + ) + raise models.EnvelopeAttachmentDeleteUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentDeleteForbiddenErrorData, http_res + ) + raise models.EnvelopeAttachmentDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentDeleteInternalServerErrorData, http_res + ) + raise models.EnvelopeAttachmentDeleteInternalServerError( + 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 delete_async( + self, + *, + id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeAttachmentDeleteResponse: + r"""Delete attachment + + Delete an attachment from an envelope + + :param 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 + :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.EnvelopeAttachmentDeleteRequest( + id=id, + ) + + req = self._build_request_async( + method="POST", + path="/envelope/attachment/delete", + 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.EnvelopeAttachmentDeleteRequest + ), + 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="envelope-attachment-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeAttachmentDeleteResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentDeleteBadRequestErrorData, http_res + ) + raise models.EnvelopeAttachmentDeleteBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentDeleteUnauthorizedErrorData, http_res + ) + raise models.EnvelopeAttachmentDeleteUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentDeleteForbiddenErrorData, http_res + ) + raise models.EnvelopeAttachmentDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeAttachmentDeleteInternalServerErrorData, http_res + ) + raise models.EnvelopeAttachmentDeleteInternalServerError( + 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/envelopes_fields.py b/src/documenso_sdk/envelopes_fields.py new file mode 100644 index 0000000..0676b0a --- /dev/null +++ b/src/documenso_sdk/envelopes_fields.py @@ -0,0 +1,927 @@ +"""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 EnvelopesFields(BaseSDK): + def get( + self, + *, + field_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.EnvelopeFieldGetResponse: + r"""Get envelope field + + Returns an envelope field given an ID + + :param field_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 + :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.EnvelopeFieldGetRequest( + field_id=field_id, + ) + + req = self._build_request( + method="GET", + path="/envelope/field/{fieldId}", + 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="envelope-field-get", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeFieldGetResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldGetBadRequestErrorData, http_res + ) + raise models.EnvelopeFieldGetBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldGetUnauthorizedErrorData, http_res + ) + raise models.EnvelopeFieldGetUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldGetForbiddenErrorData, http_res + ) + raise models.EnvelopeFieldGetForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldGetNotFoundErrorData, http_res + ) + raise models.EnvelopeFieldGetNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldGetInternalServerErrorData, http_res + ) + raise models.EnvelopeFieldGetInternalServerError(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 get_async( + self, + *, + field_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.EnvelopeFieldGetResponse: + r"""Get envelope field + + Returns an envelope field given an ID + + :param field_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 + :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.EnvelopeFieldGetRequest( + field_id=field_id, + ) + + req = self._build_request_async( + method="GET", + path="/envelope/field/{fieldId}", + 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="envelope-field-get", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeFieldGetResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldGetBadRequestErrorData, http_res + ) + raise models.EnvelopeFieldGetBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldGetUnauthorizedErrorData, http_res + ) + raise models.EnvelopeFieldGetUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldGetForbiddenErrorData, http_res + ) + raise models.EnvelopeFieldGetForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldGetNotFoundErrorData, http_res + ) + raise models.EnvelopeFieldGetNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldGetInternalServerErrorData, http_res + ) + raise models.EnvelopeFieldGetInternalServerError(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) + + def create_many( + self, + *, + envelope_id: str, + data: Union[ + List[models.EnvelopeFieldCreateManyDataUnion], + List[models.EnvelopeFieldCreateManyDataUnionTypedDict], + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeFieldCreateManyResponse: + r"""Create envelope fields + + Create multiple fields for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeFieldCreateManyRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model( + data, List[models.EnvelopeFieldCreateManyDataUnion] + ), + ) + + req = self._build_request( + method="POST", + path="/envelope/field/create-many", + 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.EnvelopeFieldCreateManyRequest + ), + 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="envelope-field-createMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeFieldCreateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldCreateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeFieldCreateManyBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldCreateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeFieldCreateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldCreateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeFieldCreateManyForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldCreateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeFieldCreateManyInternalServerError( + 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 create_many_async( + self, + *, + envelope_id: str, + data: Union[ + List[models.EnvelopeFieldCreateManyDataUnion], + List[models.EnvelopeFieldCreateManyDataUnionTypedDict], + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeFieldCreateManyResponse: + r"""Create envelope fields + + Create multiple fields for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeFieldCreateManyRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model( + data, List[models.EnvelopeFieldCreateManyDataUnion] + ), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/field/create-many", + 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.EnvelopeFieldCreateManyRequest + ), + 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="envelope-field-createMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeFieldCreateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldCreateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeFieldCreateManyBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldCreateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeFieldCreateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldCreateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeFieldCreateManyForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldCreateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeFieldCreateManyInternalServerError( + 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) + + def update_many( + self, + *, + envelope_id: str, + data: Union[ + List[models.EnvelopeFieldUpdateManyDataUnion], + List[models.EnvelopeFieldUpdateManyDataUnionTypedDict], + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeFieldUpdateManyResponse: + r"""Update envelope fields + + Update multiple envelope fields for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeFieldUpdateManyRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model( + data, List[models.EnvelopeFieldUpdateManyDataUnion] + ), + ) + + req = self._build_request( + method="POST", + path="/envelope/field/update-many", + 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.EnvelopeFieldUpdateManyRequest + ), + 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="envelope-field-updateMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeFieldUpdateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldUpdateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeFieldUpdateManyBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldUpdateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeFieldUpdateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldUpdateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeFieldUpdateManyForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldUpdateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeFieldUpdateManyInternalServerError( + 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 update_many_async( + self, + *, + envelope_id: str, + data: Union[ + List[models.EnvelopeFieldUpdateManyDataUnion], + List[models.EnvelopeFieldUpdateManyDataUnionTypedDict], + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeFieldUpdateManyResponse: + r"""Update envelope fields + + Update multiple envelope fields for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeFieldUpdateManyRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model( + data, List[models.EnvelopeFieldUpdateManyDataUnion] + ), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/field/update-many", + 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.EnvelopeFieldUpdateManyRequest + ), + 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="envelope-field-updateMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeFieldUpdateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldUpdateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeFieldUpdateManyBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldUpdateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeFieldUpdateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldUpdateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeFieldUpdateManyForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldUpdateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeFieldUpdateManyInternalServerError( + 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) + + def delete( + self, + *, + field_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.EnvelopeFieldDeleteResponse: + r"""Delete envelope field + + Delete an envelope field + + :param field_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 + :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.EnvelopeFieldDeleteRequest( + field_id=field_id, + ) + + req = self._build_request( + method="POST", + path="/envelope/field/delete", + 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.EnvelopeFieldDeleteRequest + ), + 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="envelope-field-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeFieldDeleteResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldDeleteBadRequestErrorData, http_res + ) + raise models.EnvelopeFieldDeleteBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldDeleteUnauthorizedErrorData, http_res + ) + raise models.EnvelopeFieldDeleteUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldDeleteForbiddenErrorData, http_res + ) + raise models.EnvelopeFieldDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldDeleteInternalServerErrorData, http_res + ) + raise models.EnvelopeFieldDeleteInternalServerError(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 delete_async( + self, + *, + field_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.EnvelopeFieldDeleteResponse: + r"""Delete envelope field + + Delete an envelope field + + :param field_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 + :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.EnvelopeFieldDeleteRequest( + field_id=field_id, + ) + + req = self._build_request_async( + method="POST", + path="/envelope/field/delete", + 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.EnvelopeFieldDeleteRequest + ), + 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="envelope-field-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeFieldDeleteResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldDeleteBadRequestErrorData, http_res + ) + raise models.EnvelopeFieldDeleteBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldDeleteUnauthorizedErrorData, http_res + ) + raise models.EnvelopeFieldDeleteUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldDeleteForbiddenErrorData, http_res + ) + raise models.EnvelopeFieldDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeFieldDeleteInternalServerErrorData, http_res + ) + raise models.EnvelopeFieldDeleteInternalServerError(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/envelopes_recipients.py b/src/documenso_sdk/envelopes_recipients.py new file mode 100644 index 0000000..b84c4e1 --- /dev/null +++ b/src/documenso_sdk/envelopes_recipients.py @@ -0,0 +1,963 @@ +"""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 EnvelopesRecipients(BaseSDK): + def get( + self, + *, + recipient_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.EnvelopeRecipientGetResponse: + r"""Get envelope recipient + + Returns an envelope recipient given an ID + + :param recipient_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 + :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.EnvelopeRecipientGetRequest( + recipient_id=recipient_id, + ) + + req = self._build_request( + method="GET", + path="/envelope/recipient/{recipientId}", + 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="envelope-recipient-get", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeRecipientGetResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientGetBadRequestErrorData, http_res + ) + raise models.EnvelopeRecipientGetBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientGetUnauthorizedErrorData, http_res + ) + raise models.EnvelopeRecipientGetUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientGetForbiddenErrorData, http_res + ) + raise models.EnvelopeRecipientGetForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientGetNotFoundErrorData, http_res + ) + raise models.EnvelopeRecipientGetNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientGetInternalServerErrorData, http_res + ) + raise models.EnvelopeRecipientGetInternalServerError( + 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 get_async( + self, + *, + recipient_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.EnvelopeRecipientGetResponse: + r"""Get envelope recipient + + Returns an envelope recipient given an ID + + :param recipient_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 + :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.EnvelopeRecipientGetRequest( + recipient_id=recipient_id, + ) + + req = self._build_request_async( + method="GET", + path="/envelope/recipient/{recipientId}", + 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="envelope-recipient-get", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeRecipientGetResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientGetBadRequestErrorData, http_res + ) + raise models.EnvelopeRecipientGetBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientGetUnauthorizedErrorData, http_res + ) + raise models.EnvelopeRecipientGetUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientGetForbiddenErrorData, http_res + ) + raise models.EnvelopeRecipientGetForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientGetNotFoundErrorData, http_res + ) + raise models.EnvelopeRecipientGetNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientGetInternalServerErrorData, http_res + ) + raise models.EnvelopeRecipientGetInternalServerError( + 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) + + def create_many( + self, + *, + envelope_id: str, + data: Union[ + List[models.EnvelopeRecipientCreateManyDataRequest], + List[models.EnvelopeRecipientCreateManyDataRequestTypedDict], + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeRecipientCreateManyResponse: + r"""Create envelope recipients + + Create multiple recipients for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeRecipientCreateManyRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model( + data, List[models.EnvelopeRecipientCreateManyDataRequest] + ), + ) + + req = self._build_request( + method="POST", + path="/envelope/recipient/create-many", + 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.EnvelopeRecipientCreateManyRequest + ), + 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="envelope-recipient-createMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeRecipientCreateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientCreateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeRecipientCreateManyBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientCreateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeRecipientCreateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientCreateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeRecipientCreateManyForbiddenError( + response_data, http_res + ) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientCreateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeRecipientCreateManyInternalServerError( + 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 create_many_async( + self, + *, + envelope_id: str, + data: Union[ + List[models.EnvelopeRecipientCreateManyDataRequest], + List[models.EnvelopeRecipientCreateManyDataRequestTypedDict], + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeRecipientCreateManyResponse: + r"""Create envelope recipients + + Create multiple recipients for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeRecipientCreateManyRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model( + data, List[models.EnvelopeRecipientCreateManyDataRequest] + ), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/recipient/create-many", + 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.EnvelopeRecipientCreateManyRequest + ), + 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="envelope-recipient-createMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeRecipientCreateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientCreateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeRecipientCreateManyBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientCreateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeRecipientCreateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientCreateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeRecipientCreateManyForbiddenError( + response_data, http_res + ) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientCreateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeRecipientCreateManyInternalServerError( + 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) + + def update_many( + self, + *, + envelope_id: str, + data: Union[ + List[models.EnvelopeRecipientUpdateManyDataRequest], + List[models.EnvelopeRecipientUpdateManyDataRequestTypedDict], + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeRecipientUpdateManyResponse: + r"""Update envelope recipients + + Update multiple recipients for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeRecipientUpdateManyRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model( + data, List[models.EnvelopeRecipientUpdateManyDataRequest] + ), + ) + + req = self._build_request( + method="POST", + path="/envelope/recipient/update-many", + 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.EnvelopeRecipientUpdateManyRequest + ), + 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="envelope-recipient-updateMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeRecipientUpdateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientUpdateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeRecipientUpdateManyBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientUpdateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeRecipientUpdateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientUpdateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeRecipientUpdateManyForbiddenError( + response_data, http_res + ) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientUpdateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeRecipientUpdateManyInternalServerError( + 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 update_many_async( + self, + *, + envelope_id: str, + data: Union[ + List[models.EnvelopeRecipientUpdateManyDataRequest], + List[models.EnvelopeRecipientUpdateManyDataRequestTypedDict], + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeRecipientUpdateManyResponse: + r"""Update envelope recipients + + Update multiple recipients for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeRecipientUpdateManyRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model( + data, List[models.EnvelopeRecipientUpdateManyDataRequest] + ), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/recipient/update-many", + 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.EnvelopeRecipientUpdateManyRequest + ), + 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="envelope-recipient-updateMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeRecipientUpdateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientUpdateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeRecipientUpdateManyBadRequestError( + response_data, http_res + ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientUpdateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeRecipientUpdateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientUpdateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeRecipientUpdateManyForbiddenError( + response_data, http_res + ) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientUpdateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeRecipientUpdateManyInternalServerError( + 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) + + def delete( + self, + *, + recipient_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.EnvelopeRecipientDeleteResponse: + r"""Delete envelope recipient + + Delete an envelope recipient + + :param recipient_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 + :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.EnvelopeRecipientDeleteRequest( + recipient_id=recipient_id, + ) + + req = self._build_request( + method="POST", + path="/envelope/recipient/delete", + 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.EnvelopeRecipientDeleteRequest + ), + 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="envelope-recipient-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeRecipientDeleteResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientDeleteBadRequestErrorData, http_res + ) + raise models.EnvelopeRecipientDeleteBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientDeleteUnauthorizedErrorData, http_res + ) + raise models.EnvelopeRecipientDeleteUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientDeleteForbiddenErrorData, http_res + ) + raise models.EnvelopeRecipientDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientDeleteInternalServerErrorData, http_res + ) + raise models.EnvelopeRecipientDeleteInternalServerError( + 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 delete_async( + self, + *, + recipient_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.EnvelopeRecipientDeleteResponse: + r"""Delete envelope recipient + + Delete an envelope recipient + + :param recipient_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 + :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.EnvelopeRecipientDeleteRequest( + recipient_id=recipient_id, + ) + + req = self._build_request_async( + method="POST", + path="/envelope/recipient/delete", + 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.EnvelopeRecipientDeleteRequest + ), + 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="envelope-recipient-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeRecipientDeleteResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientDeleteBadRequestErrorData, http_res + ) + raise models.EnvelopeRecipientDeleteBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientDeleteUnauthorizedErrorData, http_res + ) + raise models.EnvelopeRecipientDeleteUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientDeleteForbiddenErrorData, http_res + ) + raise models.EnvelopeRecipientDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeRecipientDeleteInternalServerErrorData, http_res + ) + raise models.EnvelopeRecipientDeleteInternalServerError( + 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/folders.py b/src/documenso_sdk/folders.py new file mode 100644 index 0000000..8100086 --- /dev/null +++ b/src/documenso_sdk/folders.py @@ -0,0 +1,917 @@ +"""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, Union + + +class Folders(BaseSDK): + def find( + self, + *, + query: Optional[str] = None, + page: Optional[float] = None, + per_page: Optional[float] = None, + parent_id: Optional[str] = None, + type_: Optional[models.FolderFindFoldersQueryParamType] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.FolderFindFoldersResponse: + r"""Find folders + + Find folders based on a search criteria + + :param query: The search query. + :param page: The pagination page number, starts at 1. + :param per_page: The number of items per page. + :param parent_id: + :param type: + :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.FolderFindFoldersRequest( + query=query, + page=page, + per_page=per_page, + parent_id=parent_id, + type=type_, + ) + + req = self._build_request( + method="GET", + path="/folder", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=False, + 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, + 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="folder-findFolders", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.FolderFindFoldersResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.FolderFindFoldersBadRequestErrorData, http_res + ) + raise models.FolderFindFoldersBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FolderFindFoldersUnauthorizedErrorData, http_res + ) + raise models.FolderFindFoldersUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FolderFindFoldersForbiddenErrorData, http_res + ) + raise models.FolderFindFoldersForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.FolderFindFoldersNotFoundErrorData, http_res + ) + raise models.FolderFindFoldersNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.FolderFindFoldersInternalServerErrorData, http_res + ) + raise models.FolderFindFoldersInternalServerError(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 find_async( + self, + *, + query: Optional[str] = None, + page: Optional[float] = None, + per_page: Optional[float] = None, + parent_id: Optional[str] = None, + type_: Optional[models.FolderFindFoldersQueryParamType] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.FolderFindFoldersResponse: + r"""Find folders + + Find folders based on a search criteria + + :param query: The search query. + :param page: The pagination page number, starts at 1. + :param per_page: The number of items per page. + :param parent_id: + :param type: + :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.FolderFindFoldersRequest( + query=query, + page=page, + per_page=per_page, + parent_id=parent_id, + type=type_, + ) + + req = self._build_request_async( + method="GET", + path="/folder", + base_url=base_url, + url_variables=url_variables, + request=request, + request_body_required=False, + 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, + 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="folder-findFolders", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.FolderFindFoldersResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.FolderFindFoldersBadRequestErrorData, http_res + ) + raise models.FolderFindFoldersBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FolderFindFoldersUnauthorizedErrorData, http_res + ) + raise models.FolderFindFoldersUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FolderFindFoldersForbiddenErrorData, http_res + ) + raise models.FolderFindFoldersForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.FolderFindFoldersNotFoundErrorData, http_res + ) + raise models.FolderFindFoldersNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.FolderFindFoldersInternalServerErrorData, http_res + ) + raise models.FolderFindFoldersInternalServerError(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) + + def create( + self, + *, + name: str, + parent_id: Optional[str] = None, + type_: Optional[models.FolderCreateFolderTypeRequest] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.FolderCreateFolderResponse: + r"""Create new folder + + Creates a new folder in your team + + :param name: + :param parent_id: + :param type: + :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.FolderCreateFolderRequest( + name=name, + parent_id=parent_id, + type=type_, + ) + + req = self._build_request( + method="POST", + path="/folder/create", + 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.FolderCreateFolderRequest + ), + 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="folder-createFolder", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.FolderCreateFolderResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.FolderCreateFolderBadRequestErrorData, http_res + ) + raise models.FolderCreateFolderBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FolderCreateFolderUnauthorizedErrorData, http_res + ) + raise models.FolderCreateFolderUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FolderCreateFolderForbiddenErrorData, http_res + ) + raise models.FolderCreateFolderForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.FolderCreateFolderInternalServerErrorData, http_res + ) + raise models.FolderCreateFolderInternalServerError(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 create_async( + self, + *, + name: str, + parent_id: Optional[str] = None, + type_: Optional[models.FolderCreateFolderTypeRequest] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.FolderCreateFolderResponse: + r"""Create new folder + + Creates a new folder in your team + + :param name: + :param parent_id: + :param type: + :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.FolderCreateFolderRequest( + name=name, + parent_id=parent_id, + type=type_, + ) + + req = self._build_request_async( + method="POST", + path="/folder/create", + 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.FolderCreateFolderRequest + ), + 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="folder-createFolder", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.FolderCreateFolderResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.FolderCreateFolderBadRequestErrorData, http_res + ) + raise models.FolderCreateFolderBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FolderCreateFolderUnauthorizedErrorData, http_res + ) + raise models.FolderCreateFolderUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FolderCreateFolderForbiddenErrorData, http_res + ) + raise models.FolderCreateFolderForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.FolderCreateFolderInternalServerErrorData, http_res + ) + raise models.FolderCreateFolderInternalServerError(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) + + def update( + self, + *, + folder_id: str, + data: Union[ + models.FolderUpdateFolderData, models.FolderUpdateFolderDataTypedDict + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.FolderUpdateFolderResponse: + r"""Update folder + + Updates an existing folder + + :param folder_id: + :param data: + :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.FolderUpdateFolderRequest( + folder_id=folder_id, + data=utils.get_pydantic_model(data, models.FolderUpdateFolderData), + ) + + req = self._build_request( + method="POST", + path="/folder/update", + 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.FolderUpdateFolderRequest + ), + 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="folder-updateFolder", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.FolderUpdateFolderResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.FolderUpdateFolderBadRequestErrorData, http_res + ) + raise models.FolderUpdateFolderBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FolderUpdateFolderUnauthorizedErrorData, http_res + ) + raise models.FolderUpdateFolderUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FolderUpdateFolderForbiddenErrorData, http_res + ) + raise models.FolderUpdateFolderForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.FolderUpdateFolderInternalServerErrorData, http_res + ) + raise models.FolderUpdateFolderInternalServerError(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 update_async( + self, + *, + folder_id: str, + data: Union[ + models.FolderUpdateFolderData, models.FolderUpdateFolderDataTypedDict + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.FolderUpdateFolderResponse: + r"""Update folder + + Updates an existing folder + + :param folder_id: + :param data: + :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.FolderUpdateFolderRequest( + folder_id=folder_id, + data=utils.get_pydantic_model(data, models.FolderUpdateFolderData), + ) + + req = self._build_request_async( + method="POST", + path="/folder/update", + 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.FolderUpdateFolderRequest + ), + 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="folder-updateFolder", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.FolderUpdateFolderResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.FolderUpdateFolderBadRequestErrorData, http_res + ) + raise models.FolderUpdateFolderBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FolderUpdateFolderUnauthorizedErrorData, http_res + ) + raise models.FolderUpdateFolderUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FolderUpdateFolderForbiddenErrorData, http_res + ) + raise models.FolderUpdateFolderForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.FolderUpdateFolderInternalServerErrorData, http_res + ) + raise models.FolderUpdateFolderInternalServerError(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) + + def delete( + self, + *, + folder_id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.FolderDeleteFolderResponse: + r"""Delete folder + + Deletes an existing folder + + :param folder_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 + :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.FolderDeleteFolderRequest( + folder_id=folder_id, + ) + + req = self._build_request( + method="POST", + path="/folder/delete", + 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.FolderDeleteFolderRequest + ), + 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="folder-deleteFolder", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.FolderDeleteFolderResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.FolderDeleteFolderBadRequestErrorData, http_res + ) + raise models.FolderDeleteFolderBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FolderDeleteFolderUnauthorizedErrorData, http_res + ) + raise models.FolderDeleteFolderUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FolderDeleteFolderForbiddenErrorData, http_res + ) + raise models.FolderDeleteFolderForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.FolderDeleteFolderInternalServerErrorData, http_res + ) + raise models.FolderDeleteFolderInternalServerError(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 delete_async( + self, + *, + folder_id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.FolderDeleteFolderResponse: + r"""Delete folder + + Deletes an existing folder + + :param folder_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 + :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.FolderDeleteFolderRequest( + folder_id=folder_id, + ) + + req = self._build_request_async( + method="POST", + path="/folder/delete", + 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.FolderDeleteFolderRequest + ), + 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="folder-deleteFolder", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.FolderDeleteFolderResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.FolderDeleteFolderBadRequestErrorData, http_res + ) + raise models.FolderDeleteFolderBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FolderDeleteFolderUnauthorizedErrorData, http_res + ) + raise models.FolderDeleteFolderUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FolderDeleteFolderForbiddenErrorData, http_res + ) + raise models.FolderDeleteFolderForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.FolderDeleteFolderInternalServerErrorData, http_res + ) + raise models.FolderDeleteFolderInternalServerError(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/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/items.py b/src/documenso_sdk/items.py new file mode 100644 index 0000000..f8e07d9 --- /dev/null +++ b/src/documenso_sdk/items.py @@ -0,0 +1,967 @@ +"""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 Items(BaseSDK): + def create_many( + self, + *, + payload: Union[ + models.EnvelopeItemCreateManyPayload, + models.EnvelopeItemCreateManyPayloadTypedDict, + ], + files: Optional[ + Union[ + List[models.EnvelopeItemCreateManyFile], + List[models.EnvelopeItemCreateManyFileTypedDict], + ] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeItemCreateManyResponse: + r"""Create envelope items + + Create multiple envelope items for an envelope + + :param payload: + :param files: + :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.EnvelopeItemCreateManyRequest( + payload=utils.get_pydantic_model( + payload, models.EnvelopeItemCreateManyPayload + ), + files=utils.get_pydantic_model( + files, Optional[List[models.EnvelopeItemCreateManyFile]] + ), + ) + + req = self._build_request( + method="POST", + path="/envelope/item/create-many", + 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, "multipart", models.EnvelopeItemCreateManyRequest + ), + 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="envelope-item-createMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeItemCreateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemCreateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeItemCreateManyBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemCreateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeItemCreateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemCreateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeItemCreateManyForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemCreateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeItemCreateManyInternalServerError( + 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 create_many_async( + self, + *, + payload: Union[ + models.EnvelopeItemCreateManyPayload, + models.EnvelopeItemCreateManyPayloadTypedDict, + ], + files: Optional[ + Union[ + List[models.EnvelopeItemCreateManyFile], + List[models.EnvelopeItemCreateManyFileTypedDict], + ] + ] = None, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeItemCreateManyResponse: + r"""Create envelope items + + Create multiple envelope items for an envelope + + :param payload: + :param files: + :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.EnvelopeItemCreateManyRequest( + payload=utils.get_pydantic_model( + payload, models.EnvelopeItemCreateManyPayload + ), + files=utils.get_pydantic_model( + files, Optional[List[models.EnvelopeItemCreateManyFile]] + ), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/item/create-many", + 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, "multipart", models.EnvelopeItemCreateManyRequest + ), + 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="envelope-item-createMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeItemCreateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemCreateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeItemCreateManyBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemCreateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeItemCreateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemCreateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeItemCreateManyForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemCreateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeItemCreateManyInternalServerError( + 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) + + def update_many( + self, + *, + envelope_id: str, + data: Union[ + List[models.EnvelopeItemUpdateManyDataRequest], + List[models.EnvelopeItemUpdateManyDataRequestTypedDict], + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeItemUpdateManyResponse: + r"""Update envelope items + + Update multiple envelope items for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeItemUpdateManyRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model( + data, List[models.EnvelopeItemUpdateManyDataRequest] + ), + ) + + req = self._build_request( + method="POST", + path="/envelope/item/update-many", + 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.EnvelopeItemUpdateManyRequest + ), + 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="envelope-item-updateMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeItemUpdateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemUpdateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeItemUpdateManyBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemUpdateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeItemUpdateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemUpdateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeItemUpdateManyForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemUpdateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeItemUpdateManyInternalServerError( + 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 update_many_async( + self, + *, + envelope_id: str, + data: Union[ + List[models.EnvelopeItemUpdateManyDataRequest], + List[models.EnvelopeItemUpdateManyDataRequestTypedDict], + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeItemUpdateManyResponse: + r"""Update envelope items + + Update multiple envelope items for an envelope + + :param envelope_id: + :param data: + :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.EnvelopeItemUpdateManyRequest( + envelope_id=envelope_id, + data=utils.get_pydantic_model( + data, List[models.EnvelopeItemUpdateManyDataRequest] + ), + ) + + req = self._build_request_async( + method="POST", + path="/envelope/item/update-many", + 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.EnvelopeItemUpdateManyRequest + ), + 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="envelope-item-updateMany", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeItemUpdateManyResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemUpdateManyBadRequestErrorData, http_res + ) + raise models.EnvelopeItemUpdateManyBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemUpdateManyUnauthorizedErrorData, http_res + ) + raise models.EnvelopeItemUpdateManyUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemUpdateManyForbiddenErrorData, http_res + ) + raise models.EnvelopeItemUpdateManyForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemUpdateManyInternalServerErrorData, http_res + ) + raise models.EnvelopeItemUpdateManyInternalServerError( + 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) + + def delete( + self, + *, + envelope_id: str, + envelope_item_id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeItemDeleteResponse: + r"""Delete envelope item + + Delete an envelope item from an envelope + + :param envelope_id: + :param envelope_item_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 + :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.EnvelopeItemDeleteRequest( + envelope_id=envelope_id, + envelope_item_id=envelope_item_id, + ) + + req = self._build_request( + method="POST", + path="/envelope/item/delete", + 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.EnvelopeItemDeleteRequest + ), + 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="envelope-item-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeItemDeleteResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDeleteBadRequestErrorData, http_res + ) + raise models.EnvelopeItemDeleteBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDeleteUnauthorizedErrorData, http_res + ) + raise models.EnvelopeItemDeleteUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDeleteForbiddenErrorData, http_res + ) + raise models.EnvelopeItemDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDeleteInternalServerErrorData, http_res + ) + raise models.EnvelopeItemDeleteInternalServerError(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 delete_async( + self, + *, + envelope_id: str, + envelope_item_id: str, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeItemDeleteResponse: + r"""Delete envelope item + + Delete an envelope item from an envelope + + :param envelope_id: + :param envelope_item_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 + :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.EnvelopeItemDeleteRequest( + envelope_id=envelope_id, + envelope_item_id=envelope_item_id, + ) + + req = self._build_request_async( + method="POST", + path="/envelope/item/delete", + 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.EnvelopeItemDeleteRequest + ), + 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="envelope-item-delete", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.EnvelopeItemDeleteResponse, http_res) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDeleteBadRequestErrorData, http_res + ) + raise models.EnvelopeItemDeleteBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDeleteUnauthorizedErrorData, http_res + ) + raise models.EnvelopeItemDeleteUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDeleteForbiddenErrorData, http_res + ) + raise models.EnvelopeItemDeleteForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDeleteInternalServerErrorData, http_res + ) + raise models.EnvelopeItemDeleteInternalServerError(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) + + def download( + self, + *, + envelope_item_id: str, + version: Optional[ + models.EnvelopeItemDownloadVersion + ] = models.EnvelopeItemDownloadVersion.SIGNED, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeItemDownloadResponse: + r"""Download an envelope item + + Download an envelope item by its ID + + :param envelope_item_id: The ID of the envelope item to download. + :param version: The version of the envelope item 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.EnvelopeItemDownloadRequest( + envelope_item_id=envelope_item_id, + version=version, + ) + + req = self._build_request( + method="GET", + path="/envelope/item/{envelopeItemId}/download", + 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="envelope-item-download", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], + retry_config=retry_config, + ) + + response_data: Any = None + if utils.match_response(http_res, "200", "application/json"): + return models.EnvelopeItemDownloadResponse( + result=unmarshal_json_response(Any, http_res), + headers=utils.get_response_headers(http_res.headers), + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDownloadBadRequestErrorData, http_res + ) + raise models.EnvelopeItemDownloadBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDownloadUnauthorizedErrorData, http_res + ) + raise models.EnvelopeItemDownloadUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDownloadForbiddenErrorData, http_res + ) + raise models.EnvelopeItemDownloadForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDownloadNotFoundErrorData, http_res + ) + raise models.EnvelopeItemDownloadNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDownloadInternalServerErrorData, http_res + ) + raise models.EnvelopeItemDownloadInternalServerError( + 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 download_async( + self, + *, + envelope_item_id: str, + version: Optional[ + models.EnvelopeItemDownloadVersion + ] = models.EnvelopeItemDownloadVersion.SIGNED, + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.EnvelopeItemDownloadResponse: + r"""Download an envelope item + + Download an envelope item by its ID + + :param envelope_item_id: The ID of the envelope item to download. + :param version: The version of the envelope item 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.EnvelopeItemDownloadRequest( + envelope_item_id=envelope_item_id, + version=version, + ) + + req = self._build_request_async( + method="GET", + path="/envelope/item/{envelopeItemId}/download", + 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="envelope-item-download", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], + retry_config=retry_config, + ) + + response_data: Any = None + if utils.match_response(http_res, "200", "application/json"): + return models.EnvelopeItemDownloadResponse( + result=unmarshal_json_response(Any, http_res), + headers=utils.get_response_headers(http_res.headers), + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDownloadBadRequestErrorData, http_res + ) + raise models.EnvelopeItemDownloadBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDownloadUnauthorizedErrorData, http_res + ) + raise models.EnvelopeItemDownloadUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDownloadForbiddenErrorData, http_res + ) + raise models.EnvelopeItemDownloadForbiddenError(response_data, http_res) + if utils.match_response(http_res, "404", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDownloadNotFoundErrorData, http_res + ) + raise models.EnvelopeItemDownloadNotFoundError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.EnvelopeItemDownloadInternalServerErrorData, http_res + ) + raise models.EnvelopeItemDownloadInternalServerError( + 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/models/__init__.py b/src/documenso_sdk/models/__init__.py index ec9d1db..7e59ff2 100644 --- a/src/documenso_sdk/models/__init__.py +++ b/src/documenso_sdk/models/__init__.py @@ -8,12 +8,112 @@ if TYPE_CHECKING: from .apierror import APIError + from .document_attachment_createop import ( + DocumentAttachmentCreateBadRequestError, + DocumentAttachmentCreateBadRequestErrorData, + DocumentAttachmentCreateBadRequestIssue, + DocumentAttachmentCreateBadRequestIssueTypedDict, + DocumentAttachmentCreateData, + DocumentAttachmentCreateDataTypedDict, + DocumentAttachmentCreateForbiddenError, + DocumentAttachmentCreateForbiddenErrorData, + DocumentAttachmentCreateForbiddenIssue, + DocumentAttachmentCreateForbiddenIssueTypedDict, + DocumentAttachmentCreateInternalServerError, + DocumentAttachmentCreateInternalServerErrorData, + DocumentAttachmentCreateInternalServerErrorIssue, + DocumentAttachmentCreateInternalServerErrorIssueTypedDict, + DocumentAttachmentCreateRequest, + DocumentAttachmentCreateRequestTypedDict, + DocumentAttachmentCreateResponse, + DocumentAttachmentCreateResponseTypedDict, + DocumentAttachmentCreateUnauthorizedError, + DocumentAttachmentCreateUnauthorizedErrorData, + DocumentAttachmentCreateUnauthorizedIssue, + DocumentAttachmentCreateUnauthorizedIssueTypedDict, + ) + from .document_attachment_deleteop import ( + DocumentAttachmentDeleteBadRequestError, + DocumentAttachmentDeleteBadRequestErrorData, + DocumentAttachmentDeleteBadRequestIssue, + DocumentAttachmentDeleteBadRequestIssueTypedDict, + DocumentAttachmentDeleteForbiddenError, + DocumentAttachmentDeleteForbiddenErrorData, + DocumentAttachmentDeleteForbiddenIssue, + DocumentAttachmentDeleteForbiddenIssueTypedDict, + DocumentAttachmentDeleteInternalServerError, + DocumentAttachmentDeleteInternalServerErrorData, + DocumentAttachmentDeleteInternalServerErrorIssue, + DocumentAttachmentDeleteInternalServerErrorIssueTypedDict, + DocumentAttachmentDeleteRequest, + DocumentAttachmentDeleteRequestTypedDict, + DocumentAttachmentDeleteResponse, + DocumentAttachmentDeleteResponseTypedDict, + DocumentAttachmentDeleteUnauthorizedError, + DocumentAttachmentDeleteUnauthorizedErrorData, + DocumentAttachmentDeleteUnauthorizedIssue, + DocumentAttachmentDeleteUnauthorizedIssueTypedDict, + ) + from .document_attachment_findop import ( + DocumentAttachmentFindBadRequestError, + DocumentAttachmentFindBadRequestErrorData, + DocumentAttachmentFindBadRequestIssue, + DocumentAttachmentFindBadRequestIssueTypedDict, + DocumentAttachmentFindData, + DocumentAttachmentFindDataTypedDict, + DocumentAttachmentFindForbiddenError, + DocumentAttachmentFindForbiddenErrorData, + DocumentAttachmentFindForbiddenIssue, + DocumentAttachmentFindForbiddenIssueTypedDict, + DocumentAttachmentFindInternalServerError, + DocumentAttachmentFindInternalServerErrorData, + DocumentAttachmentFindInternalServerErrorIssue, + DocumentAttachmentFindInternalServerErrorIssueTypedDict, + DocumentAttachmentFindNotFoundError, + DocumentAttachmentFindNotFoundErrorData, + DocumentAttachmentFindNotFoundIssue, + DocumentAttachmentFindNotFoundIssueTypedDict, + DocumentAttachmentFindRequest, + DocumentAttachmentFindRequestTypedDict, + DocumentAttachmentFindResponse, + DocumentAttachmentFindResponseTypedDict, + DocumentAttachmentFindType, + DocumentAttachmentFindUnauthorizedError, + DocumentAttachmentFindUnauthorizedErrorData, + DocumentAttachmentFindUnauthorizedIssue, + DocumentAttachmentFindUnauthorizedIssueTypedDict, + ) + from .document_attachment_updateop import ( + DocumentAttachmentUpdateBadRequestError, + DocumentAttachmentUpdateBadRequestErrorData, + DocumentAttachmentUpdateBadRequestIssue, + DocumentAttachmentUpdateBadRequestIssueTypedDict, + DocumentAttachmentUpdateData, + DocumentAttachmentUpdateDataTypedDict, + DocumentAttachmentUpdateForbiddenError, + DocumentAttachmentUpdateForbiddenErrorData, + DocumentAttachmentUpdateForbiddenIssue, + DocumentAttachmentUpdateForbiddenIssueTypedDict, + DocumentAttachmentUpdateInternalServerError, + DocumentAttachmentUpdateInternalServerErrorData, + DocumentAttachmentUpdateInternalServerErrorIssue, + DocumentAttachmentUpdateInternalServerErrorIssueTypedDict, + DocumentAttachmentUpdateRequest, + DocumentAttachmentUpdateRequestTypedDict, + DocumentAttachmentUpdateResponse, + DocumentAttachmentUpdateResponseTypedDict, + DocumentAttachmentUpdateUnauthorizedError, + DocumentAttachmentUpdateUnauthorizedErrorData, + DocumentAttachmentUpdateUnauthorizedIssue, + DocumentAttachmentUpdateUnauthorizedIssueTypedDict, + ) from .document_createdocumenttemporaryop import ( - Document, DocumentAccessAuth, DocumentActionAuth, DocumentCreateDocumentTemporaryAccessAuthRequest, DocumentCreateDocumentTemporaryActionAuthRequest, + DocumentCreateDocumentTemporaryAttachment, + DocumentCreateDocumentTemporaryAttachmentTypedDict, DocumentCreateDocumentTemporaryAuthOptions, DocumentCreateDocumentTemporaryAuthOptionsTypedDict, DocumentCreateDocumentTemporaryBadRequestError, @@ -21,13 +121,16 @@ DocumentCreateDocumentTemporaryBadRequestIssue, DocumentCreateDocumentTemporaryBadRequestIssueTypedDict, DocumentCreateDocumentTemporaryDateFormat, - DocumentCreateDocumentTemporaryDistributionMethodRequest, + DocumentCreateDocumentTemporaryDirectionCheckbox, + DocumentCreateDocumentTemporaryDirectionRadio, + DocumentCreateDocumentTemporaryDocument, DocumentCreateDocumentTemporaryDocumentData, DocumentCreateDocumentTemporaryDocumentDataTypedDict, DocumentCreateDocumentTemporaryDocumentMeta, DocumentCreateDocumentTemporaryDocumentMetaTypedDict, - DocumentCreateDocumentTemporaryEmailSettingsRequest, - DocumentCreateDocumentTemporaryEmailSettingsRequestTypedDict, + DocumentCreateDocumentTemporaryDocumentTypedDict, + DocumentCreateDocumentTemporaryEnvelopeItem, + DocumentCreateDocumentTemporaryEnvelopeItemTypedDict, DocumentCreateDocumentTemporaryFieldCheckbox, DocumentCreateDocumentTemporaryFieldCheckboxTypedDict, DocumentCreateDocumentTemporaryFieldDate, @@ -54,6 +157,12 @@ DocumentCreateDocumentTemporaryFieldUnionTypedDict, DocumentCreateDocumentTemporaryFolder, DocumentCreateDocumentTemporaryFolderTypedDict, + DocumentCreateDocumentTemporaryForbiddenError, + DocumentCreateDocumentTemporaryForbiddenErrorData, + DocumentCreateDocumentTemporaryForbiddenIssue, + DocumentCreateDocumentTemporaryForbiddenIssueTypedDict, + DocumentCreateDocumentTemporaryFormValuesRequest, + DocumentCreateDocumentTemporaryFormValuesRequestTypedDict, DocumentCreateDocumentTemporaryGlobalAccessAuthRequest, DocumentCreateDocumentTemporaryGlobalActionAuthRequest, DocumentCreateDocumentTemporaryInternalServerError, @@ -62,6 +171,9 @@ DocumentCreateDocumentTemporaryInternalServerErrorIssueTypedDict, DocumentCreateDocumentTemporaryLanguage, DocumentCreateDocumentTemporaryMeta, + DocumentCreateDocumentTemporaryMetaDistributionMethod, + DocumentCreateDocumentTemporaryMetaEmailSettings, + DocumentCreateDocumentTemporaryMetaEmailSettingsTypedDict, DocumentCreateDocumentTemporaryMetaTypedDict, DocumentCreateDocumentTemporaryReadStatus, DocumentCreateDocumentTemporaryRecipientAuthOptions, @@ -82,6 +194,8 @@ DocumentCreateDocumentTemporaryRecipientFieldMetaNumberTypedDict, DocumentCreateDocumentTemporaryRecipientFieldMetaRadio, DocumentCreateDocumentTemporaryRecipientFieldMetaRadioTypedDict, + DocumentCreateDocumentTemporaryRecipientFieldMetaSignature, + DocumentCreateDocumentTemporaryRecipientFieldMetaSignatureTypedDict, DocumentCreateDocumentTemporaryRecipientFieldMetaText, DocumentCreateDocumentTemporaryRecipientFieldMetaTextTypedDict, DocumentCreateDocumentTemporaryRecipientRequest, @@ -102,6 +216,8 @@ DocumentCreateDocumentTemporaryRecipientTypeNumber2, DocumentCreateDocumentTemporaryRecipientTypeRadio1, DocumentCreateDocumentTemporaryRecipientTypeRadio2, + DocumentCreateDocumentTemporaryRecipientTypeSignature1, + DocumentCreateDocumentTemporaryRecipientTypeSignature2, DocumentCreateDocumentTemporaryRecipientTypeText1, DocumentCreateDocumentTemporaryRecipientTypeText2, DocumentCreateDocumentTemporaryRequest, @@ -121,14 +237,22 @@ DocumentCreateDocumentTemporaryTextAlignNumber, DocumentCreateDocumentTemporaryTextAlignText, DocumentCreateDocumentTemporaryTypeFreeSignature, - DocumentCreateDocumentTemporaryTypeSignature, + DocumentCreateDocumentTemporaryTypeLink, + DocumentCreateDocumentTemporaryUnauthorizedError, + DocumentCreateDocumentTemporaryUnauthorizedErrorData, + DocumentCreateDocumentTemporaryUnauthorizedIssue, + DocumentCreateDocumentTemporaryUnauthorizedIssueTypedDict, DocumentCreateDocumentTemporaryValueCheckbox, DocumentCreateDocumentTemporaryValueCheckboxTypedDict, DocumentCreateDocumentTemporaryValueDropdown, DocumentCreateDocumentTemporaryValueDropdownTypedDict, DocumentCreateDocumentTemporaryValueRadio, DocumentCreateDocumentTemporaryValueRadioTypedDict, + DocumentCreateDocumentTemporaryVerticalAlignNumber, + DocumentCreateDocumentTemporaryVerticalAlignText, DocumentCreateDocumentTemporaryVisibilityRequest, + DocumentDirection1, + DocumentDirection2, DocumentDistributionMethod, DocumentDocumentDataType, DocumentEmailSettings, @@ -162,14 +286,16 @@ DocumentTypeName, DocumentTypeNumber, DocumentTypeRadio, + DocumentTypeSignature, DocumentTypeText, - DocumentTypedDict, DocumentValue1, DocumentValue1TypedDict, DocumentValue2, DocumentValue2TypedDict, DocumentValue3, DocumentValue3TypedDict, + DocumentVerticalAlign1, + DocumentVerticalAlign2, DocumentVisibility, FieldMetaDocumentCheckbox, FieldMetaDocumentCheckboxTypedDict, @@ -187,265 +313,516 @@ FieldMetaDocumentNumberTypedDict, FieldMetaDocumentRadio, FieldMetaDocumentRadioTypedDict, + FieldMetaDocumentSignature, + FieldMetaDocumentSignatureTypedDict, FieldMetaDocumentText, FieldMetaDocumentTextTypedDict, - FormValuesRequest, - FormValuesRequestTypedDict, ) - from .document_deletedocumentop import ( - DocumentDeleteDocumentBadRequestError, - DocumentDeleteDocumentBadRequestErrorData, - DocumentDeleteDocumentBadRequestIssue, - DocumentDeleteDocumentBadRequestIssueTypedDict, - DocumentDeleteDocumentInternalServerError, - DocumentDeleteDocumentInternalServerErrorData, - DocumentDeleteDocumentInternalServerErrorIssue, - DocumentDeleteDocumentInternalServerErrorIssueTypedDict, - DocumentDeleteDocumentRequest, - DocumentDeleteDocumentRequestTypedDict, - DocumentDeleteDocumentResponse, - DocumentDeleteDocumentResponseTypedDict, + from .document_createop import ( + DocumentCreateAccessAuth, + DocumentCreateActionAuth, + DocumentCreateAttachment, + DocumentCreateAttachmentTypedDict, + DocumentCreateBadRequestError, + DocumentCreateBadRequestErrorData, + DocumentCreateBadRequestIssue, + DocumentCreateBadRequestIssueTypedDict, + DocumentCreateDateFormat, + DocumentCreateDirectionCheckbox, + DocumentCreateDirectionRadio, + DocumentCreateDistributionMethod, + DocumentCreateEmailSettings, + DocumentCreateEmailSettingsTypedDict, + DocumentCreateFieldCheckbox, + DocumentCreateFieldCheckboxTypedDict, + DocumentCreateFieldDate, + DocumentCreateFieldDateTypedDict, + DocumentCreateFieldDropdown, + DocumentCreateFieldDropdownTypedDict, + DocumentCreateFieldEmail, + DocumentCreateFieldEmailTypedDict, + DocumentCreateFieldFreeSignature, + DocumentCreateFieldFreeSignatureTypedDict, + DocumentCreateFieldInitials, + DocumentCreateFieldInitialsTypedDict, + DocumentCreateFieldMetaCheckbox, + DocumentCreateFieldMetaCheckboxTypedDict, + DocumentCreateFieldMetaDate, + DocumentCreateFieldMetaDateTypedDict, + DocumentCreateFieldMetaDropdown, + DocumentCreateFieldMetaDropdownTypedDict, + DocumentCreateFieldMetaEmail, + DocumentCreateFieldMetaEmailTypedDict, + DocumentCreateFieldMetaInitials, + DocumentCreateFieldMetaInitialsTypedDict, + DocumentCreateFieldMetaName, + DocumentCreateFieldMetaNameTypedDict, + DocumentCreateFieldMetaNumber, + DocumentCreateFieldMetaNumberTypedDict, + DocumentCreateFieldMetaRadio, + DocumentCreateFieldMetaRadioTypedDict, + DocumentCreateFieldMetaSignature, + DocumentCreateFieldMetaSignatureTypedDict, + DocumentCreateFieldMetaText, + DocumentCreateFieldMetaTextTypedDict, + DocumentCreateFieldName, + DocumentCreateFieldNameTypedDict, + DocumentCreateFieldNumber, + DocumentCreateFieldNumberTypedDict, + DocumentCreateFieldRadio, + DocumentCreateFieldRadioTypedDict, + DocumentCreateFieldSignature, + DocumentCreateFieldSignatureTypedDict, + DocumentCreateFieldText, + DocumentCreateFieldTextTypedDict, + DocumentCreateFieldUnion, + DocumentCreateFieldUnionTypedDict, + DocumentCreateFile, + DocumentCreateFileTypedDict, + DocumentCreateForbiddenError, + DocumentCreateForbiddenErrorData, + DocumentCreateForbiddenIssue, + DocumentCreateForbiddenIssueTypedDict, + DocumentCreateFormValues, + DocumentCreateFormValuesTypedDict, + DocumentCreateGlobalAccessAuth, + DocumentCreateGlobalActionAuth, + DocumentCreateInternalServerError, + DocumentCreateInternalServerErrorData, + DocumentCreateInternalServerErrorIssue, + DocumentCreateInternalServerErrorIssueTypedDict, + DocumentCreateLanguage, + DocumentCreateMeta, + DocumentCreateMetaTypedDict, + DocumentCreatePayload, + DocumentCreatePayloadTypedDict, + DocumentCreateRecipient, + DocumentCreateRecipientTypedDict, + DocumentCreateRequest, + DocumentCreateRequestTypedDict, + DocumentCreateResponse, + DocumentCreateResponseTypedDict, + DocumentCreateRole, + DocumentCreateSigningOrder, + DocumentCreateTextAlignDate, + DocumentCreateTextAlignEmail, + DocumentCreateTextAlignInitials, + DocumentCreateTextAlignName, + DocumentCreateTextAlignNumber, + DocumentCreateTextAlignText, + DocumentCreateTypeCheckbox1, + DocumentCreateTypeCheckbox2, + DocumentCreateTypeDate1, + DocumentCreateTypeDate2, + DocumentCreateTypeDropdown1, + DocumentCreateTypeDropdown2, + DocumentCreateTypeEmail1, + DocumentCreateTypeEmail2, + DocumentCreateTypeFreeSignature, + DocumentCreateTypeInitials1, + DocumentCreateTypeInitials2, + DocumentCreateTypeLink, + DocumentCreateTypeName1, + DocumentCreateTypeName2, + DocumentCreateTypeNumber1, + DocumentCreateTypeNumber2, + DocumentCreateTypeRadio1, + DocumentCreateTypeRadio2, + DocumentCreateTypeSignature1, + DocumentCreateTypeSignature2, + DocumentCreateTypeText1, + DocumentCreateTypeText2, + DocumentCreateUnauthorizedError, + DocumentCreateUnauthorizedErrorData, + DocumentCreateUnauthorizedIssue, + DocumentCreateUnauthorizedIssueTypedDict, + DocumentCreateValueCheckbox, + DocumentCreateValueCheckboxTypedDict, + DocumentCreateValueDropdown, + DocumentCreateValueDropdownTypedDict, + DocumentCreateValueRadio, + DocumentCreateValueRadioTypedDict, + DocumentCreateVerticalAlignNumber, + DocumentCreateVerticalAlignText, + DocumentCreateVisibility, + ) + from .document_deleteop import ( + DocumentDeleteBadRequestError, + DocumentDeleteBadRequestErrorData, + DocumentDeleteBadRequestIssue, + DocumentDeleteBadRequestIssueTypedDict, + DocumentDeleteForbiddenError, + DocumentDeleteForbiddenErrorData, + DocumentDeleteForbiddenIssue, + DocumentDeleteForbiddenIssueTypedDict, + DocumentDeleteInternalServerError, + DocumentDeleteInternalServerErrorData, + DocumentDeleteInternalServerErrorIssue, + DocumentDeleteInternalServerErrorIssueTypedDict, + DocumentDeleteRequest, + DocumentDeleteRequestTypedDict, + DocumentDeleteResponse, + DocumentDeleteResponseTypedDict, + DocumentDeleteUnauthorizedError, + DocumentDeleteUnauthorizedErrorData, + DocumentDeleteUnauthorizedIssue, + DocumentDeleteUnauthorizedIssueTypedDict, ) - 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, + DocumentDistributeForbiddenError, + DocumentDistributeForbiddenErrorData, + DocumentDistributeForbiddenIssue, + DocumentDistributeForbiddenIssueTypedDict, + DocumentDistributeFormValues, + DocumentDistributeFormValuesTypedDict, + DocumentDistributeGlobalAccessAuth, + DocumentDistributeGlobalActionAuth, + DocumentDistributeInternalServerError, + DocumentDistributeInternalServerErrorData, + DocumentDistributeInternalServerErrorIssue, + DocumentDistributeInternalServerErrorIssueTypedDict, + DocumentDistributeLanguage, + DocumentDistributeMeta, + DocumentDistributeMetaTypedDict, + DocumentDistributeRequest, + DocumentDistributeRequestTypedDict, + DocumentDistributeResponse, + DocumentDistributeResponseTypedDict, + DocumentDistributeSource, + DocumentDistributeStatus, + DocumentDistributeUnauthorizedError, + DocumentDistributeUnauthorizedErrorData, + DocumentDistributeUnauthorizedIssue, + DocumentDistributeUnauthorizedIssueTypedDict, + DocumentDistributeVisibility, ) - from .document_finddocumentsop import ( + from .document_downloadbetaop import ( + DocumentDownloadBetaBadRequestError, + DocumentDownloadBetaBadRequestErrorData, + DocumentDownloadBetaBadRequestIssue, + DocumentDownloadBetaBadRequestIssueTypedDict, + DocumentDownloadBetaForbiddenError, + DocumentDownloadBetaForbiddenErrorData, + DocumentDownloadBetaForbiddenIssue, + DocumentDownloadBetaForbiddenIssueTypedDict, + DocumentDownloadBetaInternalServerError, + DocumentDownloadBetaInternalServerErrorData, + DocumentDownloadBetaInternalServerErrorIssue, + DocumentDownloadBetaInternalServerErrorIssueTypedDict, + DocumentDownloadBetaNotFoundError, + DocumentDownloadBetaNotFoundErrorData, + DocumentDownloadBetaNotFoundIssue, + DocumentDownloadBetaNotFoundIssueTypedDict, + DocumentDownloadBetaRequest, + DocumentDownloadBetaRequestTypedDict, + DocumentDownloadBetaResponse, + DocumentDownloadBetaResponseTypedDict, + DocumentDownloadBetaUnauthorizedError, + DocumentDownloadBetaUnauthorizedErrorData, + DocumentDownloadBetaUnauthorizedIssue, + DocumentDownloadBetaUnauthorizedIssueTypedDict, + DocumentDownloadBetaVersion, + ) + from .document_downloadop import ( + DocumentDownloadBadRequestError, + DocumentDownloadBadRequestErrorData, + DocumentDownloadBadRequestIssue, + DocumentDownloadBadRequestIssueTypedDict, + DocumentDownloadForbiddenError, + DocumentDownloadForbiddenErrorData, + DocumentDownloadForbiddenIssue, + DocumentDownloadForbiddenIssueTypedDict, + DocumentDownloadInternalServerError, + DocumentDownloadInternalServerErrorData, + DocumentDownloadInternalServerErrorIssue, + DocumentDownloadInternalServerErrorIssueTypedDict, + DocumentDownloadNotFoundError, + DocumentDownloadNotFoundErrorData, + DocumentDownloadNotFoundIssue, + DocumentDownloadNotFoundIssueTypedDict, + DocumentDownloadRequest, + DocumentDownloadRequestTypedDict, + DocumentDownloadResponse, + DocumentDownloadResponseTypedDict, + DocumentDownloadUnauthorizedError, + DocumentDownloadUnauthorizedErrorData, + DocumentDownloadUnauthorizedIssue, + DocumentDownloadUnauthorizedIssueTypedDict, + DocumentDownloadVersion, + ) + from .document_duplicateop import ( + DocumentDuplicateBadRequestError, + DocumentDuplicateBadRequestErrorData, + DocumentDuplicateBadRequestIssue, + DocumentDuplicateBadRequestIssueTypedDict, + DocumentDuplicateForbiddenError, + DocumentDuplicateForbiddenErrorData, + DocumentDuplicateForbiddenIssue, + DocumentDuplicateForbiddenIssueTypedDict, + DocumentDuplicateInternalServerError, + DocumentDuplicateInternalServerErrorData, + DocumentDuplicateInternalServerErrorIssue, + DocumentDuplicateInternalServerErrorIssueTypedDict, + DocumentDuplicateRequest, + DocumentDuplicateRequestTypedDict, + DocumentDuplicateResponse, + DocumentDuplicateResponseTypedDict, + DocumentDuplicateUnauthorizedError, + DocumentDuplicateUnauthorizedErrorData, + DocumentDuplicateUnauthorizedIssue, + DocumentDuplicateUnauthorizedIssueTypedDict, + ) + 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, + DocumentFindForbiddenError, + DocumentFindForbiddenErrorData, + DocumentFindForbiddenIssue, + DocumentFindForbiddenIssueTypedDict, + 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, + DocumentFindUnauthorizedError, + DocumentFindUnauthorizedErrorData, + DocumentFindUnauthorizedIssue, + DocumentFindUnauthorizedIssueTypedDict, + 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, + DocumentGetDirection1, + DocumentGetDirection2, + DocumentGetDistributionMethod, + DocumentGetDocumentData, + DocumentGetDocumentDataType, + DocumentGetDocumentDataTypedDict, + DocumentGetDocumentMeta, + DocumentGetDocumentMetaTypedDict, + DocumentGetEmailSettings, + DocumentGetEmailSettingsTypedDict, + DocumentGetEnvelopeItem, + DocumentGetEnvelopeItemTypedDict, + DocumentGetField, + DocumentGetFieldMetaCheckbox, + DocumentGetFieldMetaCheckboxTypedDict, + DocumentGetFieldMetaDate, + DocumentGetFieldMetaDateTypedDict, + DocumentGetFieldMetaDropdown, + DocumentGetFieldMetaDropdownTypedDict, + DocumentGetFieldMetaEmail, + DocumentGetFieldMetaEmailTypedDict, + DocumentGetFieldMetaInitials, + DocumentGetFieldMetaInitialsTypedDict, + DocumentGetFieldMetaName, + DocumentGetFieldMetaNameTypedDict, + DocumentGetFieldMetaNumber, + DocumentGetFieldMetaNumberTypedDict, + DocumentGetFieldMetaRadio, + DocumentGetFieldMetaRadioTypedDict, + DocumentGetFieldMetaSignature, + DocumentGetFieldMetaSignatureTypedDict, + DocumentGetFieldMetaText, + DocumentGetFieldMetaTextTypedDict, + DocumentGetFieldMetaUnion, + DocumentGetFieldMetaUnionTypedDict, + DocumentGetFieldType, + DocumentGetFieldTypedDict, + DocumentGetFolder, + DocumentGetFolderType, + DocumentGetFolderTypedDict, + DocumentGetFolderVisibility, + DocumentGetForbiddenError, + DocumentGetForbiddenErrorData, + DocumentGetForbiddenIssue, + DocumentGetForbiddenIssueTypedDict, + 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, + DocumentGetTypeSignature, + DocumentGetTypeText, + DocumentGetUnauthorizedError, + DocumentGetUnauthorizedErrorData, + DocumentGetUnauthorizedIssue, + DocumentGetUnauthorizedIssueTypedDict, + DocumentGetValue1, + DocumentGetValue1TypedDict, + DocumentGetValue2, + DocumentGetValue2TypedDict, + DocumentGetValue3, + DocumentGetValue3TypedDict, + DocumentGetVerticalAlign1, + DocumentGetVerticalAlign2, + 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, + DocumentRedistributeForbiddenError, + DocumentRedistributeForbiddenErrorData, + DocumentRedistributeForbiddenIssue, + DocumentRedistributeForbiddenIssueTypedDict, + DocumentRedistributeInternalServerError, + DocumentRedistributeInternalServerErrorData, + DocumentRedistributeInternalServerErrorIssue, + DocumentRedistributeInternalServerErrorIssueTypedDict, + DocumentRedistributeRequest, + DocumentRedistributeRequestTypedDict, + DocumentRedistributeResponse, + DocumentRedistributeResponseTypedDict, + DocumentRedistributeUnauthorizedError, + DocumentRedistributeUnauthorizedErrorData, + DocumentRedistributeUnauthorizedIssue, + DocumentRedistributeUnauthorizedIssueTypedDict, ) - 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, + DocumentUpdateDataGlobalAccessAuth, + DocumentUpdateDataGlobalActionAuth, + DocumentUpdateDataTypedDict, + DocumentUpdateDataVisibility, + DocumentUpdateDateFormat, + DocumentUpdateDistributionMethod, + DocumentUpdateEmailSettings, + DocumentUpdateEmailSettingsTypedDict, + DocumentUpdateForbiddenError, + DocumentUpdateForbiddenErrorData, + DocumentUpdateForbiddenIssue, + DocumentUpdateForbiddenIssueTypedDict, + DocumentUpdateFormValues, + DocumentUpdateFormValuesTypedDict, + DocumentUpdateGlobalAccessAuthResponse, + DocumentUpdateGlobalActionAuthResponse, + DocumentUpdateInternalServerError, + DocumentUpdateInternalServerErrorData, + DocumentUpdateInternalServerErrorIssue, + DocumentUpdateInternalServerErrorIssueTypedDict, + DocumentUpdateLanguage, + DocumentUpdateMeta, + DocumentUpdateMetaTypedDict, + DocumentUpdateRequest, + DocumentUpdateRequestTypedDict, + DocumentUpdateResponse, + DocumentUpdateResponseTypedDict, + DocumentUpdateSigningOrder, + DocumentUpdateSource, + DocumentUpdateStatus, + DocumentUpdateUnauthorizedError, + DocumentUpdateUnauthorizedErrorData, + DocumentUpdateUnauthorizedIssue, + DocumentUpdateUnauthorizedIssueTypedDict, + DocumentUpdateVisibilityResponse, ) from .embeddingpresign_createembeddingpresigntokenop import ( EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError, EmbeddingPresignCreateEmbeddingPresignTokenBadRequestErrorData, EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue, EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssueTypedDict, + EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError, + EmbeddingPresignCreateEmbeddingPresignTokenForbiddenErrorData, + EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssue, + EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssueTypedDict, EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError, EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData, EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue, @@ -454,12 +831,20 @@ EmbeddingPresignCreateEmbeddingPresignTokenRequestTypedDict, EmbeddingPresignCreateEmbeddingPresignTokenResponse, EmbeddingPresignCreateEmbeddingPresignTokenResponseTypedDict, + EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError, + EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedErrorData, + EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssue, + EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssueTypedDict, ) from .embeddingpresign_verifyembeddingpresigntokenop import ( EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError, EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestErrorData, EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue, EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssueTypedDict, + EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError, + EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenErrorData, + EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssue, + EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssueTypedDict, EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError, EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData, EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue, @@ -468,12 +853,1274 @@ EmbeddingPresignVerifyEmbeddingPresignTokenRequestTypedDict, EmbeddingPresignVerifyEmbeddingPresignTokenResponse, EmbeddingPresignVerifyEmbeddingPresignTokenResponseTypedDict, + EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError, + EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedErrorData, + EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssue, + EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssueTypedDict, + ) + from .envelope_attachment_createop import ( + EnvelopeAttachmentCreateBadRequestError, + EnvelopeAttachmentCreateBadRequestErrorData, + EnvelopeAttachmentCreateBadRequestIssue, + EnvelopeAttachmentCreateBadRequestIssueTypedDict, + EnvelopeAttachmentCreateData, + EnvelopeAttachmentCreateDataTypedDict, + EnvelopeAttachmentCreateForbiddenError, + EnvelopeAttachmentCreateForbiddenErrorData, + EnvelopeAttachmentCreateForbiddenIssue, + EnvelopeAttachmentCreateForbiddenIssueTypedDict, + EnvelopeAttachmentCreateInternalServerError, + EnvelopeAttachmentCreateInternalServerErrorData, + EnvelopeAttachmentCreateInternalServerErrorIssue, + EnvelopeAttachmentCreateInternalServerErrorIssueTypedDict, + EnvelopeAttachmentCreateRequest, + EnvelopeAttachmentCreateRequestTypedDict, + EnvelopeAttachmentCreateResponse, + EnvelopeAttachmentCreateResponseTypedDict, + EnvelopeAttachmentCreateUnauthorizedError, + EnvelopeAttachmentCreateUnauthorizedErrorData, + EnvelopeAttachmentCreateUnauthorizedIssue, + EnvelopeAttachmentCreateUnauthorizedIssueTypedDict, + ) + from .envelope_attachment_deleteop import ( + EnvelopeAttachmentDeleteBadRequestError, + EnvelopeAttachmentDeleteBadRequestErrorData, + EnvelopeAttachmentDeleteBadRequestIssue, + EnvelopeAttachmentDeleteBadRequestIssueTypedDict, + EnvelopeAttachmentDeleteForbiddenError, + EnvelopeAttachmentDeleteForbiddenErrorData, + EnvelopeAttachmentDeleteForbiddenIssue, + EnvelopeAttachmentDeleteForbiddenIssueTypedDict, + EnvelopeAttachmentDeleteInternalServerError, + EnvelopeAttachmentDeleteInternalServerErrorData, + EnvelopeAttachmentDeleteInternalServerErrorIssue, + EnvelopeAttachmentDeleteInternalServerErrorIssueTypedDict, + EnvelopeAttachmentDeleteRequest, + EnvelopeAttachmentDeleteRequestTypedDict, + EnvelopeAttachmentDeleteResponse, + EnvelopeAttachmentDeleteResponseTypedDict, + EnvelopeAttachmentDeleteUnauthorizedError, + EnvelopeAttachmentDeleteUnauthorizedErrorData, + EnvelopeAttachmentDeleteUnauthorizedIssue, + EnvelopeAttachmentDeleteUnauthorizedIssueTypedDict, + ) + from .envelope_attachment_findop import ( + EnvelopeAttachmentFindBadRequestError, + EnvelopeAttachmentFindBadRequestErrorData, + EnvelopeAttachmentFindBadRequestIssue, + EnvelopeAttachmentFindBadRequestIssueTypedDict, + EnvelopeAttachmentFindData, + EnvelopeAttachmentFindDataTypedDict, + EnvelopeAttachmentFindForbiddenError, + EnvelopeAttachmentFindForbiddenErrorData, + EnvelopeAttachmentFindForbiddenIssue, + EnvelopeAttachmentFindForbiddenIssueTypedDict, + EnvelopeAttachmentFindInternalServerError, + EnvelopeAttachmentFindInternalServerErrorData, + EnvelopeAttachmentFindInternalServerErrorIssue, + EnvelopeAttachmentFindInternalServerErrorIssueTypedDict, + EnvelopeAttachmentFindNotFoundError, + EnvelopeAttachmentFindNotFoundErrorData, + EnvelopeAttachmentFindNotFoundIssue, + EnvelopeAttachmentFindNotFoundIssueTypedDict, + EnvelopeAttachmentFindRequest, + EnvelopeAttachmentFindRequestTypedDict, + EnvelopeAttachmentFindResponse, + EnvelopeAttachmentFindResponseTypedDict, + EnvelopeAttachmentFindType, + EnvelopeAttachmentFindUnauthorizedError, + EnvelopeAttachmentFindUnauthorizedErrorData, + EnvelopeAttachmentFindUnauthorizedIssue, + EnvelopeAttachmentFindUnauthorizedIssueTypedDict, + ) + from .envelope_attachment_updateop import ( + EnvelopeAttachmentUpdateBadRequestError, + EnvelopeAttachmentUpdateBadRequestErrorData, + EnvelopeAttachmentUpdateBadRequestIssue, + EnvelopeAttachmentUpdateBadRequestIssueTypedDict, + EnvelopeAttachmentUpdateData, + EnvelopeAttachmentUpdateDataTypedDict, + EnvelopeAttachmentUpdateForbiddenError, + EnvelopeAttachmentUpdateForbiddenErrorData, + EnvelopeAttachmentUpdateForbiddenIssue, + EnvelopeAttachmentUpdateForbiddenIssueTypedDict, + EnvelopeAttachmentUpdateInternalServerError, + EnvelopeAttachmentUpdateInternalServerErrorData, + EnvelopeAttachmentUpdateInternalServerErrorIssue, + EnvelopeAttachmentUpdateInternalServerErrorIssueTypedDict, + EnvelopeAttachmentUpdateRequest, + EnvelopeAttachmentUpdateRequestTypedDict, + EnvelopeAttachmentUpdateResponse, + EnvelopeAttachmentUpdateResponseTypedDict, + EnvelopeAttachmentUpdateUnauthorizedError, + EnvelopeAttachmentUpdateUnauthorizedErrorData, + EnvelopeAttachmentUpdateUnauthorizedIssue, + EnvelopeAttachmentUpdateUnauthorizedIssueTypedDict, + ) + from .envelope_createop import ( + EnvelopeCreateAccessAuth, + EnvelopeCreateActionAuth, + EnvelopeCreateAttachment, + EnvelopeCreateAttachmentTypedDict, + EnvelopeCreateBadRequestError, + EnvelopeCreateBadRequestErrorData, + EnvelopeCreateBadRequestIssue, + EnvelopeCreateBadRequestIssueTypedDict, + EnvelopeCreateDateFormat, + EnvelopeCreateDirectionCheckbox, + EnvelopeCreateDirectionRadio, + EnvelopeCreateDistributionMethod, + EnvelopeCreateEmailSettings, + EnvelopeCreateEmailSettingsTypedDict, + EnvelopeCreateFieldCheckbox, + EnvelopeCreateFieldCheckboxTypedDict, + EnvelopeCreateFieldDate, + EnvelopeCreateFieldDateTypedDict, + EnvelopeCreateFieldDropdown, + EnvelopeCreateFieldDropdownTypedDict, + EnvelopeCreateFieldEmail, + EnvelopeCreateFieldEmailTypedDict, + EnvelopeCreateFieldFreeSignature, + EnvelopeCreateFieldFreeSignatureTypedDict, + EnvelopeCreateFieldInitials, + EnvelopeCreateFieldInitialsTypedDict, + EnvelopeCreateFieldMetaCheckbox, + EnvelopeCreateFieldMetaCheckboxTypedDict, + EnvelopeCreateFieldMetaDate, + EnvelopeCreateFieldMetaDateTypedDict, + EnvelopeCreateFieldMetaDropdown, + EnvelopeCreateFieldMetaDropdownTypedDict, + EnvelopeCreateFieldMetaEmail, + EnvelopeCreateFieldMetaEmailTypedDict, + EnvelopeCreateFieldMetaInitials, + EnvelopeCreateFieldMetaInitialsTypedDict, + EnvelopeCreateFieldMetaName, + EnvelopeCreateFieldMetaNameTypedDict, + EnvelopeCreateFieldMetaNumber, + EnvelopeCreateFieldMetaNumberTypedDict, + EnvelopeCreateFieldMetaRadio, + EnvelopeCreateFieldMetaRadioTypedDict, + EnvelopeCreateFieldMetaSignature, + EnvelopeCreateFieldMetaSignatureTypedDict, + EnvelopeCreateFieldMetaText, + EnvelopeCreateFieldMetaTextTypedDict, + EnvelopeCreateFieldName, + EnvelopeCreateFieldNameTypedDict, + EnvelopeCreateFieldNumber, + EnvelopeCreateFieldNumberTypedDict, + EnvelopeCreateFieldRadio, + EnvelopeCreateFieldRadioTypedDict, + EnvelopeCreateFieldSignature, + EnvelopeCreateFieldSignatureTypedDict, + EnvelopeCreateFieldText, + EnvelopeCreateFieldTextTypedDict, + EnvelopeCreateFieldUnion, + EnvelopeCreateFieldUnionTypedDict, + EnvelopeCreateFile, + EnvelopeCreateFileTypedDict, + EnvelopeCreateForbiddenError, + EnvelopeCreateForbiddenErrorData, + EnvelopeCreateForbiddenIssue, + EnvelopeCreateForbiddenIssueTypedDict, + EnvelopeCreateFormValues, + EnvelopeCreateFormValuesTypedDict, + EnvelopeCreateGlobalAccessAuth, + EnvelopeCreateGlobalActionAuth, + EnvelopeCreateIdentifier1, + EnvelopeCreateIdentifier10, + EnvelopeCreateIdentifier10TypedDict, + EnvelopeCreateIdentifier11, + EnvelopeCreateIdentifier11TypedDict, + EnvelopeCreateIdentifier1TypedDict, + EnvelopeCreateIdentifier2, + EnvelopeCreateIdentifier2TypedDict, + EnvelopeCreateIdentifier3, + EnvelopeCreateIdentifier3TypedDict, + EnvelopeCreateIdentifier4, + EnvelopeCreateIdentifier4TypedDict, + EnvelopeCreateIdentifier5, + EnvelopeCreateIdentifier5TypedDict, + EnvelopeCreateIdentifier6, + EnvelopeCreateIdentifier6TypedDict, + EnvelopeCreateIdentifier7, + EnvelopeCreateIdentifier7TypedDict, + EnvelopeCreateIdentifier8, + EnvelopeCreateIdentifier8TypedDict, + EnvelopeCreateIdentifier9, + EnvelopeCreateIdentifier9TypedDict, + EnvelopeCreateInternalServerError, + EnvelopeCreateInternalServerErrorData, + EnvelopeCreateInternalServerErrorIssue, + EnvelopeCreateInternalServerErrorIssueTypedDict, + EnvelopeCreateLanguage, + EnvelopeCreateMeta, + EnvelopeCreateMetaTypedDict, + EnvelopeCreatePayload, + EnvelopeCreatePayloadTypedDict, + EnvelopeCreateRecipient, + EnvelopeCreateRecipientTypedDict, + EnvelopeCreateRequest, + EnvelopeCreateRequestTypedDict, + EnvelopeCreateResponse, + EnvelopeCreateResponseTypedDict, + EnvelopeCreateRole, + EnvelopeCreateSigningOrder, + EnvelopeCreateTextAlignDate, + EnvelopeCreateTextAlignEmail, + EnvelopeCreateTextAlignInitials, + EnvelopeCreateTextAlignName, + EnvelopeCreateTextAlignNumber, + EnvelopeCreateTextAlignText, + EnvelopeCreateType, + EnvelopeCreateTypeCheckbox1, + EnvelopeCreateTypeCheckbox2, + EnvelopeCreateTypeDate1, + EnvelopeCreateTypeDate2, + EnvelopeCreateTypeDropdown1, + EnvelopeCreateTypeDropdown2, + EnvelopeCreateTypeEmail1, + EnvelopeCreateTypeEmail2, + EnvelopeCreateTypeFreeSignature, + EnvelopeCreateTypeInitials1, + EnvelopeCreateTypeInitials2, + EnvelopeCreateTypeLink, + EnvelopeCreateTypeName1, + EnvelopeCreateTypeName2, + EnvelopeCreateTypeNumber1, + EnvelopeCreateTypeNumber2, + EnvelopeCreateTypeRadio1, + EnvelopeCreateTypeRadio2, + EnvelopeCreateTypeSignature1, + EnvelopeCreateTypeSignature2, + EnvelopeCreateTypeText1, + EnvelopeCreateTypeText2, + EnvelopeCreateUnauthorizedError, + EnvelopeCreateUnauthorizedErrorData, + EnvelopeCreateUnauthorizedIssue, + EnvelopeCreateUnauthorizedIssueTypedDict, + EnvelopeCreateValueCheckbox, + EnvelopeCreateValueCheckboxTypedDict, + EnvelopeCreateValueDropdown, + EnvelopeCreateValueDropdownTypedDict, + EnvelopeCreateValueRadio, + EnvelopeCreateValueRadioTypedDict, + EnvelopeCreateVerticalAlignNumber, + EnvelopeCreateVerticalAlignText, + EnvelopeCreateVisibility, + ) + from .envelope_deleteop import ( + EnvelopeDeleteBadRequestError, + EnvelopeDeleteBadRequestErrorData, + EnvelopeDeleteBadRequestIssue, + EnvelopeDeleteBadRequestIssueTypedDict, + EnvelopeDeleteForbiddenError, + EnvelopeDeleteForbiddenErrorData, + EnvelopeDeleteForbiddenIssue, + EnvelopeDeleteForbiddenIssueTypedDict, + EnvelopeDeleteInternalServerError, + EnvelopeDeleteInternalServerErrorData, + EnvelopeDeleteInternalServerErrorIssue, + EnvelopeDeleteInternalServerErrorIssueTypedDict, + EnvelopeDeleteRequest, + EnvelopeDeleteRequestTypedDict, + EnvelopeDeleteResponse, + EnvelopeDeleteResponseTypedDict, + EnvelopeDeleteUnauthorizedError, + EnvelopeDeleteUnauthorizedErrorData, + EnvelopeDeleteUnauthorizedIssue, + EnvelopeDeleteUnauthorizedIssueTypedDict, + ) + from .envelope_distributeop import ( + EnvelopeDistributeBadRequestError, + EnvelopeDistributeBadRequestErrorData, + EnvelopeDistributeBadRequestIssue, + EnvelopeDistributeBadRequestIssueTypedDict, + EnvelopeDistributeDateFormat, + EnvelopeDistributeDistributionMethod, + EnvelopeDistributeEmailSettings, + EnvelopeDistributeEmailSettingsTypedDict, + EnvelopeDistributeForbiddenError, + EnvelopeDistributeForbiddenErrorData, + EnvelopeDistributeForbiddenIssue, + EnvelopeDistributeForbiddenIssueTypedDict, + EnvelopeDistributeInternalServerError, + EnvelopeDistributeInternalServerErrorData, + EnvelopeDistributeInternalServerErrorIssue, + EnvelopeDistributeInternalServerErrorIssueTypedDict, + EnvelopeDistributeLanguage, + EnvelopeDistributeMeta, + EnvelopeDistributeMetaTypedDict, + EnvelopeDistributeRequest, + EnvelopeDistributeRequestTypedDict, + EnvelopeDistributeResponse, + EnvelopeDistributeResponseTypedDict, + EnvelopeDistributeUnauthorizedError, + EnvelopeDistributeUnauthorizedErrorData, + EnvelopeDistributeUnauthorizedIssue, + EnvelopeDistributeUnauthorizedIssueTypedDict, + ) + from .envelope_duplicateop import ( + EnvelopeDuplicateBadRequestError, + EnvelopeDuplicateBadRequestErrorData, + EnvelopeDuplicateBadRequestIssue, + EnvelopeDuplicateBadRequestIssueTypedDict, + EnvelopeDuplicateForbiddenError, + EnvelopeDuplicateForbiddenErrorData, + EnvelopeDuplicateForbiddenIssue, + EnvelopeDuplicateForbiddenIssueTypedDict, + EnvelopeDuplicateInternalServerError, + EnvelopeDuplicateInternalServerErrorData, + EnvelopeDuplicateInternalServerErrorIssue, + EnvelopeDuplicateInternalServerErrorIssueTypedDict, + EnvelopeDuplicateRequest, + EnvelopeDuplicateRequestTypedDict, + EnvelopeDuplicateResponse, + EnvelopeDuplicateResponseTypedDict, + EnvelopeDuplicateUnauthorizedError, + EnvelopeDuplicateUnauthorizedErrorData, + EnvelopeDuplicateUnauthorizedIssue, + EnvelopeDuplicateUnauthorizedIssueTypedDict, + ) + from .envelope_field_createmanyop import ( + EnvelopeFieldCreateManyBadRequestError, + EnvelopeFieldCreateManyBadRequestErrorData, + EnvelopeFieldCreateManyBadRequestIssue, + EnvelopeFieldCreateManyBadRequestIssueTypedDict, + EnvelopeFieldCreateManyDataCheckbox, + EnvelopeFieldCreateManyDataCheckboxTypedDict, + EnvelopeFieldCreateManyDataDate, + EnvelopeFieldCreateManyDataDateTypedDict, + EnvelopeFieldCreateManyDataDropdown, + EnvelopeFieldCreateManyDataDropdownTypedDict, + EnvelopeFieldCreateManyDataEmail, + EnvelopeFieldCreateManyDataEmailTypedDict, + EnvelopeFieldCreateManyDataFreeSignature, + EnvelopeFieldCreateManyDataFreeSignatureTypedDict, + EnvelopeFieldCreateManyDataInitials, + EnvelopeFieldCreateManyDataInitialsTypedDict, + EnvelopeFieldCreateManyDataName, + EnvelopeFieldCreateManyDataNameTypedDict, + EnvelopeFieldCreateManyDataNumber, + EnvelopeFieldCreateManyDataNumberTypedDict, + EnvelopeFieldCreateManyDataRadio, + EnvelopeFieldCreateManyDataRadioTypedDict, + EnvelopeFieldCreateManyDataResponse, + EnvelopeFieldCreateManyDataResponseTypedDict, + EnvelopeFieldCreateManyDataSignature, + EnvelopeFieldCreateManyDataSignatureTypedDict, + EnvelopeFieldCreateManyDataText, + EnvelopeFieldCreateManyDataTextTypedDict, + EnvelopeFieldCreateManyDataUnion, + EnvelopeFieldCreateManyDataUnionTypedDict, + EnvelopeFieldCreateManyDirectionCheckbox, + EnvelopeFieldCreateManyDirectionRadio, + EnvelopeFieldCreateManyDirectionResponse1, + EnvelopeFieldCreateManyDirectionResponse2, + EnvelopeFieldCreateManyFieldMetaCheckboxRequest, + EnvelopeFieldCreateManyFieldMetaCheckboxRequestTypedDict, + EnvelopeFieldCreateManyFieldMetaCheckboxResponse, + EnvelopeFieldCreateManyFieldMetaCheckboxResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaDateRequest, + EnvelopeFieldCreateManyFieldMetaDateRequestTypedDict, + EnvelopeFieldCreateManyFieldMetaDateResponse, + EnvelopeFieldCreateManyFieldMetaDateResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaDropdownRequest, + EnvelopeFieldCreateManyFieldMetaDropdownRequestTypedDict, + EnvelopeFieldCreateManyFieldMetaDropdownResponse, + EnvelopeFieldCreateManyFieldMetaDropdownResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaEmailRequest, + EnvelopeFieldCreateManyFieldMetaEmailRequestTypedDict, + EnvelopeFieldCreateManyFieldMetaEmailResponse, + EnvelopeFieldCreateManyFieldMetaEmailResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaInitialsRequest, + EnvelopeFieldCreateManyFieldMetaInitialsRequestTypedDict, + EnvelopeFieldCreateManyFieldMetaInitialsResponse, + EnvelopeFieldCreateManyFieldMetaInitialsResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaNameRequest, + EnvelopeFieldCreateManyFieldMetaNameRequestTypedDict, + EnvelopeFieldCreateManyFieldMetaNameResponse, + EnvelopeFieldCreateManyFieldMetaNameResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaNumberRequest, + EnvelopeFieldCreateManyFieldMetaNumberRequestTypedDict, + EnvelopeFieldCreateManyFieldMetaNumberResponse, + EnvelopeFieldCreateManyFieldMetaNumberResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaRadioRequest, + EnvelopeFieldCreateManyFieldMetaRadioRequestTypedDict, + EnvelopeFieldCreateManyFieldMetaRadioResponse, + EnvelopeFieldCreateManyFieldMetaRadioResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaSignatureRequest, + EnvelopeFieldCreateManyFieldMetaSignatureRequestTypedDict, + EnvelopeFieldCreateManyFieldMetaSignatureResponse, + EnvelopeFieldCreateManyFieldMetaSignatureResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaTextRequest, + EnvelopeFieldCreateManyFieldMetaTextRequestTypedDict, + EnvelopeFieldCreateManyFieldMetaTextResponse, + EnvelopeFieldCreateManyFieldMetaTextResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaTypeCheckbox, + EnvelopeFieldCreateManyFieldMetaTypeDate, + EnvelopeFieldCreateManyFieldMetaTypeDropdown, + EnvelopeFieldCreateManyFieldMetaTypeEmail, + EnvelopeFieldCreateManyFieldMetaTypeInitials, + EnvelopeFieldCreateManyFieldMetaTypeName, + EnvelopeFieldCreateManyFieldMetaTypeNumber, + EnvelopeFieldCreateManyFieldMetaTypeRadio, + EnvelopeFieldCreateManyFieldMetaTypeSignature, + EnvelopeFieldCreateManyFieldMetaTypeText, + EnvelopeFieldCreateManyFieldMetaUnion, + EnvelopeFieldCreateManyFieldMetaUnionTypedDict, + EnvelopeFieldCreateManyForbiddenError, + EnvelopeFieldCreateManyForbiddenErrorData, + EnvelopeFieldCreateManyForbiddenIssue, + EnvelopeFieldCreateManyForbiddenIssueTypedDict, + EnvelopeFieldCreateManyInternalServerError, + EnvelopeFieldCreateManyInternalServerErrorData, + EnvelopeFieldCreateManyInternalServerErrorIssue, + EnvelopeFieldCreateManyInternalServerErrorIssueTypedDict, + EnvelopeFieldCreateManyRequest, + EnvelopeFieldCreateManyRequestTypedDict, + EnvelopeFieldCreateManyResponse, + EnvelopeFieldCreateManyResponseTypedDict, + EnvelopeFieldCreateManyTextAlignDate, + EnvelopeFieldCreateManyTextAlignEmail, + EnvelopeFieldCreateManyTextAlignInitials, + EnvelopeFieldCreateManyTextAlignName, + EnvelopeFieldCreateManyTextAlignNumber, + EnvelopeFieldCreateManyTextAlignResponse1, + EnvelopeFieldCreateManyTextAlignResponse2, + EnvelopeFieldCreateManyTextAlignResponse3, + EnvelopeFieldCreateManyTextAlignResponse4, + EnvelopeFieldCreateManyTextAlignResponse5, + EnvelopeFieldCreateManyTextAlignResponse6, + EnvelopeFieldCreateManyTextAlignText, + EnvelopeFieldCreateManyTypeCheckboxRequest1, + EnvelopeFieldCreateManyTypeCheckboxRequest2, + EnvelopeFieldCreateManyTypeDateRequest1, + EnvelopeFieldCreateManyTypeDateRequest2, + EnvelopeFieldCreateManyTypeDropdownRequest1, + EnvelopeFieldCreateManyTypeDropdownRequest2, + EnvelopeFieldCreateManyTypeEmailRequest1, + EnvelopeFieldCreateManyTypeEmailRequest2, + EnvelopeFieldCreateManyTypeFreeSignature, + EnvelopeFieldCreateManyTypeInitialsRequest1, + EnvelopeFieldCreateManyTypeInitialsRequest2, + EnvelopeFieldCreateManyTypeNameRequest1, + EnvelopeFieldCreateManyTypeNameRequest2, + EnvelopeFieldCreateManyTypeNumberRequest1, + EnvelopeFieldCreateManyTypeNumberRequest2, + EnvelopeFieldCreateManyTypeRadioRequest1, + EnvelopeFieldCreateManyTypeRadioRequest2, + EnvelopeFieldCreateManyTypeResponse, + EnvelopeFieldCreateManyTypeSignatureRequest1, + EnvelopeFieldCreateManyTypeSignatureRequest2, + EnvelopeFieldCreateManyTypeTextRequest1, + EnvelopeFieldCreateManyTypeTextRequest2, + EnvelopeFieldCreateManyUnauthorizedError, + EnvelopeFieldCreateManyUnauthorizedErrorData, + EnvelopeFieldCreateManyUnauthorizedIssue, + EnvelopeFieldCreateManyUnauthorizedIssueTypedDict, + EnvelopeFieldCreateManyValueCheckbox, + EnvelopeFieldCreateManyValueCheckboxTypedDict, + EnvelopeFieldCreateManyValueDropdown, + EnvelopeFieldCreateManyValueDropdownTypedDict, + EnvelopeFieldCreateManyValueRadio, + EnvelopeFieldCreateManyValueRadioTypedDict, + EnvelopeFieldCreateManyValueResponse1, + EnvelopeFieldCreateManyValueResponse1TypedDict, + EnvelopeFieldCreateManyValueResponse2, + EnvelopeFieldCreateManyValueResponse2TypedDict, + EnvelopeFieldCreateManyValueResponse3, + EnvelopeFieldCreateManyValueResponse3TypedDict, + EnvelopeFieldCreateManyVerticalAlignNumber, + EnvelopeFieldCreateManyVerticalAlignResponse1, + EnvelopeFieldCreateManyVerticalAlignResponse2, + EnvelopeFieldCreateManyVerticalAlignText, + ) + from .envelope_field_deleteop import ( + EnvelopeFieldDeleteBadRequestError, + EnvelopeFieldDeleteBadRequestErrorData, + EnvelopeFieldDeleteBadRequestIssue, + EnvelopeFieldDeleteBadRequestIssueTypedDict, + EnvelopeFieldDeleteForbiddenError, + EnvelopeFieldDeleteForbiddenErrorData, + EnvelopeFieldDeleteForbiddenIssue, + EnvelopeFieldDeleteForbiddenIssueTypedDict, + EnvelopeFieldDeleteInternalServerError, + EnvelopeFieldDeleteInternalServerErrorData, + EnvelopeFieldDeleteInternalServerErrorIssue, + EnvelopeFieldDeleteInternalServerErrorIssueTypedDict, + EnvelopeFieldDeleteRequest, + EnvelopeFieldDeleteRequestTypedDict, + EnvelopeFieldDeleteResponse, + EnvelopeFieldDeleteResponseTypedDict, + EnvelopeFieldDeleteUnauthorizedError, + EnvelopeFieldDeleteUnauthorizedErrorData, + EnvelopeFieldDeleteUnauthorizedIssue, + EnvelopeFieldDeleteUnauthorizedIssueTypedDict, + ) + from .envelope_field_getop import ( + EnvelopeFieldGetBadRequestError, + EnvelopeFieldGetBadRequestErrorData, + EnvelopeFieldGetBadRequestIssue, + EnvelopeFieldGetBadRequestIssueTypedDict, + EnvelopeFieldGetDirection1, + EnvelopeFieldGetDirection2, + EnvelopeFieldGetFieldMetaCheckbox, + EnvelopeFieldGetFieldMetaCheckboxTypedDict, + EnvelopeFieldGetFieldMetaDate, + EnvelopeFieldGetFieldMetaDateTypedDict, + EnvelopeFieldGetFieldMetaDropdown, + EnvelopeFieldGetFieldMetaDropdownTypedDict, + EnvelopeFieldGetFieldMetaEmail, + EnvelopeFieldGetFieldMetaEmailTypedDict, + EnvelopeFieldGetFieldMetaInitials, + EnvelopeFieldGetFieldMetaInitialsTypedDict, + EnvelopeFieldGetFieldMetaName, + EnvelopeFieldGetFieldMetaNameTypedDict, + EnvelopeFieldGetFieldMetaNumber, + EnvelopeFieldGetFieldMetaNumberTypedDict, + EnvelopeFieldGetFieldMetaRadio, + EnvelopeFieldGetFieldMetaRadioTypedDict, + EnvelopeFieldGetFieldMetaSignature, + EnvelopeFieldGetFieldMetaSignatureTypedDict, + EnvelopeFieldGetFieldMetaText, + EnvelopeFieldGetFieldMetaTextTypedDict, + EnvelopeFieldGetFieldMetaUnion, + EnvelopeFieldGetFieldMetaUnionTypedDict, + EnvelopeFieldGetForbiddenError, + EnvelopeFieldGetForbiddenErrorData, + EnvelopeFieldGetForbiddenIssue, + EnvelopeFieldGetForbiddenIssueTypedDict, + EnvelopeFieldGetInternalServerError, + EnvelopeFieldGetInternalServerErrorData, + EnvelopeFieldGetInternalServerErrorIssue, + EnvelopeFieldGetInternalServerErrorIssueTypedDict, + EnvelopeFieldGetNotFoundError, + EnvelopeFieldGetNotFoundErrorData, + EnvelopeFieldGetNotFoundIssue, + EnvelopeFieldGetNotFoundIssueTypedDict, + EnvelopeFieldGetRequest, + EnvelopeFieldGetRequestTypedDict, + EnvelopeFieldGetResponse, + EnvelopeFieldGetResponseTypedDict, + EnvelopeFieldGetTextAlign1, + EnvelopeFieldGetTextAlign2, + EnvelopeFieldGetTextAlign3, + EnvelopeFieldGetTextAlign4, + EnvelopeFieldGetTextAlign5, + EnvelopeFieldGetTextAlign6, + EnvelopeFieldGetType, + EnvelopeFieldGetTypeCheckbox, + EnvelopeFieldGetTypeDate, + EnvelopeFieldGetTypeDropdown, + EnvelopeFieldGetTypeEmail, + EnvelopeFieldGetTypeInitials, + EnvelopeFieldGetTypeName, + EnvelopeFieldGetTypeNumber, + EnvelopeFieldGetTypeRadio, + EnvelopeFieldGetTypeSignature, + EnvelopeFieldGetTypeText, + EnvelopeFieldGetUnauthorizedError, + EnvelopeFieldGetUnauthorizedErrorData, + EnvelopeFieldGetUnauthorizedIssue, + EnvelopeFieldGetUnauthorizedIssueTypedDict, + EnvelopeFieldGetValue1, + EnvelopeFieldGetValue1TypedDict, + EnvelopeFieldGetValue2, + EnvelopeFieldGetValue2TypedDict, + EnvelopeFieldGetValue3, + EnvelopeFieldGetValue3TypedDict, + EnvelopeFieldGetVerticalAlign1, + EnvelopeFieldGetVerticalAlign2, + ) + from .envelope_field_updatemanyop import ( + EnvelopeFieldUpdateManyBadRequestError, + EnvelopeFieldUpdateManyBadRequestErrorData, + EnvelopeFieldUpdateManyBadRequestIssue, + EnvelopeFieldUpdateManyBadRequestIssueTypedDict, + EnvelopeFieldUpdateManyDataCheckbox, + EnvelopeFieldUpdateManyDataCheckboxTypedDict, + EnvelopeFieldUpdateManyDataDate, + EnvelopeFieldUpdateManyDataDateTypedDict, + EnvelopeFieldUpdateManyDataDropdown, + EnvelopeFieldUpdateManyDataDropdownTypedDict, + EnvelopeFieldUpdateManyDataEmail, + EnvelopeFieldUpdateManyDataEmailTypedDict, + EnvelopeFieldUpdateManyDataFreeSignature, + EnvelopeFieldUpdateManyDataFreeSignatureTypedDict, + EnvelopeFieldUpdateManyDataInitials, + EnvelopeFieldUpdateManyDataInitialsTypedDict, + EnvelopeFieldUpdateManyDataName, + EnvelopeFieldUpdateManyDataNameTypedDict, + EnvelopeFieldUpdateManyDataNumber, + EnvelopeFieldUpdateManyDataNumberTypedDict, + EnvelopeFieldUpdateManyDataRadio, + EnvelopeFieldUpdateManyDataRadioTypedDict, + EnvelopeFieldUpdateManyDataResponse, + EnvelopeFieldUpdateManyDataResponseTypedDict, + EnvelopeFieldUpdateManyDataSignature, + EnvelopeFieldUpdateManyDataSignatureTypedDict, + EnvelopeFieldUpdateManyDataText, + EnvelopeFieldUpdateManyDataTextTypedDict, + EnvelopeFieldUpdateManyDataUnion, + EnvelopeFieldUpdateManyDataUnionTypedDict, + EnvelopeFieldUpdateManyDirectionCheckbox, + EnvelopeFieldUpdateManyDirectionRadio, + EnvelopeFieldUpdateManyDirectionResponse1, + EnvelopeFieldUpdateManyDirectionResponse2, + EnvelopeFieldUpdateManyFieldMetaCheckboxRequest, + EnvelopeFieldUpdateManyFieldMetaCheckboxRequestTypedDict, + EnvelopeFieldUpdateManyFieldMetaCheckboxResponse, + EnvelopeFieldUpdateManyFieldMetaCheckboxResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaDateRequest, + EnvelopeFieldUpdateManyFieldMetaDateRequestTypedDict, + EnvelopeFieldUpdateManyFieldMetaDateResponse, + EnvelopeFieldUpdateManyFieldMetaDateResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaDropdownRequest, + EnvelopeFieldUpdateManyFieldMetaDropdownRequestTypedDict, + EnvelopeFieldUpdateManyFieldMetaDropdownResponse, + EnvelopeFieldUpdateManyFieldMetaDropdownResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaEmailRequest, + EnvelopeFieldUpdateManyFieldMetaEmailRequestTypedDict, + EnvelopeFieldUpdateManyFieldMetaEmailResponse, + EnvelopeFieldUpdateManyFieldMetaEmailResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaInitialsRequest, + EnvelopeFieldUpdateManyFieldMetaInitialsRequestTypedDict, + EnvelopeFieldUpdateManyFieldMetaInitialsResponse, + EnvelopeFieldUpdateManyFieldMetaInitialsResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaNameRequest, + EnvelopeFieldUpdateManyFieldMetaNameRequestTypedDict, + EnvelopeFieldUpdateManyFieldMetaNameResponse, + EnvelopeFieldUpdateManyFieldMetaNameResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaNumberRequest, + EnvelopeFieldUpdateManyFieldMetaNumberRequestTypedDict, + EnvelopeFieldUpdateManyFieldMetaNumberResponse, + EnvelopeFieldUpdateManyFieldMetaNumberResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaRadioRequest, + EnvelopeFieldUpdateManyFieldMetaRadioRequestTypedDict, + EnvelopeFieldUpdateManyFieldMetaRadioResponse, + EnvelopeFieldUpdateManyFieldMetaRadioResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaSignatureRequest, + EnvelopeFieldUpdateManyFieldMetaSignatureRequestTypedDict, + EnvelopeFieldUpdateManyFieldMetaSignatureResponse, + EnvelopeFieldUpdateManyFieldMetaSignatureResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaTextRequest, + EnvelopeFieldUpdateManyFieldMetaTextRequestTypedDict, + EnvelopeFieldUpdateManyFieldMetaTextResponse, + EnvelopeFieldUpdateManyFieldMetaTextResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaTypeCheckbox, + EnvelopeFieldUpdateManyFieldMetaTypeDate, + EnvelopeFieldUpdateManyFieldMetaTypeDropdown, + EnvelopeFieldUpdateManyFieldMetaTypeEmail, + EnvelopeFieldUpdateManyFieldMetaTypeInitials, + EnvelopeFieldUpdateManyFieldMetaTypeName, + EnvelopeFieldUpdateManyFieldMetaTypeNumber, + EnvelopeFieldUpdateManyFieldMetaTypeRadio, + EnvelopeFieldUpdateManyFieldMetaTypeSignature, + EnvelopeFieldUpdateManyFieldMetaTypeText, + EnvelopeFieldUpdateManyFieldMetaUnion, + EnvelopeFieldUpdateManyFieldMetaUnionTypedDict, + EnvelopeFieldUpdateManyForbiddenError, + EnvelopeFieldUpdateManyForbiddenErrorData, + EnvelopeFieldUpdateManyForbiddenIssue, + EnvelopeFieldUpdateManyForbiddenIssueTypedDict, + EnvelopeFieldUpdateManyInternalServerError, + EnvelopeFieldUpdateManyInternalServerErrorData, + EnvelopeFieldUpdateManyInternalServerErrorIssue, + EnvelopeFieldUpdateManyInternalServerErrorIssueTypedDict, + EnvelopeFieldUpdateManyRequest, + EnvelopeFieldUpdateManyRequestTypedDict, + EnvelopeFieldUpdateManyResponse, + EnvelopeFieldUpdateManyResponseTypedDict, + EnvelopeFieldUpdateManyTextAlignDate, + EnvelopeFieldUpdateManyTextAlignEmail, + EnvelopeFieldUpdateManyTextAlignInitials, + EnvelopeFieldUpdateManyTextAlignName, + EnvelopeFieldUpdateManyTextAlignNumber, + EnvelopeFieldUpdateManyTextAlignResponse1, + EnvelopeFieldUpdateManyTextAlignResponse2, + EnvelopeFieldUpdateManyTextAlignResponse3, + EnvelopeFieldUpdateManyTextAlignResponse4, + EnvelopeFieldUpdateManyTextAlignResponse5, + EnvelopeFieldUpdateManyTextAlignResponse6, + EnvelopeFieldUpdateManyTextAlignText, + EnvelopeFieldUpdateManyTypeCheckboxRequest1, + EnvelopeFieldUpdateManyTypeCheckboxRequest2, + EnvelopeFieldUpdateManyTypeDateRequest1, + EnvelopeFieldUpdateManyTypeDateRequest2, + EnvelopeFieldUpdateManyTypeDropdownRequest1, + EnvelopeFieldUpdateManyTypeDropdownRequest2, + EnvelopeFieldUpdateManyTypeEmailRequest1, + EnvelopeFieldUpdateManyTypeEmailRequest2, + EnvelopeFieldUpdateManyTypeFreeSignature, + EnvelopeFieldUpdateManyTypeInitialsRequest1, + EnvelopeFieldUpdateManyTypeInitialsRequest2, + EnvelopeFieldUpdateManyTypeNameRequest1, + EnvelopeFieldUpdateManyTypeNameRequest2, + EnvelopeFieldUpdateManyTypeNumberRequest1, + EnvelopeFieldUpdateManyTypeNumberRequest2, + EnvelopeFieldUpdateManyTypeRadioRequest1, + EnvelopeFieldUpdateManyTypeRadioRequest2, + EnvelopeFieldUpdateManyTypeResponse, + EnvelopeFieldUpdateManyTypeSignatureRequest1, + EnvelopeFieldUpdateManyTypeSignatureRequest2, + EnvelopeFieldUpdateManyTypeTextRequest1, + EnvelopeFieldUpdateManyTypeTextRequest2, + EnvelopeFieldUpdateManyUnauthorizedError, + EnvelopeFieldUpdateManyUnauthorizedErrorData, + EnvelopeFieldUpdateManyUnauthorizedIssue, + EnvelopeFieldUpdateManyUnauthorizedIssueTypedDict, + EnvelopeFieldUpdateManyValueCheckbox, + EnvelopeFieldUpdateManyValueCheckboxTypedDict, + EnvelopeFieldUpdateManyValueDropdown, + EnvelopeFieldUpdateManyValueDropdownTypedDict, + EnvelopeFieldUpdateManyValueRadio, + EnvelopeFieldUpdateManyValueRadioTypedDict, + EnvelopeFieldUpdateManyValueResponse1, + EnvelopeFieldUpdateManyValueResponse1TypedDict, + EnvelopeFieldUpdateManyValueResponse2, + EnvelopeFieldUpdateManyValueResponse2TypedDict, + EnvelopeFieldUpdateManyValueResponse3, + EnvelopeFieldUpdateManyValueResponse3TypedDict, + EnvelopeFieldUpdateManyVerticalAlignNumber, + EnvelopeFieldUpdateManyVerticalAlignResponse1, + EnvelopeFieldUpdateManyVerticalAlignResponse2, + EnvelopeFieldUpdateManyVerticalAlignText, + ) + from .envelope_getop import ( + EnvelopeGetAccessAuth, + EnvelopeGetActionAuth, + EnvelopeGetAuthOptions, + EnvelopeGetAuthOptionsTypedDict, + EnvelopeGetBadRequestError, + EnvelopeGetBadRequestErrorData, + EnvelopeGetBadRequestIssue, + EnvelopeGetBadRequestIssueTypedDict, + EnvelopeGetDirectLink, + EnvelopeGetDirectLinkTypedDict, + EnvelopeGetDirection1, + EnvelopeGetDirection2, + EnvelopeGetDistributionMethod, + EnvelopeGetDocumentMeta, + EnvelopeGetDocumentMetaTypedDict, + EnvelopeGetEmailSettings, + EnvelopeGetEmailSettingsTypedDict, + EnvelopeGetEnvelopeItem, + EnvelopeGetEnvelopeItemTypedDict, + EnvelopeGetField, + EnvelopeGetFieldMetaCheckbox, + EnvelopeGetFieldMetaCheckboxTypedDict, + EnvelopeGetFieldMetaDate, + EnvelopeGetFieldMetaDateTypedDict, + EnvelopeGetFieldMetaDropdown, + EnvelopeGetFieldMetaDropdownTypedDict, + EnvelopeGetFieldMetaEmail, + EnvelopeGetFieldMetaEmailTypedDict, + EnvelopeGetFieldMetaInitials, + EnvelopeGetFieldMetaInitialsTypedDict, + EnvelopeGetFieldMetaName, + EnvelopeGetFieldMetaNameTypedDict, + EnvelopeGetFieldMetaNumber, + EnvelopeGetFieldMetaNumberTypedDict, + EnvelopeGetFieldMetaRadio, + EnvelopeGetFieldMetaRadioTypedDict, + EnvelopeGetFieldMetaSignature, + EnvelopeGetFieldMetaSignatureTypedDict, + EnvelopeGetFieldMetaText, + EnvelopeGetFieldMetaTextTypedDict, + EnvelopeGetFieldMetaUnion, + EnvelopeGetFieldMetaUnionTypedDict, + EnvelopeGetFieldType, + EnvelopeGetFieldTypedDict, + EnvelopeGetForbiddenError, + EnvelopeGetForbiddenErrorData, + EnvelopeGetForbiddenIssue, + EnvelopeGetForbiddenIssueTypedDict, + EnvelopeGetFormValues, + EnvelopeGetFormValuesTypedDict, + EnvelopeGetGlobalAccessAuth, + EnvelopeGetGlobalActionAuth, + EnvelopeGetInternalServerError, + EnvelopeGetInternalServerErrorData, + EnvelopeGetInternalServerErrorIssue, + EnvelopeGetInternalServerErrorIssueTypedDict, + EnvelopeGetNotFoundError, + EnvelopeGetNotFoundErrorData, + EnvelopeGetNotFoundIssue, + EnvelopeGetNotFoundIssueTypedDict, + EnvelopeGetReadStatus, + EnvelopeGetRecipient, + EnvelopeGetRecipientAuthOptions, + EnvelopeGetRecipientAuthOptionsTypedDict, + EnvelopeGetRecipientTypedDict, + EnvelopeGetRequest, + EnvelopeGetRequestTypedDict, + EnvelopeGetResponse, + EnvelopeGetResponseTypedDict, + EnvelopeGetRole, + EnvelopeGetSendStatus, + EnvelopeGetSigningOrder, + EnvelopeGetSigningStatus, + EnvelopeGetSource, + EnvelopeGetStatus, + EnvelopeGetTeam, + EnvelopeGetTeamTypedDict, + EnvelopeGetTemplateType, + EnvelopeGetTextAlign1, + EnvelopeGetTextAlign2, + EnvelopeGetTextAlign3, + EnvelopeGetTextAlign4, + EnvelopeGetTextAlign5, + EnvelopeGetTextAlign6, + EnvelopeGetType, + EnvelopeGetTypeCheckbox, + EnvelopeGetTypeDate, + EnvelopeGetTypeDropdown, + EnvelopeGetTypeEmail, + EnvelopeGetTypeInitials, + EnvelopeGetTypeName, + EnvelopeGetTypeNumber, + EnvelopeGetTypeRadio, + EnvelopeGetTypeSignature, + EnvelopeGetTypeText, + EnvelopeGetUnauthorizedError, + EnvelopeGetUnauthorizedErrorData, + EnvelopeGetUnauthorizedIssue, + EnvelopeGetUnauthorizedIssueTypedDict, + EnvelopeGetUser, + EnvelopeGetUserTypedDict, + EnvelopeGetValue1, + EnvelopeGetValue1TypedDict, + EnvelopeGetValue2, + EnvelopeGetValue2TypedDict, + EnvelopeGetValue3, + EnvelopeGetValue3TypedDict, + EnvelopeGetVerticalAlign1, + EnvelopeGetVerticalAlign2, + EnvelopeGetVisibility, + ) + from .envelope_item_createmanyop import ( + EnvelopeItemCreateManyBadRequestError, + EnvelopeItemCreateManyBadRequestErrorData, + EnvelopeItemCreateManyBadRequestIssue, + EnvelopeItemCreateManyBadRequestIssueTypedDict, + EnvelopeItemCreateManyData, + EnvelopeItemCreateManyDataTypedDict, + EnvelopeItemCreateManyFile, + EnvelopeItemCreateManyFileTypedDict, + EnvelopeItemCreateManyForbiddenError, + EnvelopeItemCreateManyForbiddenErrorData, + EnvelopeItemCreateManyForbiddenIssue, + EnvelopeItemCreateManyForbiddenIssueTypedDict, + EnvelopeItemCreateManyInternalServerError, + EnvelopeItemCreateManyInternalServerErrorData, + EnvelopeItemCreateManyInternalServerErrorIssue, + EnvelopeItemCreateManyInternalServerErrorIssueTypedDict, + EnvelopeItemCreateManyPayload, + EnvelopeItemCreateManyPayloadTypedDict, + EnvelopeItemCreateManyRequest, + EnvelopeItemCreateManyRequestTypedDict, + EnvelopeItemCreateManyResponse, + EnvelopeItemCreateManyResponseTypedDict, + EnvelopeItemCreateManyUnauthorizedError, + EnvelopeItemCreateManyUnauthorizedErrorData, + EnvelopeItemCreateManyUnauthorizedIssue, + EnvelopeItemCreateManyUnauthorizedIssueTypedDict, + ) + from .envelope_item_deleteop import ( + EnvelopeItemDeleteBadRequestError, + EnvelopeItemDeleteBadRequestErrorData, + EnvelopeItemDeleteBadRequestIssue, + EnvelopeItemDeleteBadRequestIssueTypedDict, + EnvelopeItemDeleteForbiddenError, + EnvelopeItemDeleteForbiddenErrorData, + EnvelopeItemDeleteForbiddenIssue, + EnvelopeItemDeleteForbiddenIssueTypedDict, + EnvelopeItemDeleteInternalServerError, + EnvelopeItemDeleteInternalServerErrorData, + EnvelopeItemDeleteInternalServerErrorIssue, + EnvelopeItemDeleteInternalServerErrorIssueTypedDict, + EnvelopeItemDeleteRequest, + EnvelopeItemDeleteRequestTypedDict, + EnvelopeItemDeleteResponse, + EnvelopeItemDeleteResponseTypedDict, + EnvelopeItemDeleteUnauthorizedError, + EnvelopeItemDeleteUnauthorizedErrorData, + EnvelopeItemDeleteUnauthorizedIssue, + EnvelopeItemDeleteUnauthorizedIssueTypedDict, + ) + from .envelope_item_downloadop import ( + EnvelopeItemDownloadBadRequestError, + EnvelopeItemDownloadBadRequestErrorData, + EnvelopeItemDownloadBadRequestIssue, + EnvelopeItemDownloadBadRequestIssueTypedDict, + EnvelopeItemDownloadForbiddenError, + EnvelopeItemDownloadForbiddenErrorData, + EnvelopeItemDownloadForbiddenIssue, + EnvelopeItemDownloadForbiddenIssueTypedDict, + EnvelopeItemDownloadInternalServerError, + EnvelopeItemDownloadInternalServerErrorData, + EnvelopeItemDownloadInternalServerErrorIssue, + EnvelopeItemDownloadInternalServerErrorIssueTypedDict, + EnvelopeItemDownloadNotFoundError, + EnvelopeItemDownloadNotFoundErrorData, + EnvelopeItemDownloadNotFoundIssue, + EnvelopeItemDownloadNotFoundIssueTypedDict, + EnvelopeItemDownloadRequest, + EnvelopeItemDownloadRequestTypedDict, + EnvelopeItemDownloadResponse, + EnvelopeItemDownloadResponseTypedDict, + EnvelopeItemDownloadUnauthorizedError, + EnvelopeItemDownloadUnauthorizedErrorData, + EnvelopeItemDownloadUnauthorizedIssue, + EnvelopeItemDownloadUnauthorizedIssueTypedDict, + EnvelopeItemDownloadVersion, + ) + from .envelope_item_updatemanyop import ( + EnvelopeItemUpdateManyBadRequestError, + EnvelopeItemUpdateManyBadRequestErrorData, + EnvelopeItemUpdateManyBadRequestIssue, + EnvelopeItemUpdateManyBadRequestIssueTypedDict, + EnvelopeItemUpdateManyDataRequest, + EnvelopeItemUpdateManyDataRequestTypedDict, + EnvelopeItemUpdateManyDataResponse, + EnvelopeItemUpdateManyDataResponseTypedDict, + EnvelopeItemUpdateManyForbiddenError, + EnvelopeItemUpdateManyForbiddenErrorData, + EnvelopeItemUpdateManyForbiddenIssue, + EnvelopeItemUpdateManyForbiddenIssueTypedDict, + EnvelopeItemUpdateManyInternalServerError, + EnvelopeItemUpdateManyInternalServerErrorData, + EnvelopeItemUpdateManyInternalServerErrorIssue, + EnvelopeItemUpdateManyInternalServerErrorIssueTypedDict, + EnvelopeItemUpdateManyRequest, + EnvelopeItemUpdateManyRequestTypedDict, + EnvelopeItemUpdateManyResponse, + EnvelopeItemUpdateManyResponseTypedDict, + EnvelopeItemUpdateManyUnauthorizedError, + EnvelopeItemUpdateManyUnauthorizedErrorData, + EnvelopeItemUpdateManyUnauthorizedIssue, + EnvelopeItemUpdateManyUnauthorizedIssueTypedDict, + ) + from .envelope_recipient_createmanyop import ( + EnvelopeRecipientCreateManyAccessAuthRequest, + EnvelopeRecipientCreateManyAccessAuthResponse, + EnvelopeRecipientCreateManyActionAuthRequest, + EnvelopeRecipientCreateManyActionAuthResponse, + EnvelopeRecipientCreateManyAuthOptions, + EnvelopeRecipientCreateManyAuthOptionsTypedDict, + EnvelopeRecipientCreateManyBadRequestError, + EnvelopeRecipientCreateManyBadRequestErrorData, + EnvelopeRecipientCreateManyBadRequestIssue, + EnvelopeRecipientCreateManyBadRequestIssueTypedDict, + EnvelopeRecipientCreateManyDataRequest, + EnvelopeRecipientCreateManyDataRequestTypedDict, + EnvelopeRecipientCreateManyDataResponse, + EnvelopeRecipientCreateManyDataResponseTypedDict, + EnvelopeRecipientCreateManyForbiddenError, + EnvelopeRecipientCreateManyForbiddenErrorData, + EnvelopeRecipientCreateManyForbiddenIssue, + EnvelopeRecipientCreateManyForbiddenIssueTypedDict, + EnvelopeRecipientCreateManyInternalServerError, + EnvelopeRecipientCreateManyInternalServerErrorData, + EnvelopeRecipientCreateManyInternalServerErrorIssue, + EnvelopeRecipientCreateManyInternalServerErrorIssueTypedDict, + EnvelopeRecipientCreateManyReadStatus, + EnvelopeRecipientCreateManyRequest, + EnvelopeRecipientCreateManyRequestTypedDict, + EnvelopeRecipientCreateManyResponse, + EnvelopeRecipientCreateManyResponseTypedDict, + EnvelopeRecipientCreateManyRoleRequest, + EnvelopeRecipientCreateManyRoleResponse, + EnvelopeRecipientCreateManySendStatus, + EnvelopeRecipientCreateManySigningStatus, + EnvelopeRecipientCreateManyUnauthorizedError, + EnvelopeRecipientCreateManyUnauthorizedErrorData, + EnvelopeRecipientCreateManyUnauthorizedIssue, + EnvelopeRecipientCreateManyUnauthorizedIssueTypedDict, + ) + from .envelope_recipient_deleteop import ( + EnvelopeRecipientDeleteBadRequestError, + EnvelopeRecipientDeleteBadRequestErrorData, + EnvelopeRecipientDeleteBadRequestIssue, + EnvelopeRecipientDeleteBadRequestIssueTypedDict, + EnvelopeRecipientDeleteForbiddenError, + EnvelopeRecipientDeleteForbiddenErrorData, + EnvelopeRecipientDeleteForbiddenIssue, + EnvelopeRecipientDeleteForbiddenIssueTypedDict, + EnvelopeRecipientDeleteInternalServerError, + EnvelopeRecipientDeleteInternalServerErrorData, + EnvelopeRecipientDeleteInternalServerErrorIssue, + EnvelopeRecipientDeleteInternalServerErrorIssueTypedDict, + EnvelopeRecipientDeleteRequest, + EnvelopeRecipientDeleteRequestTypedDict, + EnvelopeRecipientDeleteResponse, + EnvelopeRecipientDeleteResponseTypedDict, + EnvelopeRecipientDeleteUnauthorizedError, + EnvelopeRecipientDeleteUnauthorizedErrorData, + EnvelopeRecipientDeleteUnauthorizedIssue, + EnvelopeRecipientDeleteUnauthorizedIssueTypedDict, + ) + from .envelope_recipient_getop import ( + EnvelopeRecipientGetAccessAuth, + EnvelopeRecipientGetActionAuth, + EnvelopeRecipientGetAuthOptions, + EnvelopeRecipientGetAuthOptionsTypedDict, + EnvelopeRecipientGetBadRequestError, + EnvelopeRecipientGetBadRequestErrorData, + EnvelopeRecipientGetBadRequestIssue, + EnvelopeRecipientGetBadRequestIssueTypedDict, + EnvelopeRecipientGetDirection1, + EnvelopeRecipientGetDirection2, + EnvelopeRecipientGetField, + EnvelopeRecipientGetFieldMetaCheckbox, + EnvelopeRecipientGetFieldMetaCheckboxTypedDict, + EnvelopeRecipientGetFieldMetaDate, + EnvelopeRecipientGetFieldMetaDateTypedDict, + EnvelopeRecipientGetFieldMetaDropdown, + EnvelopeRecipientGetFieldMetaDropdownTypedDict, + EnvelopeRecipientGetFieldMetaEmail, + EnvelopeRecipientGetFieldMetaEmailTypedDict, + EnvelopeRecipientGetFieldMetaInitials, + EnvelopeRecipientGetFieldMetaInitialsTypedDict, + EnvelopeRecipientGetFieldMetaName, + EnvelopeRecipientGetFieldMetaNameTypedDict, + EnvelopeRecipientGetFieldMetaNumber, + EnvelopeRecipientGetFieldMetaNumberTypedDict, + EnvelopeRecipientGetFieldMetaRadio, + EnvelopeRecipientGetFieldMetaRadioTypedDict, + EnvelopeRecipientGetFieldMetaSignature, + EnvelopeRecipientGetFieldMetaSignatureTypedDict, + EnvelopeRecipientGetFieldMetaText, + EnvelopeRecipientGetFieldMetaTextTypedDict, + EnvelopeRecipientGetFieldMetaUnion, + EnvelopeRecipientGetFieldMetaUnionTypedDict, + EnvelopeRecipientGetFieldTypedDict, + EnvelopeRecipientGetForbiddenError, + EnvelopeRecipientGetForbiddenErrorData, + EnvelopeRecipientGetForbiddenIssue, + EnvelopeRecipientGetForbiddenIssueTypedDict, + EnvelopeRecipientGetInternalServerError, + EnvelopeRecipientGetInternalServerErrorData, + EnvelopeRecipientGetInternalServerErrorIssue, + EnvelopeRecipientGetInternalServerErrorIssueTypedDict, + EnvelopeRecipientGetNotFoundError, + EnvelopeRecipientGetNotFoundErrorData, + EnvelopeRecipientGetNotFoundIssue, + EnvelopeRecipientGetNotFoundIssueTypedDict, + EnvelopeRecipientGetReadStatus, + EnvelopeRecipientGetRequest, + EnvelopeRecipientGetRequestTypedDict, + EnvelopeRecipientGetResponse, + EnvelopeRecipientGetResponseTypedDict, + EnvelopeRecipientGetRole, + EnvelopeRecipientGetSendStatus, + EnvelopeRecipientGetSigningStatus, + EnvelopeRecipientGetTextAlign1, + EnvelopeRecipientGetTextAlign2, + EnvelopeRecipientGetTextAlign3, + EnvelopeRecipientGetTextAlign4, + EnvelopeRecipientGetTextAlign5, + EnvelopeRecipientGetTextAlign6, + EnvelopeRecipientGetType, + EnvelopeRecipientGetTypeCheckbox, + EnvelopeRecipientGetTypeDate, + EnvelopeRecipientGetTypeDropdown, + EnvelopeRecipientGetTypeEmail, + EnvelopeRecipientGetTypeInitials, + EnvelopeRecipientGetTypeName, + EnvelopeRecipientGetTypeNumber, + EnvelopeRecipientGetTypeRadio, + EnvelopeRecipientGetTypeSignature, + EnvelopeRecipientGetTypeText, + EnvelopeRecipientGetUnauthorizedError, + EnvelopeRecipientGetUnauthorizedErrorData, + EnvelopeRecipientGetUnauthorizedIssue, + EnvelopeRecipientGetUnauthorizedIssueTypedDict, + EnvelopeRecipientGetValue1, + EnvelopeRecipientGetValue1TypedDict, + EnvelopeRecipientGetValue2, + EnvelopeRecipientGetValue2TypedDict, + EnvelopeRecipientGetValue3, + EnvelopeRecipientGetValue3TypedDict, + EnvelopeRecipientGetVerticalAlign1, + EnvelopeRecipientGetVerticalAlign2, + ) + from .envelope_recipient_updatemanyop import ( + EnvelopeRecipientUpdateManyAccessAuthRequest, + EnvelopeRecipientUpdateManyAccessAuthResponse, + EnvelopeRecipientUpdateManyActionAuthRequest, + EnvelopeRecipientUpdateManyActionAuthResponse, + EnvelopeRecipientUpdateManyAuthOptions, + EnvelopeRecipientUpdateManyAuthOptionsTypedDict, + EnvelopeRecipientUpdateManyBadRequestError, + EnvelopeRecipientUpdateManyBadRequestErrorData, + EnvelopeRecipientUpdateManyBadRequestIssue, + EnvelopeRecipientUpdateManyBadRequestIssueTypedDict, + EnvelopeRecipientUpdateManyDataRequest, + EnvelopeRecipientUpdateManyDataRequestTypedDict, + EnvelopeRecipientUpdateManyDataResponse, + EnvelopeRecipientUpdateManyDataResponseTypedDict, + EnvelopeRecipientUpdateManyForbiddenError, + EnvelopeRecipientUpdateManyForbiddenErrorData, + EnvelopeRecipientUpdateManyForbiddenIssue, + EnvelopeRecipientUpdateManyForbiddenIssueTypedDict, + EnvelopeRecipientUpdateManyInternalServerError, + EnvelopeRecipientUpdateManyInternalServerErrorData, + EnvelopeRecipientUpdateManyInternalServerErrorIssue, + EnvelopeRecipientUpdateManyInternalServerErrorIssueTypedDict, + EnvelopeRecipientUpdateManyReadStatus, + EnvelopeRecipientUpdateManyRequest, + EnvelopeRecipientUpdateManyRequestTypedDict, + EnvelopeRecipientUpdateManyResponse, + EnvelopeRecipientUpdateManyResponseTypedDict, + EnvelopeRecipientUpdateManyRoleRequest, + EnvelopeRecipientUpdateManyRoleResponse, + EnvelopeRecipientUpdateManySendStatus, + EnvelopeRecipientUpdateManySigningStatus, + EnvelopeRecipientUpdateManyUnauthorizedError, + EnvelopeRecipientUpdateManyUnauthorizedErrorData, + EnvelopeRecipientUpdateManyUnauthorizedIssue, + EnvelopeRecipientUpdateManyUnauthorizedIssueTypedDict, + ) + from .envelope_redistributeop import ( + EnvelopeRedistributeBadRequestError, + EnvelopeRedistributeBadRequestErrorData, + EnvelopeRedistributeBadRequestIssue, + EnvelopeRedistributeBadRequestIssueTypedDict, + EnvelopeRedistributeForbiddenError, + EnvelopeRedistributeForbiddenErrorData, + EnvelopeRedistributeForbiddenIssue, + EnvelopeRedistributeForbiddenIssueTypedDict, + EnvelopeRedistributeInternalServerError, + EnvelopeRedistributeInternalServerErrorData, + EnvelopeRedistributeInternalServerErrorIssue, + EnvelopeRedistributeInternalServerErrorIssueTypedDict, + EnvelopeRedistributeRequest, + EnvelopeRedistributeRequestTypedDict, + EnvelopeRedistributeResponse, + EnvelopeRedistributeResponseTypedDict, + EnvelopeRedistributeUnauthorizedError, + EnvelopeRedistributeUnauthorizedErrorData, + EnvelopeRedistributeUnauthorizedIssue, + EnvelopeRedistributeUnauthorizedIssueTypedDict, + ) + from .envelope_updateop import ( + EnvelopeUpdateAuthOptions, + EnvelopeUpdateAuthOptionsTypedDict, + EnvelopeUpdateBadRequestError, + EnvelopeUpdateBadRequestErrorData, + EnvelopeUpdateBadRequestIssue, + EnvelopeUpdateBadRequestIssueTypedDict, + EnvelopeUpdateData, + EnvelopeUpdateDataGlobalAccessAuth, + EnvelopeUpdateDataGlobalActionAuth, + EnvelopeUpdateDataTypedDict, + EnvelopeUpdateDataVisibility, + EnvelopeUpdateDateFormat, + EnvelopeUpdateDistributionMethod, + EnvelopeUpdateEmailSettings, + EnvelopeUpdateEmailSettingsTypedDict, + EnvelopeUpdateForbiddenError, + EnvelopeUpdateForbiddenErrorData, + EnvelopeUpdateForbiddenIssue, + EnvelopeUpdateForbiddenIssueTypedDict, + EnvelopeUpdateFormValues, + EnvelopeUpdateFormValuesTypedDict, + EnvelopeUpdateGlobalAccessAuthResponse, + EnvelopeUpdateGlobalActionAuthResponse, + EnvelopeUpdateInternalServerError, + EnvelopeUpdateInternalServerErrorData, + EnvelopeUpdateInternalServerErrorIssue, + EnvelopeUpdateInternalServerErrorIssueTypedDict, + EnvelopeUpdateLanguage, + EnvelopeUpdateMeta, + EnvelopeUpdateMetaTypedDict, + EnvelopeUpdateRequest, + EnvelopeUpdateRequestTypedDict, + EnvelopeUpdateResponse, + EnvelopeUpdateResponseTypedDict, + EnvelopeUpdateSigningOrder, + EnvelopeUpdateSource, + EnvelopeUpdateStatus, + EnvelopeUpdateTemplateType, + EnvelopeUpdateType, + EnvelopeUpdateUnauthorizedError, + EnvelopeUpdateUnauthorizedErrorData, + EnvelopeUpdateUnauthorizedIssue, + EnvelopeUpdateUnauthorizedIssueTypedDict, + EnvelopeUpdateVisibilityResponse, + ) + from .envelope_useop import ( + EnvelopeUseAttachment, + EnvelopeUseAttachmentTypedDict, + EnvelopeUseBadRequestError, + EnvelopeUseBadRequestErrorData, + EnvelopeUseBadRequestIssue, + EnvelopeUseBadRequestIssueTypedDict, + EnvelopeUseCustomDocumentDatum, + EnvelopeUseCustomDocumentDatumTypedDict, + EnvelopeUseDateFormat, + EnvelopeUseDistributionMethod, + EnvelopeUseEmailSettings, + EnvelopeUseEmailSettingsTypedDict, + EnvelopeUseFile, + EnvelopeUseFileTypedDict, + EnvelopeUseForbiddenError, + EnvelopeUseForbiddenErrorData, + EnvelopeUseForbiddenIssue, + EnvelopeUseForbiddenIssueTypedDict, + EnvelopeUseIdentifier, + EnvelopeUseIdentifierTypedDict, + EnvelopeUseInternalServerError, + EnvelopeUseInternalServerErrorData, + EnvelopeUseInternalServerErrorIssue, + EnvelopeUseInternalServerErrorIssueTypedDict, + EnvelopeUseLanguage, + EnvelopeUsePayload, + EnvelopeUsePayloadTypedDict, + EnvelopeUsePrefillFieldCheckbox, + EnvelopeUsePrefillFieldCheckboxTypedDict, + EnvelopeUsePrefillFieldDate, + EnvelopeUsePrefillFieldDateTypedDict, + EnvelopeUsePrefillFieldDropdown, + EnvelopeUsePrefillFieldDropdownTypedDict, + EnvelopeUsePrefillFieldNumber, + EnvelopeUsePrefillFieldNumberTypedDict, + EnvelopeUsePrefillFieldRadio, + EnvelopeUsePrefillFieldRadioTypedDict, + EnvelopeUsePrefillFieldText, + EnvelopeUsePrefillFieldTextTypedDict, + EnvelopeUsePrefillFieldUnion, + EnvelopeUsePrefillFieldUnionTypedDict, + EnvelopeUseRecipient, + EnvelopeUseRecipientTypedDict, + EnvelopeUseRequest, + EnvelopeUseRequestTypedDict, + EnvelopeUseResponse, + EnvelopeUseResponseTypedDict, + EnvelopeUseTypeCheckbox, + EnvelopeUseTypeDate, + EnvelopeUseTypeDropdown, + EnvelopeUseTypeLink, + EnvelopeUseTypeNumber, + EnvelopeUseTypeRadio, + EnvelopeUseTypeText, + EnvelopeUseUnauthorizedError, + EnvelopeUseUnauthorizedErrorData, + EnvelopeUseUnauthorizedIssue, + EnvelopeUseUnauthorizedIssueTypedDict, + Override, + OverrideTypedDict, ) from .field_createdocumentfieldop import ( FieldCreateDocumentFieldBadRequestError, FieldCreateDocumentFieldBadRequestErrorData, FieldCreateDocumentFieldBadRequestIssue, FieldCreateDocumentFieldBadRequestIssueTypedDict, + FieldCreateDocumentFieldDirectionCheckbox, + FieldCreateDocumentFieldDirectionRadio, + FieldCreateDocumentFieldDirectionResponse1, + FieldCreateDocumentFieldDirectionResponse2, FieldCreateDocumentFieldFieldCheckbox, FieldCreateDocumentFieldFieldCheckboxTypedDict, FieldCreateDocumentFieldFieldDate, @@ -518,6 +2165,10 @@ FieldCreateDocumentFieldFieldMetaRadioRequestTypedDict, FieldCreateDocumentFieldFieldMetaRadioResponse, FieldCreateDocumentFieldFieldMetaRadioResponseTypedDict, + FieldCreateDocumentFieldFieldMetaSignatureRequest, + FieldCreateDocumentFieldFieldMetaSignatureRequestTypedDict, + FieldCreateDocumentFieldFieldMetaSignatureResponse, + FieldCreateDocumentFieldFieldMetaSignatureResponseTypedDict, FieldCreateDocumentFieldFieldMetaTextRequest, FieldCreateDocumentFieldFieldMetaTextRequestTypedDict, FieldCreateDocumentFieldFieldMetaTextResponse, @@ -530,6 +2181,7 @@ FieldCreateDocumentFieldFieldMetaTypeName, FieldCreateDocumentFieldFieldMetaTypeNumber, FieldCreateDocumentFieldFieldMetaTypeRadio, + FieldCreateDocumentFieldFieldMetaTypeSignature, FieldCreateDocumentFieldFieldMetaTypeText, FieldCreateDocumentFieldFieldMetaUnion, FieldCreateDocumentFieldFieldMetaUnionTypedDict, @@ -545,6 +2197,10 @@ FieldCreateDocumentFieldFieldTextTypedDict, FieldCreateDocumentFieldFieldUnion, FieldCreateDocumentFieldFieldUnionTypedDict, + FieldCreateDocumentFieldForbiddenError, + FieldCreateDocumentFieldForbiddenErrorData, + FieldCreateDocumentFieldForbiddenIssue, + FieldCreateDocumentFieldForbiddenIssueTypedDict, FieldCreateDocumentFieldInternalServerError, FieldCreateDocumentFieldInternalServerErrorData, FieldCreateDocumentFieldInternalServerErrorIssue, @@ -583,9 +2239,14 @@ FieldCreateDocumentFieldTypeRadioRequest1, FieldCreateDocumentFieldTypeRadioRequest2, FieldCreateDocumentFieldTypeResponse, - FieldCreateDocumentFieldTypeSignature, + FieldCreateDocumentFieldTypeSignatureRequest1, + FieldCreateDocumentFieldTypeSignatureRequest2, FieldCreateDocumentFieldTypeTextRequest1, FieldCreateDocumentFieldTypeTextRequest2, + FieldCreateDocumentFieldUnauthorizedError, + FieldCreateDocumentFieldUnauthorizedErrorData, + FieldCreateDocumentFieldUnauthorizedIssue, + FieldCreateDocumentFieldUnauthorizedIssueTypedDict, FieldCreateDocumentFieldValueCheckbox, FieldCreateDocumentFieldValueCheckboxTypedDict, FieldCreateDocumentFieldValueDropdown, @@ -598,12 +2259,20 @@ FieldCreateDocumentFieldValueResponse2TypedDict, FieldCreateDocumentFieldValueResponse3, FieldCreateDocumentFieldValueResponse3TypedDict, + FieldCreateDocumentFieldVerticalAlignNumber, + FieldCreateDocumentFieldVerticalAlignResponse1, + FieldCreateDocumentFieldVerticalAlignResponse2, + FieldCreateDocumentFieldVerticalAlignText, ) from .field_createdocumentfieldsop import ( FieldCreateDocumentFieldsBadRequestError, FieldCreateDocumentFieldsBadRequestErrorData, FieldCreateDocumentFieldsBadRequestIssue, FieldCreateDocumentFieldsBadRequestIssueTypedDict, + FieldCreateDocumentFieldsDirectionCheckbox, + FieldCreateDocumentFieldsDirectionRadio, + FieldCreateDocumentFieldsDirectionResponse1, + FieldCreateDocumentFieldsDirectionResponse2, FieldCreateDocumentFieldsFieldCheckbox, FieldCreateDocumentFieldsFieldCheckboxTypedDict, FieldCreateDocumentFieldsFieldDate, @@ -648,6 +2317,10 @@ FieldCreateDocumentFieldsFieldMetaRadioRequestTypedDict, FieldCreateDocumentFieldsFieldMetaRadioResponse, FieldCreateDocumentFieldsFieldMetaRadioResponseTypedDict, + FieldCreateDocumentFieldsFieldMetaSignatureRequest, + FieldCreateDocumentFieldsFieldMetaSignatureRequestTypedDict, + FieldCreateDocumentFieldsFieldMetaSignatureResponse, + FieldCreateDocumentFieldsFieldMetaSignatureResponseTypedDict, FieldCreateDocumentFieldsFieldMetaTextRequest, FieldCreateDocumentFieldsFieldMetaTextRequestTypedDict, FieldCreateDocumentFieldsFieldMetaTextResponse, @@ -660,6 +2333,7 @@ FieldCreateDocumentFieldsFieldMetaTypeName, FieldCreateDocumentFieldsFieldMetaTypeNumber, FieldCreateDocumentFieldsFieldMetaTypeRadio, + FieldCreateDocumentFieldsFieldMetaTypeSignature, FieldCreateDocumentFieldsFieldMetaTypeText, FieldCreateDocumentFieldsFieldMetaUnion, FieldCreateDocumentFieldsFieldMetaUnionTypedDict, @@ -677,6 +2351,10 @@ FieldCreateDocumentFieldsFieldTextTypedDict, FieldCreateDocumentFieldsFieldUnion, FieldCreateDocumentFieldsFieldUnionTypedDict, + FieldCreateDocumentFieldsForbiddenError, + FieldCreateDocumentFieldsForbiddenErrorData, + FieldCreateDocumentFieldsForbiddenIssue, + FieldCreateDocumentFieldsForbiddenIssueTypedDict, FieldCreateDocumentFieldsInternalServerError, FieldCreateDocumentFieldsInternalServerErrorData, FieldCreateDocumentFieldsInternalServerErrorIssue, @@ -715,9 +2393,14 @@ FieldCreateDocumentFieldsTypeRadioRequest1, FieldCreateDocumentFieldsTypeRadioRequest2, FieldCreateDocumentFieldsTypeResponse, - FieldCreateDocumentFieldsTypeSignature, + FieldCreateDocumentFieldsTypeSignatureRequest1, + FieldCreateDocumentFieldsTypeSignatureRequest2, FieldCreateDocumentFieldsTypeTextRequest1, FieldCreateDocumentFieldsTypeTextRequest2, + FieldCreateDocumentFieldsUnauthorizedError, + FieldCreateDocumentFieldsUnauthorizedErrorData, + FieldCreateDocumentFieldsUnauthorizedIssue, + FieldCreateDocumentFieldsUnauthorizedIssueTypedDict, FieldCreateDocumentFieldsValueCheckbox, FieldCreateDocumentFieldsValueCheckboxTypedDict, FieldCreateDocumentFieldsValueDropdown, @@ -730,12 +2413,20 @@ FieldCreateDocumentFieldsValueResponse2TypedDict, FieldCreateDocumentFieldsValueResponse3, FieldCreateDocumentFieldsValueResponse3TypedDict, + FieldCreateDocumentFieldsVerticalAlignNumber, + FieldCreateDocumentFieldsVerticalAlignResponse1, + FieldCreateDocumentFieldsVerticalAlignResponse2, + FieldCreateDocumentFieldsVerticalAlignText, ) from .field_createtemplatefieldop import ( FieldCreateTemplateFieldBadRequestError, FieldCreateTemplateFieldBadRequestErrorData, FieldCreateTemplateFieldBadRequestIssue, FieldCreateTemplateFieldBadRequestIssueTypedDict, + FieldCreateTemplateFieldDirectionCheckbox, + FieldCreateTemplateFieldDirectionRadio, + FieldCreateTemplateFieldDirectionResponse1, + FieldCreateTemplateFieldDirectionResponse2, FieldCreateTemplateFieldFieldCheckbox, FieldCreateTemplateFieldFieldCheckboxTypedDict, FieldCreateTemplateFieldFieldDate, @@ -780,6 +2471,10 @@ FieldCreateTemplateFieldFieldMetaRadioRequestTypedDict, FieldCreateTemplateFieldFieldMetaRadioResponse, FieldCreateTemplateFieldFieldMetaRadioResponseTypedDict, + FieldCreateTemplateFieldFieldMetaSignatureRequest, + FieldCreateTemplateFieldFieldMetaSignatureRequestTypedDict, + FieldCreateTemplateFieldFieldMetaSignatureResponse, + FieldCreateTemplateFieldFieldMetaSignatureResponseTypedDict, FieldCreateTemplateFieldFieldMetaTextRequest, FieldCreateTemplateFieldFieldMetaTextRequestTypedDict, FieldCreateTemplateFieldFieldMetaTextResponse, @@ -792,6 +2487,7 @@ FieldCreateTemplateFieldFieldMetaTypeName, FieldCreateTemplateFieldFieldMetaTypeNumber, FieldCreateTemplateFieldFieldMetaTypeRadio, + FieldCreateTemplateFieldFieldMetaTypeSignature, FieldCreateTemplateFieldFieldMetaTypeText, FieldCreateTemplateFieldFieldMetaUnion, FieldCreateTemplateFieldFieldMetaUnionTypedDict, @@ -807,6 +2503,10 @@ FieldCreateTemplateFieldFieldTextTypedDict, FieldCreateTemplateFieldFieldUnion, FieldCreateTemplateFieldFieldUnionTypedDict, + FieldCreateTemplateFieldForbiddenError, + FieldCreateTemplateFieldForbiddenErrorData, + FieldCreateTemplateFieldForbiddenIssue, + FieldCreateTemplateFieldForbiddenIssueTypedDict, FieldCreateTemplateFieldInternalServerError, FieldCreateTemplateFieldInternalServerErrorData, FieldCreateTemplateFieldInternalServerErrorIssue, @@ -845,9 +2545,14 @@ FieldCreateTemplateFieldTypeRadioRequest1, FieldCreateTemplateFieldTypeRadioRequest2, FieldCreateTemplateFieldTypeResponse, - FieldCreateTemplateFieldTypeSignature, + FieldCreateTemplateFieldTypeSignatureRequest1, + FieldCreateTemplateFieldTypeSignatureRequest2, FieldCreateTemplateFieldTypeTextRequest1, FieldCreateTemplateFieldTypeTextRequest2, + FieldCreateTemplateFieldUnauthorizedError, + FieldCreateTemplateFieldUnauthorizedErrorData, + FieldCreateTemplateFieldUnauthorizedIssue, + FieldCreateTemplateFieldUnauthorizedIssueTypedDict, FieldCreateTemplateFieldValueCheckbox, FieldCreateTemplateFieldValueCheckboxTypedDict, FieldCreateTemplateFieldValueDropdown, @@ -860,12 +2565,20 @@ FieldCreateTemplateFieldValueResponse2TypedDict, FieldCreateTemplateFieldValueResponse3, FieldCreateTemplateFieldValueResponse3TypedDict, + FieldCreateTemplateFieldVerticalAlignNumber, + FieldCreateTemplateFieldVerticalAlignResponse1, + FieldCreateTemplateFieldVerticalAlignResponse2, + FieldCreateTemplateFieldVerticalAlignText, ) from .field_createtemplatefieldsop import ( FieldCreateTemplateFieldsBadRequestError, FieldCreateTemplateFieldsBadRequestErrorData, FieldCreateTemplateFieldsBadRequestIssue, FieldCreateTemplateFieldsBadRequestIssueTypedDict, + FieldCreateTemplateFieldsDirectionCheckbox, + FieldCreateTemplateFieldsDirectionRadio, + FieldCreateTemplateFieldsDirectionResponse1, + FieldCreateTemplateFieldsDirectionResponse2, FieldCreateTemplateFieldsFieldCheckbox, FieldCreateTemplateFieldsFieldCheckboxTypedDict, FieldCreateTemplateFieldsFieldDate, @@ -910,6 +2623,10 @@ FieldCreateTemplateFieldsFieldMetaRadioRequestTypedDict, FieldCreateTemplateFieldsFieldMetaRadioResponse, FieldCreateTemplateFieldsFieldMetaRadioResponseTypedDict, + FieldCreateTemplateFieldsFieldMetaSignatureRequest, + FieldCreateTemplateFieldsFieldMetaSignatureRequestTypedDict, + FieldCreateTemplateFieldsFieldMetaSignatureResponse, + FieldCreateTemplateFieldsFieldMetaSignatureResponseTypedDict, FieldCreateTemplateFieldsFieldMetaTextRequest, FieldCreateTemplateFieldsFieldMetaTextRequestTypedDict, FieldCreateTemplateFieldsFieldMetaTextResponse, @@ -922,6 +2639,7 @@ FieldCreateTemplateFieldsFieldMetaTypeName, FieldCreateTemplateFieldsFieldMetaTypeNumber, FieldCreateTemplateFieldsFieldMetaTypeRadio, + FieldCreateTemplateFieldsFieldMetaTypeSignature, FieldCreateTemplateFieldsFieldMetaTypeText, FieldCreateTemplateFieldsFieldMetaUnion, FieldCreateTemplateFieldsFieldMetaUnionTypedDict, @@ -939,6 +2657,10 @@ FieldCreateTemplateFieldsFieldTextTypedDict, FieldCreateTemplateFieldsFieldUnion, FieldCreateTemplateFieldsFieldUnionTypedDict, + FieldCreateTemplateFieldsForbiddenError, + FieldCreateTemplateFieldsForbiddenErrorData, + FieldCreateTemplateFieldsForbiddenIssue, + FieldCreateTemplateFieldsForbiddenIssueTypedDict, FieldCreateTemplateFieldsInternalServerError, FieldCreateTemplateFieldsInternalServerErrorData, FieldCreateTemplateFieldsInternalServerErrorIssue, @@ -977,9 +2699,14 @@ FieldCreateTemplateFieldsTypeRadioRequest1, FieldCreateTemplateFieldsTypeRadioRequest2, FieldCreateTemplateFieldsTypeResponse, - FieldCreateTemplateFieldsTypeSignature, + FieldCreateTemplateFieldsTypeSignatureRequest1, + FieldCreateTemplateFieldsTypeSignatureRequest2, FieldCreateTemplateFieldsTypeTextRequest1, FieldCreateTemplateFieldsTypeTextRequest2, + FieldCreateTemplateFieldsUnauthorizedError, + FieldCreateTemplateFieldsUnauthorizedErrorData, + FieldCreateTemplateFieldsUnauthorizedIssue, + FieldCreateTemplateFieldsUnauthorizedIssueTypedDict, FieldCreateTemplateFieldsValueCheckbox, FieldCreateTemplateFieldsValueCheckboxTypedDict, FieldCreateTemplateFieldsValueDropdown, @@ -992,12 +2719,20 @@ FieldCreateTemplateFieldsValueResponse2TypedDict, FieldCreateTemplateFieldsValueResponse3, FieldCreateTemplateFieldsValueResponse3TypedDict, + FieldCreateTemplateFieldsVerticalAlignNumber, + FieldCreateTemplateFieldsVerticalAlignResponse1, + FieldCreateTemplateFieldsVerticalAlignResponse2, + FieldCreateTemplateFieldsVerticalAlignText, ) from .field_deletedocumentfieldop import ( FieldDeleteDocumentFieldBadRequestError, FieldDeleteDocumentFieldBadRequestErrorData, FieldDeleteDocumentFieldBadRequestIssue, FieldDeleteDocumentFieldBadRequestIssueTypedDict, + FieldDeleteDocumentFieldForbiddenError, + FieldDeleteDocumentFieldForbiddenErrorData, + FieldDeleteDocumentFieldForbiddenIssue, + FieldDeleteDocumentFieldForbiddenIssueTypedDict, FieldDeleteDocumentFieldInternalServerError, FieldDeleteDocumentFieldInternalServerErrorData, FieldDeleteDocumentFieldInternalServerErrorIssue, @@ -1006,12 +2741,20 @@ FieldDeleteDocumentFieldRequestTypedDict, FieldDeleteDocumentFieldResponse, FieldDeleteDocumentFieldResponseTypedDict, + FieldDeleteDocumentFieldUnauthorizedError, + FieldDeleteDocumentFieldUnauthorizedErrorData, + FieldDeleteDocumentFieldUnauthorizedIssue, + FieldDeleteDocumentFieldUnauthorizedIssueTypedDict, ) from .field_deletetemplatefieldop import ( FieldDeleteTemplateFieldBadRequestError, FieldDeleteTemplateFieldBadRequestErrorData, FieldDeleteTemplateFieldBadRequestIssue, FieldDeleteTemplateFieldBadRequestIssueTypedDict, + FieldDeleteTemplateFieldForbiddenError, + FieldDeleteTemplateFieldForbiddenErrorData, + FieldDeleteTemplateFieldForbiddenIssue, + FieldDeleteTemplateFieldForbiddenIssueTypedDict, FieldDeleteTemplateFieldInternalServerError, FieldDeleteTemplateFieldInternalServerErrorData, FieldDeleteTemplateFieldInternalServerErrorIssue, @@ -1020,12 +2763,18 @@ FieldDeleteTemplateFieldRequestTypedDict, FieldDeleteTemplateFieldResponse, FieldDeleteTemplateFieldResponseTypedDict, + FieldDeleteTemplateFieldUnauthorizedError, + FieldDeleteTemplateFieldUnauthorizedErrorData, + FieldDeleteTemplateFieldUnauthorizedIssue, + FieldDeleteTemplateFieldUnauthorizedIssueTypedDict, ) from .field_getdocumentfieldop import ( FieldGetDocumentFieldBadRequestError, FieldGetDocumentFieldBadRequestErrorData, FieldGetDocumentFieldBadRequestIssue, FieldGetDocumentFieldBadRequestIssueTypedDict, + FieldGetDocumentFieldDirection1, + FieldGetDocumentFieldDirection2, FieldGetDocumentFieldFieldMetaCheckbox, FieldGetDocumentFieldFieldMetaCheckboxTypedDict, FieldGetDocumentFieldFieldMetaDate, @@ -1042,10 +2791,16 @@ FieldGetDocumentFieldFieldMetaNumberTypedDict, FieldGetDocumentFieldFieldMetaRadio, FieldGetDocumentFieldFieldMetaRadioTypedDict, + FieldGetDocumentFieldFieldMetaSignature, + FieldGetDocumentFieldFieldMetaSignatureTypedDict, FieldGetDocumentFieldFieldMetaText, FieldGetDocumentFieldFieldMetaTextTypedDict, FieldGetDocumentFieldFieldMetaUnion, FieldGetDocumentFieldFieldMetaUnionTypedDict, + FieldGetDocumentFieldForbiddenError, + FieldGetDocumentFieldForbiddenErrorData, + FieldGetDocumentFieldForbiddenIssue, + FieldGetDocumentFieldForbiddenIssueTypedDict, FieldGetDocumentFieldInternalServerError, FieldGetDocumentFieldInternalServerErrorData, FieldGetDocumentFieldInternalServerErrorIssue, @@ -1073,19 +2828,28 @@ FieldGetDocumentFieldTypeName, FieldGetDocumentFieldTypeNumber, FieldGetDocumentFieldTypeRadio, + FieldGetDocumentFieldTypeSignature, FieldGetDocumentFieldTypeText, + FieldGetDocumentFieldUnauthorizedError, + FieldGetDocumentFieldUnauthorizedErrorData, + FieldGetDocumentFieldUnauthorizedIssue, + FieldGetDocumentFieldUnauthorizedIssueTypedDict, FieldGetDocumentFieldValue1, FieldGetDocumentFieldValue1TypedDict, FieldGetDocumentFieldValue2, FieldGetDocumentFieldValue2TypedDict, FieldGetDocumentFieldValue3, FieldGetDocumentFieldValue3TypedDict, + FieldGetDocumentFieldVerticalAlign1, + FieldGetDocumentFieldVerticalAlign2, ) from .field_gettemplatefieldop import ( FieldGetTemplateFieldBadRequestError, FieldGetTemplateFieldBadRequestErrorData, FieldGetTemplateFieldBadRequestIssue, FieldGetTemplateFieldBadRequestIssueTypedDict, + FieldGetTemplateFieldDirection1, + FieldGetTemplateFieldDirection2, FieldGetTemplateFieldFieldMetaCheckbox, FieldGetTemplateFieldFieldMetaCheckboxTypedDict, FieldGetTemplateFieldFieldMetaDate, @@ -1102,10 +2866,16 @@ FieldGetTemplateFieldFieldMetaNumberTypedDict, FieldGetTemplateFieldFieldMetaRadio, FieldGetTemplateFieldFieldMetaRadioTypedDict, + FieldGetTemplateFieldFieldMetaSignature, + FieldGetTemplateFieldFieldMetaSignatureTypedDict, FieldGetTemplateFieldFieldMetaText, FieldGetTemplateFieldFieldMetaTextTypedDict, FieldGetTemplateFieldFieldMetaUnion, FieldGetTemplateFieldFieldMetaUnionTypedDict, + FieldGetTemplateFieldForbiddenError, + FieldGetTemplateFieldForbiddenErrorData, + FieldGetTemplateFieldForbiddenIssue, + FieldGetTemplateFieldForbiddenIssueTypedDict, FieldGetTemplateFieldInternalServerError, FieldGetTemplateFieldInternalServerErrorData, FieldGetTemplateFieldInternalServerErrorIssue, @@ -1133,19 +2903,30 @@ FieldGetTemplateFieldTypeName, FieldGetTemplateFieldTypeNumber, FieldGetTemplateFieldTypeRadio, + FieldGetTemplateFieldTypeSignature, FieldGetTemplateFieldTypeText, + FieldGetTemplateFieldUnauthorizedError, + FieldGetTemplateFieldUnauthorizedErrorData, + FieldGetTemplateFieldUnauthorizedIssue, + FieldGetTemplateFieldUnauthorizedIssueTypedDict, FieldGetTemplateFieldValue1, FieldGetTemplateFieldValue1TypedDict, FieldGetTemplateFieldValue2, FieldGetTemplateFieldValue2TypedDict, FieldGetTemplateFieldValue3, FieldGetTemplateFieldValue3TypedDict, + FieldGetTemplateFieldVerticalAlign1, + FieldGetTemplateFieldVerticalAlign2, ) from .field_updatedocumentfieldop import ( FieldUpdateDocumentFieldBadRequestError, FieldUpdateDocumentFieldBadRequestErrorData, FieldUpdateDocumentFieldBadRequestIssue, FieldUpdateDocumentFieldBadRequestIssueTypedDict, + FieldUpdateDocumentFieldDirectionCheckbox, + FieldUpdateDocumentFieldDirectionRadio, + FieldUpdateDocumentFieldDirectionResponse1, + FieldUpdateDocumentFieldDirectionResponse2, FieldUpdateDocumentFieldFieldCheckbox, FieldUpdateDocumentFieldFieldCheckboxTypedDict, FieldUpdateDocumentFieldFieldDate, @@ -1190,6 +2971,10 @@ FieldUpdateDocumentFieldFieldMetaRadioRequestTypedDict, FieldUpdateDocumentFieldFieldMetaRadioResponse, FieldUpdateDocumentFieldFieldMetaRadioResponseTypedDict, + FieldUpdateDocumentFieldFieldMetaSignatureRequest, + FieldUpdateDocumentFieldFieldMetaSignatureRequestTypedDict, + FieldUpdateDocumentFieldFieldMetaSignatureResponse, + FieldUpdateDocumentFieldFieldMetaSignatureResponseTypedDict, FieldUpdateDocumentFieldFieldMetaTextRequest, FieldUpdateDocumentFieldFieldMetaTextRequestTypedDict, FieldUpdateDocumentFieldFieldMetaTextResponse, @@ -1202,6 +2987,7 @@ FieldUpdateDocumentFieldFieldMetaTypeName, FieldUpdateDocumentFieldFieldMetaTypeNumber, FieldUpdateDocumentFieldFieldMetaTypeRadio, + FieldUpdateDocumentFieldFieldMetaTypeSignature, FieldUpdateDocumentFieldFieldMetaTypeText, FieldUpdateDocumentFieldFieldMetaUnion, FieldUpdateDocumentFieldFieldMetaUnionTypedDict, @@ -1217,6 +3003,10 @@ FieldUpdateDocumentFieldFieldTextTypedDict, FieldUpdateDocumentFieldFieldUnion, FieldUpdateDocumentFieldFieldUnionTypedDict, + FieldUpdateDocumentFieldForbiddenError, + FieldUpdateDocumentFieldForbiddenErrorData, + FieldUpdateDocumentFieldForbiddenIssue, + FieldUpdateDocumentFieldForbiddenIssueTypedDict, FieldUpdateDocumentFieldInternalServerError, FieldUpdateDocumentFieldInternalServerErrorData, FieldUpdateDocumentFieldInternalServerErrorIssue, @@ -1255,9 +3045,14 @@ FieldUpdateDocumentFieldTypeRadioRequest1, FieldUpdateDocumentFieldTypeRadioRequest2, FieldUpdateDocumentFieldTypeResponse, - FieldUpdateDocumentFieldTypeSignature, + FieldUpdateDocumentFieldTypeSignatureRequest1, + FieldUpdateDocumentFieldTypeSignatureRequest2, FieldUpdateDocumentFieldTypeTextRequest1, FieldUpdateDocumentFieldTypeTextRequest2, + FieldUpdateDocumentFieldUnauthorizedError, + FieldUpdateDocumentFieldUnauthorizedErrorData, + FieldUpdateDocumentFieldUnauthorizedIssue, + FieldUpdateDocumentFieldUnauthorizedIssueTypedDict, FieldUpdateDocumentFieldValueCheckbox, FieldUpdateDocumentFieldValueCheckboxTypedDict, FieldUpdateDocumentFieldValueDropdown, @@ -1270,12 +3065,20 @@ FieldUpdateDocumentFieldValueResponse2TypedDict, FieldUpdateDocumentFieldValueResponse3, FieldUpdateDocumentFieldValueResponse3TypedDict, + FieldUpdateDocumentFieldVerticalAlignNumber, + FieldUpdateDocumentFieldVerticalAlignResponse1, + FieldUpdateDocumentFieldVerticalAlignResponse2, + FieldUpdateDocumentFieldVerticalAlignText, ) from .field_updatedocumentfieldsop import ( FieldUpdateDocumentFieldsBadRequestError, FieldUpdateDocumentFieldsBadRequestErrorData, FieldUpdateDocumentFieldsBadRequestIssue, FieldUpdateDocumentFieldsBadRequestIssueTypedDict, + FieldUpdateDocumentFieldsDirectionCheckbox, + FieldUpdateDocumentFieldsDirectionRadio, + FieldUpdateDocumentFieldsDirectionResponse1, + FieldUpdateDocumentFieldsDirectionResponse2, FieldUpdateDocumentFieldsFieldCheckbox, FieldUpdateDocumentFieldsFieldCheckboxTypedDict, FieldUpdateDocumentFieldsFieldDate, @@ -1320,6 +3123,10 @@ FieldUpdateDocumentFieldsFieldMetaRadioRequestTypedDict, FieldUpdateDocumentFieldsFieldMetaRadioResponse, FieldUpdateDocumentFieldsFieldMetaRadioResponseTypedDict, + FieldUpdateDocumentFieldsFieldMetaSignatureRequest, + FieldUpdateDocumentFieldsFieldMetaSignatureRequestTypedDict, + FieldUpdateDocumentFieldsFieldMetaSignatureResponse, + FieldUpdateDocumentFieldsFieldMetaSignatureResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaTextRequest, FieldUpdateDocumentFieldsFieldMetaTextRequestTypedDict, FieldUpdateDocumentFieldsFieldMetaTextResponse, @@ -1332,6 +3139,7 @@ FieldUpdateDocumentFieldsFieldMetaTypeName, FieldUpdateDocumentFieldsFieldMetaTypeNumber, FieldUpdateDocumentFieldsFieldMetaTypeRadio, + FieldUpdateDocumentFieldsFieldMetaTypeSignature, FieldUpdateDocumentFieldsFieldMetaTypeText, FieldUpdateDocumentFieldsFieldMetaUnion, FieldUpdateDocumentFieldsFieldMetaUnionTypedDict, @@ -1349,6 +3157,10 @@ FieldUpdateDocumentFieldsFieldTextTypedDict, FieldUpdateDocumentFieldsFieldUnion, FieldUpdateDocumentFieldsFieldUnionTypedDict, + FieldUpdateDocumentFieldsForbiddenError, + FieldUpdateDocumentFieldsForbiddenErrorData, + FieldUpdateDocumentFieldsForbiddenIssue, + FieldUpdateDocumentFieldsForbiddenIssueTypedDict, FieldUpdateDocumentFieldsInternalServerError, FieldUpdateDocumentFieldsInternalServerErrorData, FieldUpdateDocumentFieldsInternalServerErrorIssue, @@ -1387,9 +3199,14 @@ FieldUpdateDocumentFieldsTypeRadioRequest1, FieldUpdateDocumentFieldsTypeRadioRequest2, FieldUpdateDocumentFieldsTypeResponse, - FieldUpdateDocumentFieldsTypeSignature, + FieldUpdateDocumentFieldsTypeSignatureRequest1, + FieldUpdateDocumentFieldsTypeSignatureRequest2, FieldUpdateDocumentFieldsTypeTextRequest1, FieldUpdateDocumentFieldsTypeTextRequest2, + FieldUpdateDocumentFieldsUnauthorizedError, + FieldUpdateDocumentFieldsUnauthorizedErrorData, + FieldUpdateDocumentFieldsUnauthorizedIssue, + FieldUpdateDocumentFieldsUnauthorizedIssueTypedDict, FieldUpdateDocumentFieldsValueCheckbox, FieldUpdateDocumentFieldsValueCheckboxTypedDict, FieldUpdateDocumentFieldsValueDropdown, @@ -1402,12 +3219,20 @@ FieldUpdateDocumentFieldsValueResponse2TypedDict, FieldUpdateDocumentFieldsValueResponse3, FieldUpdateDocumentFieldsValueResponse3TypedDict, + FieldUpdateDocumentFieldsVerticalAlignNumber, + FieldUpdateDocumentFieldsVerticalAlignResponse1, + FieldUpdateDocumentFieldsVerticalAlignResponse2, + FieldUpdateDocumentFieldsVerticalAlignText, ) from .field_updatetemplatefieldop import ( FieldUpdateTemplateFieldBadRequestError, FieldUpdateTemplateFieldBadRequestErrorData, FieldUpdateTemplateFieldBadRequestIssue, FieldUpdateTemplateFieldBadRequestIssueTypedDict, + FieldUpdateTemplateFieldDirectionCheckbox, + FieldUpdateTemplateFieldDirectionRadio, + FieldUpdateTemplateFieldDirectionResponse1, + FieldUpdateTemplateFieldDirectionResponse2, FieldUpdateTemplateFieldFieldCheckbox, FieldUpdateTemplateFieldFieldCheckboxTypedDict, FieldUpdateTemplateFieldFieldDate, @@ -1452,6 +3277,10 @@ FieldUpdateTemplateFieldFieldMetaRadioRequestTypedDict, FieldUpdateTemplateFieldFieldMetaRadioResponse, FieldUpdateTemplateFieldFieldMetaRadioResponseTypedDict, + FieldUpdateTemplateFieldFieldMetaSignatureRequest, + FieldUpdateTemplateFieldFieldMetaSignatureRequestTypedDict, + FieldUpdateTemplateFieldFieldMetaSignatureResponse, + FieldUpdateTemplateFieldFieldMetaSignatureResponseTypedDict, FieldUpdateTemplateFieldFieldMetaTextRequest, FieldUpdateTemplateFieldFieldMetaTextRequestTypedDict, FieldUpdateTemplateFieldFieldMetaTextResponse, @@ -1464,6 +3293,7 @@ FieldUpdateTemplateFieldFieldMetaTypeName, FieldUpdateTemplateFieldFieldMetaTypeNumber, FieldUpdateTemplateFieldFieldMetaTypeRadio, + FieldUpdateTemplateFieldFieldMetaTypeSignature, FieldUpdateTemplateFieldFieldMetaTypeText, FieldUpdateTemplateFieldFieldMetaUnion, FieldUpdateTemplateFieldFieldMetaUnionTypedDict, @@ -1479,6 +3309,10 @@ FieldUpdateTemplateFieldFieldTextTypedDict, FieldUpdateTemplateFieldFieldUnion, FieldUpdateTemplateFieldFieldUnionTypedDict, + FieldUpdateTemplateFieldForbiddenError, + FieldUpdateTemplateFieldForbiddenErrorData, + FieldUpdateTemplateFieldForbiddenIssue, + FieldUpdateTemplateFieldForbiddenIssueTypedDict, FieldUpdateTemplateFieldInternalServerError, FieldUpdateTemplateFieldInternalServerErrorData, FieldUpdateTemplateFieldInternalServerErrorIssue, @@ -1517,9 +3351,14 @@ FieldUpdateTemplateFieldTypeRadioRequest1, FieldUpdateTemplateFieldTypeRadioRequest2, FieldUpdateTemplateFieldTypeResponse, - FieldUpdateTemplateFieldTypeSignature, + FieldUpdateTemplateFieldTypeSignatureRequest1, + FieldUpdateTemplateFieldTypeSignatureRequest2, FieldUpdateTemplateFieldTypeTextRequest1, FieldUpdateTemplateFieldTypeTextRequest2, + FieldUpdateTemplateFieldUnauthorizedError, + FieldUpdateTemplateFieldUnauthorizedErrorData, + FieldUpdateTemplateFieldUnauthorizedIssue, + FieldUpdateTemplateFieldUnauthorizedIssueTypedDict, FieldUpdateTemplateFieldValueCheckbox, FieldUpdateTemplateFieldValueCheckboxTypedDict, FieldUpdateTemplateFieldValueDropdown, @@ -1532,12 +3371,20 @@ FieldUpdateTemplateFieldValueResponse2TypedDict, FieldUpdateTemplateFieldValueResponse3, FieldUpdateTemplateFieldValueResponse3TypedDict, + FieldUpdateTemplateFieldVerticalAlignNumber, + FieldUpdateTemplateFieldVerticalAlignResponse1, + FieldUpdateTemplateFieldVerticalAlignResponse2, + FieldUpdateTemplateFieldVerticalAlignText, ) from .field_updatetemplatefieldsop import ( FieldUpdateTemplateFieldsBadRequestError, FieldUpdateTemplateFieldsBadRequestErrorData, FieldUpdateTemplateFieldsBadRequestIssue, FieldUpdateTemplateFieldsBadRequestIssueTypedDict, + FieldUpdateTemplateFieldsDirectionCheckbox, + FieldUpdateTemplateFieldsDirectionRadio, + FieldUpdateTemplateFieldsDirectionResponse1, + FieldUpdateTemplateFieldsDirectionResponse2, FieldUpdateTemplateFieldsFieldCheckbox, FieldUpdateTemplateFieldsFieldCheckboxTypedDict, FieldUpdateTemplateFieldsFieldDate, @@ -1582,6 +3429,10 @@ FieldUpdateTemplateFieldsFieldMetaRadioRequestTypedDict, FieldUpdateTemplateFieldsFieldMetaRadioResponse, FieldUpdateTemplateFieldsFieldMetaRadioResponseTypedDict, + FieldUpdateTemplateFieldsFieldMetaSignatureRequest, + FieldUpdateTemplateFieldsFieldMetaSignatureRequestTypedDict, + FieldUpdateTemplateFieldsFieldMetaSignatureResponse, + FieldUpdateTemplateFieldsFieldMetaSignatureResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaTextRequest, FieldUpdateTemplateFieldsFieldMetaTextRequestTypedDict, FieldUpdateTemplateFieldsFieldMetaTextResponse, @@ -1594,6 +3445,7 @@ FieldUpdateTemplateFieldsFieldMetaTypeName, FieldUpdateTemplateFieldsFieldMetaTypeNumber, FieldUpdateTemplateFieldsFieldMetaTypeRadio, + FieldUpdateTemplateFieldsFieldMetaTypeSignature, FieldUpdateTemplateFieldsFieldMetaTypeText, FieldUpdateTemplateFieldsFieldMetaUnion, FieldUpdateTemplateFieldsFieldMetaUnionTypedDict, @@ -1611,6 +3463,10 @@ FieldUpdateTemplateFieldsFieldTextTypedDict, FieldUpdateTemplateFieldsFieldUnion, FieldUpdateTemplateFieldsFieldUnionTypedDict, + FieldUpdateTemplateFieldsForbiddenError, + FieldUpdateTemplateFieldsForbiddenErrorData, + FieldUpdateTemplateFieldsForbiddenIssue, + FieldUpdateTemplateFieldsForbiddenIssueTypedDict, FieldUpdateTemplateFieldsInternalServerError, FieldUpdateTemplateFieldsInternalServerErrorData, FieldUpdateTemplateFieldsInternalServerErrorIssue, @@ -1649,9 +3505,14 @@ FieldUpdateTemplateFieldsTypeRadioRequest1, FieldUpdateTemplateFieldsTypeRadioRequest2, FieldUpdateTemplateFieldsTypeResponse, - FieldUpdateTemplateFieldsTypeSignature, + FieldUpdateTemplateFieldsTypeSignatureRequest1, + FieldUpdateTemplateFieldsTypeSignatureRequest2, FieldUpdateTemplateFieldsTypeTextRequest1, FieldUpdateTemplateFieldsTypeTextRequest2, + FieldUpdateTemplateFieldsUnauthorizedError, + FieldUpdateTemplateFieldsUnauthorizedErrorData, + FieldUpdateTemplateFieldsUnauthorizedIssue, + FieldUpdateTemplateFieldsUnauthorizedIssueTypedDict, FieldUpdateTemplateFieldsValueCheckbox, FieldUpdateTemplateFieldsValueCheckboxTypedDict, FieldUpdateTemplateFieldsValueDropdown, @@ -1664,6 +3525,115 @@ FieldUpdateTemplateFieldsValueResponse2TypedDict, FieldUpdateTemplateFieldsValueResponse3, FieldUpdateTemplateFieldsValueResponse3TypedDict, + FieldUpdateTemplateFieldsVerticalAlignNumber, + FieldUpdateTemplateFieldsVerticalAlignResponse1, + FieldUpdateTemplateFieldsVerticalAlignResponse2, + FieldUpdateTemplateFieldsVerticalAlignText, + ) + from .folder_createfolderop import ( + FolderCreateFolderBadRequestError, + FolderCreateFolderBadRequestErrorData, + FolderCreateFolderBadRequestIssue, + FolderCreateFolderBadRequestIssueTypedDict, + FolderCreateFolderForbiddenError, + FolderCreateFolderForbiddenErrorData, + FolderCreateFolderForbiddenIssue, + FolderCreateFolderForbiddenIssueTypedDict, + FolderCreateFolderInternalServerError, + FolderCreateFolderInternalServerErrorData, + FolderCreateFolderInternalServerErrorIssue, + FolderCreateFolderInternalServerErrorIssueTypedDict, + FolderCreateFolderRequest, + FolderCreateFolderRequestTypedDict, + FolderCreateFolderResponse, + FolderCreateFolderResponseTypedDict, + FolderCreateFolderTypeRequest, + FolderCreateFolderTypeResponse, + FolderCreateFolderUnauthorizedError, + FolderCreateFolderUnauthorizedErrorData, + FolderCreateFolderUnauthorizedIssue, + FolderCreateFolderUnauthorizedIssueTypedDict, + FolderCreateFolderVisibility, + ) + from .folder_deletefolderop import ( + FolderDeleteFolderBadRequestError, + FolderDeleteFolderBadRequestErrorData, + FolderDeleteFolderBadRequestIssue, + FolderDeleteFolderBadRequestIssueTypedDict, + FolderDeleteFolderForbiddenError, + FolderDeleteFolderForbiddenErrorData, + FolderDeleteFolderForbiddenIssue, + FolderDeleteFolderForbiddenIssueTypedDict, + FolderDeleteFolderInternalServerError, + FolderDeleteFolderInternalServerErrorData, + FolderDeleteFolderInternalServerErrorIssue, + FolderDeleteFolderInternalServerErrorIssueTypedDict, + FolderDeleteFolderRequest, + FolderDeleteFolderRequestTypedDict, + FolderDeleteFolderResponse, + FolderDeleteFolderResponseTypedDict, + FolderDeleteFolderUnauthorizedError, + FolderDeleteFolderUnauthorizedErrorData, + FolderDeleteFolderUnauthorizedIssue, + FolderDeleteFolderUnauthorizedIssueTypedDict, + ) + from .folder_findfoldersop import ( + FolderFindFoldersBadRequestError, + FolderFindFoldersBadRequestErrorData, + FolderFindFoldersBadRequestIssue, + FolderFindFoldersBadRequestIssueTypedDict, + FolderFindFoldersData, + FolderFindFoldersDataType, + FolderFindFoldersDataTypedDict, + FolderFindFoldersForbiddenError, + FolderFindFoldersForbiddenErrorData, + FolderFindFoldersForbiddenIssue, + FolderFindFoldersForbiddenIssueTypedDict, + FolderFindFoldersInternalServerError, + FolderFindFoldersInternalServerErrorData, + FolderFindFoldersInternalServerErrorIssue, + FolderFindFoldersInternalServerErrorIssueTypedDict, + FolderFindFoldersNotFoundError, + FolderFindFoldersNotFoundErrorData, + FolderFindFoldersNotFoundIssue, + FolderFindFoldersNotFoundIssueTypedDict, + FolderFindFoldersQueryParamType, + FolderFindFoldersRequest, + FolderFindFoldersRequestTypedDict, + FolderFindFoldersResponse, + FolderFindFoldersResponseTypedDict, + FolderFindFoldersUnauthorizedError, + FolderFindFoldersUnauthorizedErrorData, + FolderFindFoldersUnauthorizedIssue, + FolderFindFoldersUnauthorizedIssueTypedDict, + FolderFindFoldersVisibility, + ) + from .folder_updatefolderop import ( + FolderUpdateFolderBadRequestError, + FolderUpdateFolderBadRequestErrorData, + FolderUpdateFolderBadRequestIssue, + FolderUpdateFolderBadRequestIssueTypedDict, + FolderUpdateFolderData, + FolderUpdateFolderDataTypedDict, + FolderUpdateFolderDataVisibility, + FolderUpdateFolderForbiddenError, + FolderUpdateFolderForbiddenErrorData, + FolderUpdateFolderForbiddenIssue, + FolderUpdateFolderForbiddenIssueTypedDict, + FolderUpdateFolderInternalServerError, + FolderUpdateFolderInternalServerErrorData, + FolderUpdateFolderInternalServerErrorIssue, + FolderUpdateFolderInternalServerErrorIssueTypedDict, + FolderUpdateFolderRequest, + FolderUpdateFolderRequestTypedDict, + FolderUpdateFolderResponse, + FolderUpdateFolderResponseTypedDict, + FolderUpdateFolderType, + FolderUpdateFolderUnauthorizedError, + FolderUpdateFolderUnauthorizedErrorData, + FolderUpdateFolderUnauthorizedIssue, + FolderUpdateFolderUnauthorizedIssueTypedDict, + FolderUpdateFolderVisibilityResponse, ) from .no_response_error import NoResponseError from .recipient_createdocumentrecipientop import ( @@ -1677,6 +3647,10 @@ RecipientCreateDocumentRecipientBadRequestErrorData, RecipientCreateDocumentRecipientBadRequestIssue, RecipientCreateDocumentRecipientBadRequestIssueTypedDict, + RecipientCreateDocumentRecipientForbiddenError, + RecipientCreateDocumentRecipientForbiddenErrorData, + RecipientCreateDocumentRecipientForbiddenIssue, + RecipientCreateDocumentRecipientForbiddenIssueTypedDict, RecipientCreateDocumentRecipientInternalServerError, RecipientCreateDocumentRecipientInternalServerErrorData, RecipientCreateDocumentRecipientInternalServerErrorIssue, @@ -1692,6 +3666,10 @@ RecipientCreateDocumentRecipientRoleResponse, RecipientCreateDocumentRecipientSendStatus, RecipientCreateDocumentRecipientSigningStatus, + RecipientCreateDocumentRecipientUnauthorizedError, + RecipientCreateDocumentRecipientUnauthorizedErrorData, + RecipientCreateDocumentRecipientUnauthorizedIssue, + RecipientCreateDocumentRecipientUnauthorizedIssueTypedDict, ) from .recipient_createdocumentrecipientsop import ( RecipientCreateDocumentRecipientsAccessAuthRequest, @@ -1704,6 +3682,10 @@ RecipientCreateDocumentRecipientsBadRequestErrorData, RecipientCreateDocumentRecipientsBadRequestIssue, RecipientCreateDocumentRecipientsBadRequestIssueTypedDict, + RecipientCreateDocumentRecipientsForbiddenError, + RecipientCreateDocumentRecipientsForbiddenErrorData, + RecipientCreateDocumentRecipientsForbiddenIssue, + RecipientCreateDocumentRecipientsForbiddenIssueTypedDict, RecipientCreateDocumentRecipientsInternalServerError, RecipientCreateDocumentRecipientsInternalServerErrorData, RecipientCreateDocumentRecipientsInternalServerErrorIssue, @@ -1721,6 +3703,10 @@ RecipientCreateDocumentRecipientsRoleResponse, RecipientCreateDocumentRecipientsSendStatus, RecipientCreateDocumentRecipientsSigningStatus, + RecipientCreateDocumentRecipientsUnauthorizedError, + RecipientCreateDocumentRecipientsUnauthorizedErrorData, + RecipientCreateDocumentRecipientsUnauthorizedIssue, + RecipientCreateDocumentRecipientsUnauthorizedIssueTypedDict, ) from .recipient_createtemplaterecipientop import ( RecipientCreateTemplateRecipientAccessAuthRequest, @@ -1733,6 +3719,10 @@ RecipientCreateTemplateRecipientBadRequestErrorData, RecipientCreateTemplateRecipientBadRequestIssue, RecipientCreateTemplateRecipientBadRequestIssueTypedDict, + RecipientCreateTemplateRecipientForbiddenError, + RecipientCreateTemplateRecipientForbiddenErrorData, + RecipientCreateTemplateRecipientForbiddenIssue, + RecipientCreateTemplateRecipientForbiddenIssueTypedDict, RecipientCreateTemplateRecipientInternalServerError, RecipientCreateTemplateRecipientInternalServerErrorData, RecipientCreateTemplateRecipientInternalServerErrorIssue, @@ -1748,6 +3738,10 @@ RecipientCreateTemplateRecipientRoleResponse, RecipientCreateTemplateRecipientSendStatus, RecipientCreateTemplateRecipientSigningStatus, + RecipientCreateTemplateRecipientUnauthorizedError, + RecipientCreateTemplateRecipientUnauthorizedErrorData, + RecipientCreateTemplateRecipientUnauthorizedIssue, + RecipientCreateTemplateRecipientUnauthorizedIssueTypedDict, ) from .recipient_createtemplaterecipientsop import ( RecipientCreateTemplateRecipientsAccessAuthRequest, @@ -1760,6 +3754,10 @@ RecipientCreateTemplateRecipientsBadRequestErrorData, RecipientCreateTemplateRecipientsBadRequestIssue, RecipientCreateTemplateRecipientsBadRequestIssueTypedDict, + RecipientCreateTemplateRecipientsForbiddenError, + RecipientCreateTemplateRecipientsForbiddenErrorData, + RecipientCreateTemplateRecipientsForbiddenIssue, + RecipientCreateTemplateRecipientsForbiddenIssueTypedDict, RecipientCreateTemplateRecipientsInternalServerError, RecipientCreateTemplateRecipientsInternalServerErrorData, RecipientCreateTemplateRecipientsInternalServerErrorIssue, @@ -1777,12 +3775,20 @@ RecipientCreateTemplateRecipientsRoleResponse, RecipientCreateTemplateRecipientsSendStatus, RecipientCreateTemplateRecipientsSigningStatus, + RecipientCreateTemplateRecipientsUnauthorizedError, + RecipientCreateTemplateRecipientsUnauthorizedErrorData, + RecipientCreateTemplateRecipientsUnauthorizedIssue, + RecipientCreateTemplateRecipientsUnauthorizedIssueTypedDict, ) from .recipient_deletedocumentrecipientop import ( RecipientDeleteDocumentRecipientBadRequestError, RecipientDeleteDocumentRecipientBadRequestErrorData, RecipientDeleteDocumentRecipientBadRequestIssue, RecipientDeleteDocumentRecipientBadRequestIssueTypedDict, + RecipientDeleteDocumentRecipientForbiddenError, + RecipientDeleteDocumentRecipientForbiddenErrorData, + RecipientDeleteDocumentRecipientForbiddenIssue, + RecipientDeleteDocumentRecipientForbiddenIssueTypedDict, RecipientDeleteDocumentRecipientInternalServerError, RecipientDeleteDocumentRecipientInternalServerErrorData, RecipientDeleteDocumentRecipientInternalServerErrorIssue, @@ -1791,12 +3797,20 @@ RecipientDeleteDocumentRecipientRequestTypedDict, RecipientDeleteDocumentRecipientResponse, RecipientDeleteDocumentRecipientResponseTypedDict, + RecipientDeleteDocumentRecipientUnauthorizedError, + RecipientDeleteDocumentRecipientUnauthorizedErrorData, + RecipientDeleteDocumentRecipientUnauthorizedIssue, + RecipientDeleteDocumentRecipientUnauthorizedIssueTypedDict, ) from .recipient_deletetemplaterecipientop import ( RecipientDeleteTemplateRecipientBadRequestError, RecipientDeleteTemplateRecipientBadRequestErrorData, RecipientDeleteTemplateRecipientBadRequestIssue, RecipientDeleteTemplateRecipientBadRequestIssueTypedDict, + RecipientDeleteTemplateRecipientForbiddenError, + RecipientDeleteTemplateRecipientForbiddenErrorData, + RecipientDeleteTemplateRecipientForbiddenIssue, + RecipientDeleteTemplateRecipientForbiddenIssueTypedDict, RecipientDeleteTemplateRecipientInternalServerError, RecipientDeleteTemplateRecipientInternalServerErrorData, RecipientDeleteTemplateRecipientInternalServerErrorIssue, @@ -1805,6 +3819,10 @@ RecipientDeleteTemplateRecipientRequestTypedDict, RecipientDeleteTemplateRecipientResponse, RecipientDeleteTemplateRecipientResponseTypedDict, + RecipientDeleteTemplateRecipientUnauthorizedError, + RecipientDeleteTemplateRecipientUnauthorizedErrorData, + RecipientDeleteTemplateRecipientUnauthorizedIssue, + RecipientDeleteTemplateRecipientUnauthorizedIssueTypedDict, ) from .recipient_getdocumentrecipientop import ( RecipientGetDocumentRecipientAccessAuth, @@ -1815,6 +3833,8 @@ RecipientGetDocumentRecipientBadRequestErrorData, RecipientGetDocumentRecipientBadRequestIssue, RecipientGetDocumentRecipientBadRequestIssueTypedDict, + RecipientGetDocumentRecipientDirection1, + RecipientGetDocumentRecipientDirection2, RecipientGetDocumentRecipientField, RecipientGetDocumentRecipientFieldMetaCheckbox, RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict, @@ -1832,11 +3852,17 @@ RecipientGetDocumentRecipientFieldMetaNumberTypedDict, RecipientGetDocumentRecipientFieldMetaRadio, RecipientGetDocumentRecipientFieldMetaRadioTypedDict, + RecipientGetDocumentRecipientFieldMetaSignature, + RecipientGetDocumentRecipientFieldMetaSignatureTypedDict, RecipientGetDocumentRecipientFieldMetaText, RecipientGetDocumentRecipientFieldMetaTextTypedDict, RecipientGetDocumentRecipientFieldMetaUnion, RecipientGetDocumentRecipientFieldMetaUnionTypedDict, RecipientGetDocumentRecipientFieldTypedDict, + RecipientGetDocumentRecipientForbiddenError, + RecipientGetDocumentRecipientForbiddenErrorData, + RecipientGetDocumentRecipientForbiddenIssue, + RecipientGetDocumentRecipientForbiddenIssueTypedDict, RecipientGetDocumentRecipientInternalServerError, RecipientGetDocumentRecipientInternalServerErrorData, RecipientGetDocumentRecipientInternalServerErrorIssue, @@ -1868,13 +3894,20 @@ RecipientGetDocumentRecipientTypeName, RecipientGetDocumentRecipientTypeNumber, RecipientGetDocumentRecipientTypeRadio, + RecipientGetDocumentRecipientTypeSignature, RecipientGetDocumentRecipientTypeText, + RecipientGetDocumentRecipientUnauthorizedError, + RecipientGetDocumentRecipientUnauthorizedErrorData, + RecipientGetDocumentRecipientUnauthorizedIssue, + RecipientGetDocumentRecipientUnauthorizedIssueTypedDict, RecipientGetDocumentRecipientValue1, RecipientGetDocumentRecipientValue1TypedDict, RecipientGetDocumentRecipientValue2, RecipientGetDocumentRecipientValue2TypedDict, RecipientGetDocumentRecipientValue3, RecipientGetDocumentRecipientValue3TypedDict, + RecipientGetDocumentRecipientVerticalAlign1, + RecipientGetDocumentRecipientVerticalAlign2, ) from .recipient_gettemplaterecipientop import ( RecipientGetTemplateRecipientAccessAuth, @@ -1885,6 +3918,8 @@ RecipientGetTemplateRecipientBadRequestErrorData, RecipientGetTemplateRecipientBadRequestIssue, RecipientGetTemplateRecipientBadRequestIssueTypedDict, + RecipientGetTemplateRecipientDirection1, + RecipientGetTemplateRecipientDirection2, RecipientGetTemplateRecipientField, RecipientGetTemplateRecipientFieldMetaCheckbox, RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict, @@ -1902,11 +3937,17 @@ RecipientGetTemplateRecipientFieldMetaNumberTypedDict, RecipientGetTemplateRecipientFieldMetaRadio, RecipientGetTemplateRecipientFieldMetaRadioTypedDict, + RecipientGetTemplateRecipientFieldMetaSignature, + RecipientGetTemplateRecipientFieldMetaSignatureTypedDict, RecipientGetTemplateRecipientFieldMetaText, RecipientGetTemplateRecipientFieldMetaTextTypedDict, RecipientGetTemplateRecipientFieldMetaUnion, RecipientGetTemplateRecipientFieldMetaUnionTypedDict, RecipientGetTemplateRecipientFieldTypedDict, + RecipientGetTemplateRecipientForbiddenError, + RecipientGetTemplateRecipientForbiddenErrorData, + RecipientGetTemplateRecipientForbiddenIssue, + RecipientGetTemplateRecipientForbiddenIssueTypedDict, RecipientGetTemplateRecipientInternalServerError, RecipientGetTemplateRecipientInternalServerErrorData, RecipientGetTemplateRecipientInternalServerErrorIssue, @@ -1938,13 +3979,20 @@ RecipientGetTemplateRecipientTypeName, RecipientGetTemplateRecipientTypeNumber, RecipientGetTemplateRecipientTypeRadio, + RecipientGetTemplateRecipientTypeSignature, RecipientGetTemplateRecipientTypeText, + RecipientGetTemplateRecipientUnauthorizedError, + RecipientGetTemplateRecipientUnauthorizedErrorData, + RecipientGetTemplateRecipientUnauthorizedIssue, + RecipientGetTemplateRecipientUnauthorizedIssueTypedDict, RecipientGetTemplateRecipientValue1, RecipientGetTemplateRecipientValue1TypedDict, RecipientGetTemplateRecipientValue2, RecipientGetTemplateRecipientValue2TypedDict, RecipientGetTemplateRecipientValue3, RecipientGetTemplateRecipientValue3TypedDict, + RecipientGetTemplateRecipientVerticalAlign1, + RecipientGetTemplateRecipientVerticalAlign2, ) from .recipient_updatedocumentrecipientop import ( RecipientUpdateDocumentRecipientAccessAuthRequest, @@ -1957,6 +4005,8 @@ RecipientUpdateDocumentRecipientBadRequestErrorData, RecipientUpdateDocumentRecipientBadRequestIssue, RecipientUpdateDocumentRecipientBadRequestIssueTypedDict, + RecipientUpdateDocumentRecipientDirection1, + RecipientUpdateDocumentRecipientDirection2, RecipientUpdateDocumentRecipientField, RecipientUpdateDocumentRecipientFieldMetaCheckbox, RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict, @@ -1974,11 +4024,17 @@ RecipientUpdateDocumentRecipientFieldMetaNumberTypedDict, RecipientUpdateDocumentRecipientFieldMetaRadio, RecipientUpdateDocumentRecipientFieldMetaRadioTypedDict, + RecipientUpdateDocumentRecipientFieldMetaSignature, + RecipientUpdateDocumentRecipientFieldMetaSignatureTypedDict, RecipientUpdateDocumentRecipientFieldMetaText, RecipientUpdateDocumentRecipientFieldMetaTextTypedDict, RecipientUpdateDocumentRecipientFieldMetaUnion, RecipientUpdateDocumentRecipientFieldMetaUnionTypedDict, RecipientUpdateDocumentRecipientFieldTypedDict, + RecipientUpdateDocumentRecipientForbiddenError, + RecipientUpdateDocumentRecipientForbiddenErrorData, + RecipientUpdateDocumentRecipientForbiddenIssue, + RecipientUpdateDocumentRecipientForbiddenIssueTypedDict, RecipientUpdateDocumentRecipientInternalServerError, RecipientUpdateDocumentRecipientInternalServerErrorData, RecipientUpdateDocumentRecipientInternalServerErrorIssue, @@ -2009,13 +4065,20 @@ RecipientUpdateDocumentRecipientTypeName, RecipientUpdateDocumentRecipientTypeNumber, RecipientUpdateDocumentRecipientTypeRadio, + RecipientUpdateDocumentRecipientTypeSignature, RecipientUpdateDocumentRecipientTypeText, + RecipientUpdateDocumentRecipientUnauthorizedError, + RecipientUpdateDocumentRecipientUnauthorizedErrorData, + RecipientUpdateDocumentRecipientUnauthorizedIssue, + RecipientUpdateDocumentRecipientUnauthorizedIssueTypedDict, RecipientUpdateDocumentRecipientValue1, RecipientUpdateDocumentRecipientValue1TypedDict, RecipientUpdateDocumentRecipientValue2, RecipientUpdateDocumentRecipientValue2TypedDict, RecipientUpdateDocumentRecipientValue3, RecipientUpdateDocumentRecipientValue3TypedDict, + RecipientUpdateDocumentRecipientVerticalAlign1, + RecipientUpdateDocumentRecipientVerticalAlign2, ) from .recipient_updatedocumentrecipientsop import ( RecipientUpdateDocumentRecipientsAccessAuthRequest, @@ -2028,6 +4091,8 @@ RecipientUpdateDocumentRecipientsBadRequestErrorData, RecipientUpdateDocumentRecipientsBadRequestIssue, RecipientUpdateDocumentRecipientsBadRequestIssueTypedDict, + RecipientUpdateDocumentRecipientsDirection1, + RecipientUpdateDocumentRecipientsDirection2, RecipientUpdateDocumentRecipientsField, RecipientUpdateDocumentRecipientsFieldMetaCheckbox, RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict, @@ -2045,11 +4110,17 @@ RecipientUpdateDocumentRecipientsFieldMetaNumberTypedDict, RecipientUpdateDocumentRecipientsFieldMetaRadio, RecipientUpdateDocumentRecipientsFieldMetaRadioTypedDict, + RecipientUpdateDocumentRecipientsFieldMetaSignature, + RecipientUpdateDocumentRecipientsFieldMetaSignatureTypedDict, RecipientUpdateDocumentRecipientsFieldMetaText, RecipientUpdateDocumentRecipientsFieldMetaTextTypedDict, RecipientUpdateDocumentRecipientsFieldMetaUnion, RecipientUpdateDocumentRecipientsFieldMetaUnionTypedDict, RecipientUpdateDocumentRecipientsFieldTypedDict, + RecipientUpdateDocumentRecipientsForbiddenError, + RecipientUpdateDocumentRecipientsForbiddenErrorData, + RecipientUpdateDocumentRecipientsForbiddenIssue, + RecipientUpdateDocumentRecipientsForbiddenIssueTypedDict, RecipientUpdateDocumentRecipientsInternalServerError, RecipientUpdateDocumentRecipientsInternalServerErrorData, RecipientUpdateDocumentRecipientsInternalServerErrorIssue, @@ -2082,13 +4153,20 @@ RecipientUpdateDocumentRecipientsTypeName, RecipientUpdateDocumentRecipientsTypeNumber, RecipientUpdateDocumentRecipientsTypeRadio, + RecipientUpdateDocumentRecipientsTypeSignature, RecipientUpdateDocumentRecipientsTypeText, + RecipientUpdateDocumentRecipientsUnauthorizedError, + RecipientUpdateDocumentRecipientsUnauthorizedErrorData, + RecipientUpdateDocumentRecipientsUnauthorizedIssue, + RecipientUpdateDocumentRecipientsUnauthorizedIssueTypedDict, RecipientUpdateDocumentRecipientsValue1, RecipientUpdateDocumentRecipientsValue1TypedDict, RecipientUpdateDocumentRecipientsValue2, RecipientUpdateDocumentRecipientsValue2TypedDict, RecipientUpdateDocumentRecipientsValue3, RecipientUpdateDocumentRecipientsValue3TypedDict, + RecipientUpdateDocumentRecipientsVerticalAlign1, + RecipientUpdateDocumentRecipientsVerticalAlign2, ) from .recipient_updatetemplaterecipientop import ( RecipientUpdateTemplateRecipientAccessAuthRequest, @@ -2101,6 +4179,8 @@ RecipientUpdateTemplateRecipientBadRequestErrorData, RecipientUpdateTemplateRecipientBadRequestIssue, RecipientUpdateTemplateRecipientBadRequestIssueTypedDict, + RecipientUpdateTemplateRecipientDirection1, + RecipientUpdateTemplateRecipientDirection2, RecipientUpdateTemplateRecipientField, RecipientUpdateTemplateRecipientFieldMetaCheckbox, RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict, @@ -2118,11 +4198,17 @@ RecipientUpdateTemplateRecipientFieldMetaNumberTypedDict, RecipientUpdateTemplateRecipientFieldMetaRadio, RecipientUpdateTemplateRecipientFieldMetaRadioTypedDict, + RecipientUpdateTemplateRecipientFieldMetaSignature, + RecipientUpdateTemplateRecipientFieldMetaSignatureTypedDict, RecipientUpdateTemplateRecipientFieldMetaText, RecipientUpdateTemplateRecipientFieldMetaTextTypedDict, RecipientUpdateTemplateRecipientFieldMetaUnion, RecipientUpdateTemplateRecipientFieldMetaUnionTypedDict, RecipientUpdateTemplateRecipientFieldTypedDict, + RecipientUpdateTemplateRecipientForbiddenError, + RecipientUpdateTemplateRecipientForbiddenErrorData, + RecipientUpdateTemplateRecipientForbiddenIssue, + RecipientUpdateTemplateRecipientForbiddenIssueTypedDict, RecipientUpdateTemplateRecipientInternalServerError, RecipientUpdateTemplateRecipientInternalServerErrorData, RecipientUpdateTemplateRecipientInternalServerErrorIssue, @@ -2153,13 +4239,20 @@ RecipientUpdateTemplateRecipientTypeName, RecipientUpdateTemplateRecipientTypeNumber, RecipientUpdateTemplateRecipientTypeRadio, + RecipientUpdateTemplateRecipientTypeSignature, RecipientUpdateTemplateRecipientTypeText, + RecipientUpdateTemplateRecipientUnauthorizedError, + RecipientUpdateTemplateRecipientUnauthorizedErrorData, + RecipientUpdateTemplateRecipientUnauthorizedIssue, + RecipientUpdateTemplateRecipientUnauthorizedIssueTypedDict, RecipientUpdateTemplateRecipientValue1, RecipientUpdateTemplateRecipientValue1TypedDict, RecipientUpdateTemplateRecipientValue2, RecipientUpdateTemplateRecipientValue2TypedDict, RecipientUpdateTemplateRecipientValue3, RecipientUpdateTemplateRecipientValue3TypedDict, + RecipientUpdateTemplateRecipientVerticalAlign1, + RecipientUpdateTemplateRecipientVerticalAlign2, ) from .recipient_updatetemplaterecipientsop import ( RecipientUpdateTemplateRecipientsAccessAuthRequest, @@ -2172,6 +4265,8 @@ RecipientUpdateTemplateRecipientsBadRequestErrorData, RecipientUpdateTemplateRecipientsBadRequestIssue, RecipientUpdateTemplateRecipientsBadRequestIssueTypedDict, + RecipientUpdateTemplateRecipientsDirection1, + RecipientUpdateTemplateRecipientsDirection2, RecipientUpdateTemplateRecipientsField, RecipientUpdateTemplateRecipientsFieldMetaCheckbox, RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict, @@ -2189,11 +4284,17 @@ RecipientUpdateTemplateRecipientsFieldMetaNumberTypedDict, RecipientUpdateTemplateRecipientsFieldMetaRadio, RecipientUpdateTemplateRecipientsFieldMetaRadioTypedDict, + RecipientUpdateTemplateRecipientsFieldMetaSignature, + RecipientUpdateTemplateRecipientsFieldMetaSignatureTypedDict, RecipientUpdateTemplateRecipientsFieldMetaText, RecipientUpdateTemplateRecipientsFieldMetaTextTypedDict, RecipientUpdateTemplateRecipientsFieldMetaUnion, RecipientUpdateTemplateRecipientsFieldMetaUnionTypedDict, RecipientUpdateTemplateRecipientsFieldTypedDict, + RecipientUpdateTemplateRecipientsForbiddenError, + RecipientUpdateTemplateRecipientsForbiddenErrorData, + RecipientUpdateTemplateRecipientsForbiddenIssue, + RecipientUpdateTemplateRecipientsForbiddenIssueTypedDict, RecipientUpdateTemplateRecipientsInternalServerError, RecipientUpdateTemplateRecipientsInternalServerErrorData, RecipientUpdateTemplateRecipientsInternalServerErrorIssue, @@ -2226,37 +4327,24 @@ RecipientUpdateTemplateRecipientsTypeName, RecipientUpdateTemplateRecipientsTypeNumber, RecipientUpdateTemplateRecipientsTypeRadio, + RecipientUpdateTemplateRecipientsTypeSignature, RecipientUpdateTemplateRecipientsTypeText, + RecipientUpdateTemplateRecipientsUnauthorizedError, + RecipientUpdateTemplateRecipientsUnauthorizedErrorData, + RecipientUpdateTemplateRecipientsUnauthorizedIssue, + RecipientUpdateTemplateRecipientsUnauthorizedIssueTypedDict, RecipientUpdateTemplateRecipientsValue1, RecipientUpdateTemplateRecipientsValue1TypedDict, RecipientUpdateTemplateRecipientsValue2, RecipientUpdateTemplateRecipientsValue2TypedDict, RecipientUpdateTemplateRecipientsValue3, RecipientUpdateTemplateRecipientsValue3TypedDict, + RecipientUpdateTemplateRecipientsVerticalAlign1, + RecipientUpdateTemplateRecipientsVerticalAlign2, ) from .responsevalidationerror import ResponseValidationError from .security import Security, SecurityTypedDict from .template_createdocumentfromtemplateop import ( - PrefillField, - PrefillFieldCheckbox, - PrefillFieldCheckboxTypedDict, - PrefillFieldDate, - PrefillFieldDateTypedDict, - PrefillFieldDropdown, - PrefillFieldDropdownTypedDict, - PrefillFieldNumber, - PrefillFieldNumberTypedDict, - PrefillFieldRadio, - PrefillFieldRadioTypedDict, - PrefillFieldText, - PrefillFieldTextTypedDict, - PrefillFieldTypeCheckbox, - PrefillFieldTypeDate, - PrefillFieldTypeDropdown, - PrefillFieldTypeNumber, - PrefillFieldTypeRadio, - PrefillFieldTypeText, - PrefillFieldTypedDict, TemplateCreateDocumentFromTemplateAccessAuth, TemplateCreateDocumentFromTemplateActionAuth, TemplateCreateDocumentFromTemplateAuthOptions, @@ -2265,6 +4353,10 @@ TemplateCreateDocumentFromTemplateBadRequestErrorData, TemplateCreateDocumentFromTemplateBadRequestIssue, TemplateCreateDocumentFromTemplateBadRequestIssueTypedDict, + TemplateCreateDocumentFromTemplateCustomDocumentDatum, + TemplateCreateDocumentFromTemplateCustomDocumentDatumTypedDict, + TemplateCreateDocumentFromTemplateDirection1, + TemplateCreateDocumentFromTemplateDirection2, TemplateCreateDocumentFromTemplateDistributionMethod, TemplateCreateDocumentFromTemplateDocumentData, TemplateCreateDocumentFromTemplateDocumentDataType, @@ -2273,6 +4365,8 @@ TemplateCreateDocumentFromTemplateDocumentMetaTypedDict, TemplateCreateDocumentFromTemplateEmailSettings, TemplateCreateDocumentFromTemplateEmailSettingsTypedDict, + TemplateCreateDocumentFromTemplateEnvelopeItem, + TemplateCreateDocumentFromTemplateEnvelopeItemTypedDict, TemplateCreateDocumentFromTemplateField, TemplateCreateDocumentFromTemplateFieldMetaCheckbox, TemplateCreateDocumentFromTemplateFieldMetaCheckboxTypedDict, @@ -2290,6 +4384,8 @@ TemplateCreateDocumentFromTemplateFieldMetaNumberTypedDict, TemplateCreateDocumentFromTemplateFieldMetaRadio, TemplateCreateDocumentFromTemplateFieldMetaRadioTypedDict, + TemplateCreateDocumentFromTemplateFieldMetaSignature, + TemplateCreateDocumentFromTemplateFieldMetaSignatureTypedDict, TemplateCreateDocumentFromTemplateFieldMetaText, TemplateCreateDocumentFromTemplateFieldMetaTextTypedDict, TemplateCreateDocumentFromTemplateFieldMetaTypeCheckbox, @@ -2306,6 +4402,10 @@ TemplateCreateDocumentFromTemplateFolderType, TemplateCreateDocumentFromTemplateFolderTypedDict, TemplateCreateDocumentFromTemplateFolderVisibility, + TemplateCreateDocumentFromTemplateForbiddenError, + TemplateCreateDocumentFromTemplateForbiddenErrorData, + TemplateCreateDocumentFromTemplateForbiddenIssue, + TemplateCreateDocumentFromTemplateForbiddenIssueTypedDict, TemplateCreateDocumentFromTemplateFormValues, TemplateCreateDocumentFromTemplateFormValuesTypedDict, TemplateCreateDocumentFromTemplateGlobalAccessAuth, @@ -2314,6 +4414,26 @@ TemplateCreateDocumentFromTemplateInternalServerErrorData, TemplateCreateDocumentFromTemplateInternalServerErrorIssue, TemplateCreateDocumentFromTemplateInternalServerErrorIssueTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldCheckbox, + TemplateCreateDocumentFromTemplatePrefillFieldCheckboxTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldDate, + TemplateCreateDocumentFromTemplatePrefillFieldDateTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldDropdown, + TemplateCreateDocumentFromTemplatePrefillFieldDropdownTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldNumber, + TemplateCreateDocumentFromTemplatePrefillFieldNumberTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldRadio, + TemplateCreateDocumentFromTemplatePrefillFieldRadioTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldText, + TemplateCreateDocumentFromTemplatePrefillFieldTextTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldTypeCheckbox, + TemplateCreateDocumentFromTemplatePrefillFieldTypeDate, + TemplateCreateDocumentFromTemplatePrefillFieldTypeDropdown, + TemplateCreateDocumentFromTemplatePrefillFieldTypeNumber, + TemplateCreateDocumentFromTemplatePrefillFieldTypeRadio, + TemplateCreateDocumentFromTemplatePrefillFieldTypeText, + TemplateCreateDocumentFromTemplatePrefillFieldUnion, + TemplateCreateDocumentFromTemplatePrefillFieldUnionTypedDict, TemplateCreateDocumentFromTemplateReadStatus, TemplateCreateDocumentFromTemplateRecipientAuthOptions, TemplateCreateDocumentFromTemplateRecipientAuthOptionsTypedDict, @@ -2340,12 +4460,19 @@ TemplateCreateDocumentFromTemplateTypeEmail, TemplateCreateDocumentFromTemplateTypeInitials, TemplateCreateDocumentFromTemplateTypeName, + TemplateCreateDocumentFromTemplateTypeSignature, + TemplateCreateDocumentFromTemplateUnauthorizedError, + TemplateCreateDocumentFromTemplateUnauthorizedErrorData, + TemplateCreateDocumentFromTemplateUnauthorizedIssue, + TemplateCreateDocumentFromTemplateUnauthorizedIssueTypedDict, TemplateCreateDocumentFromTemplateValue1, TemplateCreateDocumentFromTemplateValue1TypedDict, TemplateCreateDocumentFromTemplateValue2, TemplateCreateDocumentFromTemplateValue2TypedDict, TemplateCreateDocumentFromTemplateValue3, TemplateCreateDocumentFromTemplateValue3TypedDict, + TemplateCreateDocumentFromTemplateVerticalAlign1, + TemplateCreateDocumentFromTemplateVerticalAlign2, TemplateCreateDocumentFromTemplateVisibility, ) from .template_createtemplatedirectlinkop import ( @@ -2353,6 +4480,10 @@ TemplateCreateTemplateDirectLinkBadRequestErrorData, TemplateCreateTemplateDirectLinkBadRequestIssue, TemplateCreateTemplateDirectLinkBadRequestIssueTypedDict, + TemplateCreateTemplateDirectLinkForbiddenError, + TemplateCreateTemplateDirectLinkForbiddenErrorData, + TemplateCreateTemplateDirectLinkForbiddenIssue, + TemplateCreateTemplateDirectLinkForbiddenIssueTypedDict, TemplateCreateTemplateDirectLinkInternalServerError, TemplateCreateTemplateDirectLinkInternalServerErrorData, TemplateCreateTemplateDirectLinkInternalServerErrorIssue, @@ -2361,12 +4492,186 @@ TemplateCreateTemplateDirectLinkRequestTypedDict, TemplateCreateTemplateDirectLinkResponse, TemplateCreateTemplateDirectLinkResponseTypedDict, + TemplateCreateTemplateDirectLinkUnauthorizedError, + TemplateCreateTemplateDirectLinkUnauthorizedErrorData, + TemplateCreateTemplateDirectLinkUnauthorizedIssue, + TemplateCreateTemplateDirectLinkUnauthorizedIssueTypedDict, + ) + from .template_createtemplateop import ( + TemplateCreateTemplateAttachment, + TemplateCreateTemplateAttachmentTypedDict, + TemplateCreateTemplateBadRequestError, + TemplateCreateTemplateBadRequestErrorData, + TemplateCreateTemplateBadRequestIssue, + TemplateCreateTemplateBadRequestIssueTypedDict, + TemplateCreateTemplateDateFormat, + TemplateCreateTemplateDistributionMethod, + TemplateCreateTemplateEmailSettings, + TemplateCreateTemplateEmailSettingsTypedDict, + TemplateCreateTemplateFile, + TemplateCreateTemplateFileTypedDict, + TemplateCreateTemplateForbiddenError, + TemplateCreateTemplateForbiddenErrorData, + TemplateCreateTemplateForbiddenIssue, + TemplateCreateTemplateForbiddenIssueTypedDict, + TemplateCreateTemplateGlobalAccessAuth, + TemplateCreateTemplateGlobalActionAuth, + TemplateCreateTemplateInternalServerError, + TemplateCreateTemplateInternalServerErrorData, + TemplateCreateTemplateInternalServerErrorIssue, + TemplateCreateTemplateInternalServerErrorIssueTypedDict, + TemplateCreateTemplateLanguage, + TemplateCreateTemplateMeta, + TemplateCreateTemplateMetaTypedDict, + TemplateCreateTemplatePayload, + TemplateCreateTemplatePayloadTypedDict, + TemplateCreateTemplateRequest, + TemplateCreateTemplateRequestTypedDict, + TemplateCreateTemplateResponse, + TemplateCreateTemplateResponseTypedDict, + TemplateCreateTemplateSigningOrder, + TemplateCreateTemplateType, + TemplateCreateTemplateTypeLink, + TemplateCreateTemplateUnauthorizedError, + TemplateCreateTemplateUnauthorizedErrorData, + TemplateCreateTemplateUnauthorizedIssue, + TemplateCreateTemplateUnauthorizedIssueTypedDict, + TemplateCreateTemplateVisibility, + ) + from .template_createtemplatetemporaryop import ( + TemplateCreateTemplateTemporaryAccessAuth, + TemplateCreateTemplateTemporaryActionAuth, + TemplateCreateTemplateTemporaryAttachment, + TemplateCreateTemplateTemporaryAttachmentTypedDict, + TemplateCreateTemplateTemporaryAuthOptions, + TemplateCreateTemplateTemporaryAuthOptionsTypedDict, + TemplateCreateTemplateTemporaryBadRequestError, + TemplateCreateTemplateTemporaryBadRequestErrorData, + TemplateCreateTemplateTemporaryBadRequestIssue, + TemplateCreateTemplateTemporaryBadRequestIssueTypedDict, + TemplateCreateTemplateTemporaryDateFormat, + TemplateCreateTemplateTemporaryDirectLink, + TemplateCreateTemplateTemporaryDirectLinkTypedDict, + TemplateCreateTemplateTemporaryDirection1, + TemplateCreateTemplateTemporaryDirection2, + TemplateCreateTemplateTemporaryEnvelopeItem, + TemplateCreateTemplateTemporaryEnvelopeItemTypedDict, + TemplateCreateTemplateTemporaryField, + TemplateCreateTemplateTemporaryFieldMetaCheckbox, + TemplateCreateTemplateTemporaryFieldMetaCheckboxTypedDict, + TemplateCreateTemplateTemporaryFieldMetaDate, + TemplateCreateTemplateTemporaryFieldMetaDateTypedDict, + TemplateCreateTemplateTemporaryFieldMetaDropdown, + TemplateCreateTemplateTemporaryFieldMetaDropdownTypedDict, + TemplateCreateTemplateTemporaryFieldMetaEmail, + TemplateCreateTemplateTemporaryFieldMetaEmailTypedDict, + TemplateCreateTemplateTemporaryFieldMetaInitials, + TemplateCreateTemplateTemporaryFieldMetaInitialsTypedDict, + TemplateCreateTemplateTemporaryFieldMetaName, + TemplateCreateTemplateTemporaryFieldMetaNameTypedDict, + TemplateCreateTemplateTemporaryFieldMetaNumber, + TemplateCreateTemplateTemporaryFieldMetaNumberTypedDict, + TemplateCreateTemplateTemporaryFieldMetaRadio, + TemplateCreateTemplateTemporaryFieldMetaRadioTypedDict, + TemplateCreateTemplateTemporaryFieldMetaSignature, + TemplateCreateTemplateTemporaryFieldMetaSignatureTypedDict, + TemplateCreateTemplateTemporaryFieldMetaText, + TemplateCreateTemplateTemporaryFieldMetaTextTypedDict, + TemplateCreateTemplateTemporaryFieldMetaUnion, + TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict, + TemplateCreateTemplateTemporaryFieldType, + TemplateCreateTemplateTemporaryFieldTypedDict, + TemplateCreateTemplateTemporaryFolder, + TemplateCreateTemplateTemporaryFolderType, + TemplateCreateTemplateTemporaryFolderTypedDict, + TemplateCreateTemplateTemporaryFolderVisibility, + TemplateCreateTemplateTemporaryForbiddenError, + TemplateCreateTemplateTemporaryForbiddenErrorData, + TemplateCreateTemplateTemporaryForbiddenIssue, + TemplateCreateTemplateTemporaryForbiddenIssueTypedDict, + TemplateCreateTemplateTemporaryGlobalAccessAuthRequest, + TemplateCreateTemplateTemporaryGlobalAccessAuthResponse, + TemplateCreateTemplateTemporaryGlobalActionAuthRequest, + TemplateCreateTemplateTemporaryGlobalActionAuthResponse, + TemplateCreateTemplateTemporaryInternalServerError, + TemplateCreateTemplateTemporaryInternalServerErrorData, + TemplateCreateTemplateTemporaryInternalServerErrorIssue, + TemplateCreateTemplateTemporaryInternalServerErrorIssueTypedDict, + TemplateCreateTemplateTemporaryLanguage, + TemplateCreateTemplateTemporaryMeta, + TemplateCreateTemplateTemporaryMetaDistributionMethod, + TemplateCreateTemplateTemporaryMetaEmailSettings, + TemplateCreateTemplateTemporaryMetaEmailSettingsTypedDict, + 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, + TemplateCreateTemplateTemporaryTypeLink, + TemplateCreateTemplateTemporaryTypeName, + TemplateCreateTemplateTemporaryTypeNumber, + TemplateCreateTemplateTemporaryTypeRadio, + TemplateCreateTemplateTemporaryTypeRequest, + TemplateCreateTemplateTemporaryTypeResponse, + TemplateCreateTemplateTemporaryTypeSignature, + TemplateCreateTemplateTemporaryTypeText, + TemplateCreateTemplateTemporaryUnauthorizedError, + TemplateCreateTemplateTemporaryUnauthorizedErrorData, + TemplateCreateTemplateTemporaryUnauthorizedIssue, + TemplateCreateTemplateTemporaryUnauthorizedIssueTypedDict, + TemplateCreateTemplateTemporaryUser, + TemplateCreateTemplateTemporaryUserTypedDict, + TemplateCreateTemplateTemporaryValue1, + TemplateCreateTemplateTemporaryValue1TypedDict, + TemplateCreateTemplateTemporaryValue2, + TemplateCreateTemplateTemporaryValue2TypedDict, + TemplateCreateTemplateTemporaryValue3, + TemplateCreateTemplateTemporaryValue3TypedDict, + TemplateCreateTemplateTemporaryVerticalAlign1, + TemplateCreateTemplateTemporaryVerticalAlign2, + TemplateCreateTemplateTemporaryVisibilityRequest, + TemplateCreateTemplateTemporaryVisibilityResponse, ) from .template_deletetemplatedirectlinkop import ( TemplateDeleteTemplateDirectLinkBadRequestError, TemplateDeleteTemplateDirectLinkBadRequestErrorData, TemplateDeleteTemplateDirectLinkBadRequestIssue, TemplateDeleteTemplateDirectLinkBadRequestIssueTypedDict, + TemplateDeleteTemplateDirectLinkForbiddenError, + TemplateDeleteTemplateDirectLinkForbiddenErrorData, + TemplateDeleteTemplateDirectLinkForbiddenIssue, + TemplateDeleteTemplateDirectLinkForbiddenIssueTypedDict, TemplateDeleteTemplateDirectLinkInternalServerError, TemplateDeleteTemplateDirectLinkInternalServerErrorData, TemplateDeleteTemplateDirectLinkInternalServerErrorIssue, @@ -2375,12 +4680,20 @@ TemplateDeleteTemplateDirectLinkRequestTypedDict, TemplateDeleteTemplateDirectLinkResponse, TemplateDeleteTemplateDirectLinkResponseTypedDict, + TemplateDeleteTemplateDirectLinkUnauthorizedError, + TemplateDeleteTemplateDirectLinkUnauthorizedErrorData, + TemplateDeleteTemplateDirectLinkUnauthorizedIssue, + TemplateDeleteTemplateDirectLinkUnauthorizedIssueTypedDict, ) from .template_deletetemplateop import ( TemplateDeleteTemplateBadRequestError, TemplateDeleteTemplateBadRequestErrorData, TemplateDeleteTemplateBadRequestIssue, TemplateDeleteTemplateBadRequestIssueTypedDict, + TemplateDeleteTemplateForbiddenError, + TemplateDeleteTemplateForbiddenErrorData, + TemplateDeleteTemplateForbiddenIssue, + TemplateDeleteTemplateForbiddenIssueTypedDict, TemplateDeleteTemplateInternalServerError, TemplateDeleteTemplateInternalServerErrorData, TemplateDeleteTemplateInternalServerErrorIssue, @@ -2389,6 +4702,10 @@ TemplateDeleteTemplateRequestTypedDict, TemplateDeleteTemplateResponse, TemplateDeleteTemplateResponseTypedDict, + TemplateDeleteTemplateUnauthorizedError, + TemplateDeleteTemplateUnauthorizedErrorData, + TemplateDeleteTemplateUnauthorizedIssue, + TemplateDeleteTemplateUnauthorizedIssueTypedDict, ) from .template_duplicatetemplateop import ( TemplateDuplicateTemplateAuthOptions, @@ -2397,6 +4714,10 @@ TemplateDuplicateTemplateBadRequestErrorData, TemplateDuplicateTemplateBadRequestIssue, TemplateDuplicateTemplateBadRequestIssueTypedDict, + TemplateDuplicateTemplateForbiddenError, + TemplateDuplicateTemplateForbiddenErrorData, + TemplateDuplicateTemplateForbiddenIssue, + TemplateDuplicateTemplateForbiddenIssueTypedDict, TemplateDuplicateTemplateGlobalAccessAuth, TemplateDuplicateTemplateGlobalActionAuth, TemplateDuplicateTemplateInternalServerError, @@ -2408,10 +4729,13 @@ TemplateDuplicateTemplateResponse, TemplateDuplicateTemplateResponseTypedDict, TemplateDuplicateTemplateType, + TemplateDuplicateTemplateUnauthorizedError, + TemplateDuplicateTemplateUnauthorizedErrorData, + TemplateDuplicateTemplateUnauthorizedIssue, + TemplateDuplicateTemplateUnauthorizedIssueTypedDict, TemplateDuplicateTemplateVisibility, ) from .template_findtemplatesop import ( - QueryParamType, TemplateFindTemplatesAccessAuth, TemplateFindTemplatesActionAuth, TemplateFindTemplatesAuthOptions, @@ -2425,6 +4749,8 @@ TemplateFindTemplatesDataTypedDict, TemplateFindTemplatesDirectLink, TemplateFindTemplatesDirectLinkTypedDict, + TemplateFindTemplatesDirection1, + TemplateFindTemplatesDirection2, TemplateFindTemplatesDistributionMethod, TemplateFindTemplatesField, TemplateFindTemplatesFieldMetaCheckbox, @@ -2443,12 +4769,18 @@ TemplateFindTemplatesFieldMetaNumberTypedDict, TemplateFindTemplatesFieldMetaRadio, TemplateFindTemplatesFieldMetaRadioTypedDict, + TemplateFindTemplatesFieldMetaSignature, + TemplateFindTemplatesFieldMetaSignatureTypedDict, TemplateFindTemplatesFieldMetaText, TemplateFindTemplatesFieldMetaTextTypedDict, TemplateFindTemplatesFieldMetaUnion, TemplateFindTemplatesFieldMetaUnionTypedDict, TemplateFindTemplatesFieldType, TemplateFindTemplatesFieldTypedDict, + TemplateFindTemplatesForbiddenError, + TemplateFindTemplatesForbiddenErrorData, + TemplateFindTemplatesForbiddenIssue, + TemplateFindTemplatesForbiddenIssueTypedDict, TemplateFindTemplatesGlobalAccessAuth, TemplateFindTemplatesGlobalActionAuth, TemplateFindTemplatesInternalServerError, @@ -2459,6 +4791,7 @@ TemplateFindTemplatesNotFoundErrorData, TemplateFindTemplatesNotFoundIssue, TemplateFindTemplatesNotFoundIssueTypedDict, + TemplateFindTemplatesQueryParamType, TemplateFindTemplatesReadStatus, TemplateFindTemplatesRecipient, TemplateFindTemplatesRecipientAuthOptions, @@ -2490,19 +4823,23 @@ TemplateFindTemplatesTypeName, TemplateFindTemplatesTypeNumber, TemplateFindTemplatesTypeRadio, + TemplateFindTemplatesTypeSignature, TemplateFindTemplatesTypeText, + TemplateFindTemplatesUnauthorizedError, + TemplateFindTemplatesUnauthorizedErrorData, + TemplateFindTemplatesUnauthorizedIssue, + TemplateFindTemplatesUnauthorizedIssueTypedDict, TemplateFindTemplatesValue1, TemplateFindTemplatesValue1TypedDict, TemplateFindTemplatesValue2, TemplateFindTemplatesValue2TypedDict, TemplateFindTemplatesValue3, TemplateFindTemplatesValue3TypedDict, + TemplateFindTemplatesVerticalAlign1, + TemplateFindTemplatesVerticalAlign2, TemplateFindTemplatesVisibility, ) from .template_gettemplatebyidop import ( - TemplateDocumentData, - TemplateDocumentDataType, - TemplateDocumentDataTypedDict, TemplateGetTemplateByIDAccessAuth, TemplateGetTemplateByIDActionAuth, TemplateGetTemplateByIDAuthOptions, @@ -2513,9 +4850,13 @@ TemplateGetTemplateByIDBadRequestIssueTypedDict, TemplateGetTemplateByIDDirectLink, TemplateGetTemplateByIDDirectLinkTypedDict, + TemplateGetTemplateByIDDirection1, + TemplateGetTemplateByIDDirection2, TemplateGetTemplateByIDDistributionMethod, TemplateGetTemplateByIDEmailSettings, TemplateGetTemplateByIDEmailSettingsTypedDict, + TemplateGetTemplateByIDEnvelopeItem, + TemplateGetTemplateByIDEnvelopeItemTypedDict, TemplateGetTemplateByIDField, TemplateGetTemplateByIDFieldMetaCheckbox, TemplateGetTemplateByIDFieldMetaCheckboxTypedDict, @@ -2533,6 +4874,8 @@ TemplateGetTemplateByIDFieldMetaNumberTypedDict, TemplateGetTemplateByIDFieldMetaRadio, TemplateGetTemplateByIDFieldMetaRadioTypedDict, + TemplateGetTemplateByIDFieldMetaSignature, + TemplateGetTemplateByIDFieldMetaSignatureTypedDict, TemplateGetTemplateByIDFieldMetaText, TemplateGetTemplateByIDFieldMetaTextTypedDict, TemplateGetTemplateByIDFieldMetaUnion, @@ -2543,6 +4886,10 @@ TemplateGetTemplateByIDFolderType, TemplateGetTemplateByIDFolderTypedDict, TemplateGetTemplateByIDFolderVisibility, + TemplateGetTemplateByIDForbiddenError, + TemplateGetTemplateByIDForbiddenErrorData, + TemplateGetTemplateByIDForbiddenIssue, + TemplateGetTemplateByIDForbiddenIssueTypedDict, TemplateGetTemplateByIDGlobalAccessAuth, TemplateGetTemplateByIDGlobalActionAuth, TemplateGetTemplateByIDInternalServerError, @@ -2566,6 +4913,9 @@ TemplateGetTemplateByIDSendStatus, TemplateGetTemplateByIDSigningOrder, TemplateGetTemplateByIDSigningStatus, + TemplateGetTemplateByIDTemplateDocumentData, + TemplateGetTemplateByIDTemplateDocumentDataType, + TemplateGetTemplateByIDTemplateDocumentDataTypedDict, TemplateGetTemplateByIDTemplateMeta, TemplateGetTemplateByIDTemplateMetaTypedDict, TemplateGetTemplateByIDTextAlign1, @@ -2583,7 +4933,12 @@ TemplateGetTemplateByIDTypeName, TemplateGetTemplateByIDTypeNumber, TemplateGetTemplateByIDTypeRadio, + TemplateGetTemplateByIDTypeSignature, TemplateGetTemplateByIDTypeText, + TemplateGetTemplateByIDUnauthorizedError, + TemplateGetTemplateByIDUnauthorizedErrorData, + TemplateGetTemplateByIDUnauthorizedIssue, + TemplateGetTemplateByIDUnauthorizedIssueTypedDict, TemplateGetTemplateByIDUser, TemplateGetTemplateByIDUserTypedDict, TemplateGetTemplateByIDValue1, @@ -2592,6 +4947,8 @@ TemplateGetTemplateByIDValue2TypedDict, TemplateGetTemplateByIDValue3, TemplateGetTemplateByIDValue3TypedDict, + TemplateGetTemplateByIDVerticalAlign1, + TemplateGetTemplateByIDVerticalAlign2, TemplateGetTemplateByIDVisibility, ) from .template_toggletemplatedirectlinkop import ( @@ -2599,6 +4956,10 @@ TemplateToggleTemplateDirectLinkBadRequestErrorData, TemplateToggleTemplateDirectLinkBadRequestIssue, TemplateToggleTemplateDirectLinkBadRequestIssueTypedDict, + TemplateToggleTemplateDirectLinkForbiddenError, + TemplateToggleTemplateDirectLinkForbiddenErrorData, + TemplateToggleTemplateDirectLinkForbiddenIssue, + TemplateToggleTemplateDirectLinkForbiddenIssueTypedDict, TemplateToggleTemplateDirectLinkInternalServerError, TemplateToggleTemplateDirectLinkInternalServerErrorData, TemplateToggleTemplateDirectLinkInternalServerErrorIssue, @@ -2607,6 +4968,10 @@ TemplateToggleTemplateDirectLinkRequestTypedDict, TemplateToggleTemplateDirectLinkResponse, TemplateToggleTemplateDirectLinkResponseTypedDict, + TemplateToggleTemplateDirectLinkUnauthorizedError, + TemplateToggleTemplateDirectLinkUnauthorizedErrorData, + TemplateToggleTemplateDirectLinkUnauthorizedIssue, + TemplateToggleTemplateDirectLinkUnauthorizedIssueTypedDict, ) from .template_updatetemplateop import ( TemplateUpdateTemplateAuthOptions, @@ -2616,15 +4981,20 @@ TemplateUpdateTemplateBadRequestIssue, TemplateUpdateTemplateBadRequestIssueTypedDict, TemplateUpdateTemplateData, + TemplateUpdateTemplateDataGlobalAccessAuth, + TemplateUpdateTemplateDataGlobalActionAuth, TemplateUpdateTemplateDataType, TemplateUpdateTemplateDataTypedDict, + TemplateUpdateTemplateDataVisibility, TemplateUpdateTemplateDateFormat, TemplateUpdateTemplateDistributionMethod, TemplateUpdateTemplateEmailSettings, TemplateUpdateTemplateEmailSettingsTypedDict, - TemplateUpdateTemplateGlobalAccessAuthRequest, + TemplateUpdateTemplateForbiddenError, + TemplateUpdateTemplateForbiddenErrorData, + TemplateUpdateTemplateForbiddenIssue, + TemplateUpdateTemplateForbiddenIssueTypedDict, TemplateUpdateTemplateGlobalAccessAuthResponse, - TemplateUpdateTemplateGlobalActionAuthRequest, TemplateUpdateTemplateGlobalActionAuthResponse, TemplateUpdateTemplateInternalServerError, TemplateUpdateTemplateInternalServerErrorData, @@ -2639,7 +5009,10 @@ TemplateUpdateTemplateResponseTypedDict, TemplateUpdateTemplateSigningOrder, TemplateUpdateTemplateTypeResponse, - TemplateUpdateTemplateVisibilityRequest, + TemplateUpdateTemplateUnauthorizedError, + TemplateUpdateTemplateUnauthorizedErrorData, + TemplateUpdateTemplateUnauthorizedIssue, + TemplateUpdateTemplateUnauthorizedIssueTypedDict, TemplateUpdateTemplateVisibilityResponse, ) @@ -2648,11 +5021,115 @@ "DataSource", "DataStatus", "DocumensoError", - "Document", "DocumentAccessAuth", "DocumentActionAuth", + "DocumentAttachmentCreateBadRequestError", + "DocumentAttachmentCreateBadRequestErrorData", + "DocumentAttachmentCreateBadRequestIssue", + "DocumentAttachmentCreateBadRequestIssueTypedDict", + "DocumentAttachmentCreateData", + "DocumentAttachmentCreateDataTypedDict", + "DocumentAttachmentCreateForbiddenError", + "DocumentAttachmentCreateForbiddenErrorData", + "DocumentAttachmentCreateForbiddenIssue", + "DocumentAttachmentCreateForbiddenIssueTypedDict", + "DocumentAttachmentCreateInternalServerError", + "DocumentAttachmentCreateInternalServerErrorData", + "DocumentAttachmentCreateInternalServerErrorIssue", + "DocumentAttachmentCreateInternalServerErrorIssueTypedDict", + "DocumentAttachmentCreateRequest", + "DocumentAttachmentCreateRequestTypedDict", + "DocumentAttachmentCreateResponse", + "DocumentAttachmentCreateResponseTypedDict", + "DocumentAttachmentCreateUnauthorizedError", + "DocumentAttachmentCreateUnauthorizedErrorData", + "DocumentAttachmentCreateUnauthorizedIssue", + "DocumentAttachmentCreateUnauthorizedIssueTypedDict", + "DocumentAttachmentDeleteBadRequestError", + "DocumentAttachmentDeleteBadRequestErrorData", + "DocumentAttachmentDeleteBadRequestIssue", + "DocumentAttachmentDeleteBadRequestIssueTypedDict", + "DocumentAttachmentDeleteForbiddenError", + "DocumentAttachmentDeleteForbiddenErrorData", + "DocumentAttachmentDeleteForbiddenIssue", + "DocumentAttachmentDeleteForbiddenIssueTypedDict", + "DocumentAttachmentDeleteInternalServerError", + "DocumentAttachmentDeleteInternalServerErrorData", + "DocumentAttachmentDeleteInternalServerErrorIssue", + "DocumentAttachmentDeleteInternalServerErrorIssueTypedDict", + "DocumentAttachmentDeleteRequest", + "DocumentAttachmentDeleteRequestTypedDict", + "DocumentAttachmentDeleteResponse", + "DocumentAttachmentDeleteResponseTypedDict", + "DocumentAttachmentDeleteUnauthorizedError", + "DocumentAttachmentDeleteUnauthorizedErrorData", + "DocumentAttachmentDeleteUnauthorizedIssue", + "DocumentAttachmentDeleteUnauthorizedIssueTypedDict", + "DocumentAttachmentFindBadRequestError", + "DocumentAttachmentFindBadRequestErrorData", + "DocumentAttachmentFindBadRequestIssue", + "DocumentAttachmentFindBadRequestIssueTypedDict", + "DocumentAttachmentFindData", + "DocumentAttachmentFindDataTypedDict", + "DocumentAttachmentFindForbiddenError", + "DocumentAttachmentFindForbiddenErrorData", + "DocumentAttachmentFindForbiddenIssue", + "DocumentAttachmentFindForbiddenIssueTypedDict", + "DocumentAttachmentFindInternalServerError", + "DocumentAttachmentFindInternalServerErrorData", + "DocumentAttachmentFindInternalServerErrorIssue", + "DocumentAttachmentFindInternalServerErrorIssueTypedDict", + "DocumentAttachmentFindNotFoundError", + "DocumentAttachmentFindNotFoundErrorData", + "DocumentAttachmentFindNotFoundIssue", + "DocumentAttachmentFindNotFoundIssueTypedDict", + "DocumentAttachmentFindRequest", + "DocumentAttachmentFindRequestTypedDict", + "DocumentAttachmentFindResponse", + "DocumentAttachmentFindResponseTypedDict", + "DocumentAttachmentFindType", + "DocumentAttachmentFindUnauthorizedError", + "DocumentAttachmentFindUnauthorizedErrorData", + "DocumentAttachmentFindUnauthorizedIssue", + "DocumentAttachmentFindUnauthorizedIssueTypedDict", + "DocumentAttachmentUpdateBadRequestError", + "DocumentAttachmentUpdateBadRequestErrorData", + "DocumentAttachmentUpdateBadRequestIssue", + "DocumentAttachmentUpdateBadRequestIssueTypedDict", + "DocumentAttachmentUpdateData", + "DocumentAttachmentUpdateDataTypedDict", + "DocumentAttachmentUpdateForbiddenError", + "DocumentAttachmentUpdateForbiddenErrorData", + "DocumentAttachmentUpdateForbiddenIssue", + "DocumentAttachmentUpdateForbiddenIssueTypedDict", + "DocumentAttachmentUpdateInternalServerError", + "DocumentAttachmentUpdateInternalServerErrorData", + "DocumentAttachmentUpdateInternalServerErrorIssue", + "DocumentAttachmentUpdateInternalServerErrorIssueTypedDict", + "DocumentAttachmentUpdateRequest", + "DocumentAttachmentUpdateRequestTypedDict", + "DocumentAttachmentUpdateResponse", + "DocumentAttachmentUpdateResponseTypedDict", + "DocumentAttachmentUpdateUnauthorizedError", + "DocumentAttachmentUpdateUnauthorizedErrorData", + "DocumentAttachmentUpdateUnauthorizedIssue", + "DocumentAttachmentUpdateUnauthorizedIssueTypedDict", + "DocumentCreateAccessAuth", + "DocumentCreateActionAuth", + "DocumentCreateAttachment", + "DocumentCreateAttachmentTypedDict", + "DocumentCreateBadRequestError", + "DocumentCreateBadRequestErrorData", + "DocumentCreateBadRequestIssue", + "DocumentCreateBadRequestIssueTypedDict", + "DocumentCreateDateFormat", + "DocumentCreateDirectionCheckbox", + "DocumentCreateDirectionRadio", + "DocumentCreateDistributionMethod", "DocumentCreateDocumentTemporaryAccessAuthRequest", "DocumentCreateDocumentTemporaryActionAuthRequest", + "DocumentCreateDocumentTemporaryAttachment", + "DocumentCreateDocumentTemporaryAttachmentTypedDict", "DocumentCreateDocumentTemporaryAuthOptions", "DocumentCreateDocumentTemporaryAuthOptionsTypedDict", "DocumentCreateDocumentTemporaryBadRequestError", @@ -2660,13 +5137,16 @@ "DocumentCreateDocumentTemporaryBadRequestIssue", "DocumentCreateDocumentTemporaryBadRequestIssueTypedDict", "DocumentCreateDocumentTemporaryDateFormat", - "DocumentCreateDocumentTemporaryDistributionMethodRequest", + "DocumentCreateDocumentTemporaryDirectionCheckbox", + "DocumentCreateDocumentTemporaryDirectionRadio", + "DocumentCreateDocumentTemporaryDocument", "DocumentCreateDocumentTemporaryDocumentData", "DocumentCreateDocumentTemporaryDocumentDataTypedDict", "DocumentCreateDocumentTemporaryDocumentMeta", "DocumentCreateDocumentTemporaryDocumentMetaTypedDict", - "DocumentCreateDocumentTemporaryEmailSettingsRequest", - "DocumentCreateDocumentTemporaryEmailSettingsRequestTypedDict", + "DocumentCreateDocumentTemporaryDocumentTypedDict", + "DocumentCreateDocumentTemporaryEnvelopeItem", + "DocumentCreateDocumentTemporaryEnvelopeItemTypedDict", "DocumentCreateDocumentTemporaryFieldCheckbox", "DocumentCreateDocumentTemporaryFieldCheckboxTypedDict", "DocumentCreateDocumentTemporaryFieldDate", @@ -2693,6 +5173,12 @@ "DocumentCreateDocumentTemporaryFieldUnionTypedDict", "DocumentCreateDocumentTemporaryFolder", "DocumentCreateDocumentTemporaryFolderTypedDict", + "DocumentCreateDocumentTemporaryForbiddenError", + "DocumentCreateDocumentTemporaryForbiddenErrorData", + "DocumentCreateDocumentTemporaryForbiddenIssue", + "DocumentCreateDocumentTemporaryForbiddenIssueTypedDict", + "DocumentCreateDocumentTemporaryFormValuesRequest", + "DocumentCreateDocumentTemporaryFormValuesRequestTypedDict", "DocumentCreateDocumentTemporaryGlobalAccessAuthRequest", "DocumentCreateDocumentTemporaryGlobalActionAuthRequest", "DocumentCreateDocumentTemporaryInternalServerError", @@ -2701,6 +5187,9 @@ "DocumentCreateDocumentTemporaryInternalServerErrorIssueTypedDict", "DocumentCreateDocumentTemporaryLanguage", "DocumentCreateDocumentTemporaryMeta", + "DocumentCreateDocumentTemporaryMetaDistributionMethod", + "DocumentCreateDocumentTemporaryMetaEmailSettings", + "DocumentCreateDocumentTemporaryMetaEmailSettingsTypedDict", "DocumentCreateDocumentTemporaryMetaTypedDict", "DocumentCreateDocumentTemporaryReadStatus", "DocumentCreateDocumentTemporaryRecipientAuthOptions", @@ -2721,6 +5210,8 @@ "DocumentCreateDocumentTemporaryRecipientFieldMetaNumberTypedDict", "DocumentCreateDocumentTemporaryRecipientFieldMetaRadio", "DocumentCreateDocumentTemporaryRecipientFieldMetaRadioTypedDict", + "DocumentCreateDocumentTemporaryRecipientFieldMetaSignature", + "DocumentCreateDocumentTemporaryRecipientFieldMetaSignatureTypedDict", "DocumentCreateDocumentTemporaryRecipientFieldMetaText", "DocumentCreateDocumentTemporaryRecipientFieldMetaTextTypedDict", "DocumentCreateDocumentTemporaryRecipientRequest", @@ -2741,6 +5232,8 @@ "DocumentCreateDocumentTemporaryRecipientTypeNumber2", "DocumentCreateDocumentTemporaryRecipientTypeRadio1", "DocumentCreateDocumentTemporaryRecipientTypeRadio2", + "DocumentCreateDocumentTemporaryRecipientTypeSignature1", + "DocumentCreateDocumentTemporaryRecipientTypeSignature2", "DocumentCreateDocumentTemporaryRecipientTypeText1", "DocumentCreateDocumentTemporaryRecipientTypeText2", "DocumentCreateDocumentTemporaryRequest", @@ -2760,40 +5253,264 @@ "DocumentCreateDocumentTemporaryTextAlignNumber", "DocumentCreateDocumentTemporaryTextAlignText", "DocumentCreateDocumentTemporaryTypeFreeSignature", - "DocumentCreateDocumentTemporaryTypeSignature", + "DocumentCreateDocumentTemporaryTypeLink", + "DocumentCreateDocumentTemporaryUnauthorizedError", + "DocumentCreateDocumentTemporaryUnauthorizedErrorData", + "DocumentCreateDocumentTemporaryUnauthorizedIssue", + "DocumentCreateDocumentTemporaryUnauthorizedIssueTypedDict", "DocumentCreateDocumentTemporaryValueCheckbox", "DocumentCreateDocumentTemporaryValueCheckboxTypedDict", "DocumentCreateDocumentTemporaryValueDropdown", "DocumentCreateDocumentTemporaryValueDropdownTypedDict", "DocumentCreateDocumentTemporaryValueRadio", "DocumentCreateDocumentTemporaryValueRadioTypedDict", + "DocumentCreateDocumentTemporaryVerticalAlignNumber", + "DocumentCreateDocumentTemporaryVerticalAlignText", "DocumentCreateDocumentTemporaryVisibilityRequest", - "DocumentDeleteDocumentBadRequestError", - "DocumentDeleteDocumentBadRequestErrorData", - "DocumentDeleteDocumentBadRequestIssue", - "DocumentDeleteDocumentBadRequestIssueTypedDict", - "DocumentDeleteDocumentInternalServerError", - "DocumentDeleteDocumentInternalServerErrorData", - "DocumentDeleteDocumentInternalServerErrorIssue", - "DocumentDeleteDocumentInternalServerErrorIssueTypedDict", - "DocumentDeleteDocumentRequest", - "DocumentDeleteDocumentRequestTypedDict", - "DocumentDeleteDocumentResponse", - "DocumentDeleteDocumentResponseTypedDict", + "DocumentCreateEmailSettings", + "DocumentCreateEmailSettingsTypedDict", + "DocumentCreateFieldCheckbox", + "DocumentCreateFieldCheckboxTypedDict", + "DocumentCreateFieldDate", + "DocumentCreateFieldDateTypedDict", + "DocumentCreateFieldDropdown", + "DocumentCreateFieldDropdownTypedDict", + "DocumentCreateFieldEmail", + "DocumentCreateFieldEmailTypedDict", + "DocumentCreateFieldFreeSignature", + "DocumentCreateFieldFreeSignatureTypedDict", + "DocumentCreateFieldInitials", + "DocumentCreateFieldInitialsTypedDict", + "DocumentCreateFieldMetaCheckbox", + "DocumentCreateFieldMetaCheckboxTypedDict", + "DocumentCreateFieldMetaDate", + "DocumentCreateFieldMetaDateTypedDict", + "DocumentCreateFieldMetaDropdown", + "DocumentCreateFieldMetaDropdownTypedDict", + "DocumentCreateFieldMetaEmail", + "DocumentCreateFieldMetaEmailTypedDict", + "DocumentCreateFieldMetaInitials", + "DocumentCreateFieldMetaInitialsTypedDict", + "DocumentCreateFieldMetaName", + "DocumentCreateFieldMetaNameTypedDict", + "DocumentCreateFieldMetaNumber", + "DocumentCreateFieldMetaNumberTypedDict", + "DocumentCreateFieldMetaRadio", + "DocumentCreateFieldMetaRadioTypedDict", + "DocumentCreateFieldMetaSignature", + "DocumentCreateFieldMetaSignatureTypedDict", + "DocumentCreateFieldMetaText", + "DocumentCreateFieldMetaTextTypedDict", + "DocumentCreateFieldName", + "DocumentCreateFieldNameTypedDict", + "DocumentCreateFieldNumber", + "DocumentCreateFieldNumberTypedDict", + "DocumentCreateFieldRadio", + "DocumentCreateFieldRadioTypedDict", + "DocumentCreateFieldSignature", + "DocumentCreateFieldSignatureTypedDict", + "DocumentCreateFieldText", + "DocumentCreateFieldTextTypedDict", + "DocumentCreateFieldUnion", + "DocumentCreateFieldUnionTypedDict", + "DocumentCreateFile", + "DocumentCreateFileTypedDict", + "DocumentCreateForbiddenError", + "DocumentCreateForbiddenErrorData", + "DocumentCreateForbiddenIssue", + "DocumentCreateForbiddenIssueTypedDict", + "DocumentCreateFormValues", + "DocumentCreateFormValuesTypedDict", + "DocumentCreateGlobalAccessAuth", + "DocumentCreateGlobalActionAuth", + "DocumentCreateInternalServerError", + "DocumentCreateInternalServerErrorData", + "DocumentCreateInternalServerErrorIssue", + "DocumentCreateInternalServerErrorIssueTypedDict", + "DocumentCreateLanguage", + "DocumentCreateMeta", + "DocumentCreateMetaTypedDict", + "DocumentCreatePayload", + "DocumentCreatePayloadTypedDict", + "DocumentCreateRecipient", + "DocumentCreateRecipientTypedDict", + "DocumentCreateRequest", + "DocumentCreateRequestTypedDict", + "DocumentCreateResponse", + "DocumentCreateResponseTypedDict", + "DocumentCreateRole", + "DocumentCreateSigningOrder", + "DocumentCreateTextAlignDate", + "DocumentCreateTextAlignEmail", + "DocumentCreateTextAlignInitials", + "DocumentCreateTextAlignName", + "DocumentCreateTextAlignNumber", + "DocumentCreateTextAlignText", + "DocumentCreateTypeCheckbox1", + "DocumentCreateTypeCheckbox2", + "DocumentCreateTypeDate1", + "DocumentCreateTypeDate2", + "DocumentCreateTypeDropdown1", + "DocumentCreateTypeDropdown2", + "DocumentCreateTypeEmail1", + "DocumentCreateTypeEmail2", + "DocumentCreateTypeFreeSignature", + "DocumentCreateTypeInitials1", + "DocumentCreateTypeInitials2", + "DocumentCreateTypeLink", + "DocumentCreateTypeName1", + "DocumentCreateTypeName2", + "DocumentCreateTypeNumber1", + "DocumentCreateTypeNumber2", + "DocumentCreateTypeRadio1", + "DocumentCreateTypeRadio2", + "DocumentCreateTypeSignature1", + "DocumentCreateTypeSignature2", + "DocumentCreateTypeText1", + "DocumentCreateTypeText2", + "DocumentCreateUnauthorizedError", + "DocumentCreateUnauthorizedErrorData", + "DocumentCreateUnauthorizedIssue", + "DocumentCreateUnauthorizedIssueTypedDict", + "DocumentCreateValueCheckbox", + "DocumentCreateValueCheckboxTypedDict", + "DocumentCreateValueDropdown", + "DocumentCreateValueDropdownTypedDict", + "DocumentCreateValueRadio", + "DocumentCreateValueRadioTypedDict", + "DocumentCreateVerticalAlignNumber", + "DocumentCreateVerticalAlignText", + "DocumentCreateVisibility", + "DocumentDeleteBadRequestError", + "DocumentDeleteBadRequestErrorData", + "DocumentDeleteBadRequestIssue", + "DocumentDeleteBadRequestIssueTypedDict", + "DocumentDeleteForbiddenError", + "DocumentDeleteForbiddenErrorData", + "DocumentDeleteForbiddenIssue", + "DocumentDeleteForbiddenIssueTypedDict", + "DocumentDeleteInternalServerError", + "DocumentDeleteInternalServerErrorData", + "DocumentDeleteInternalServerErrorIssue", + "DocumentDeleteInternalServerErrorIssueTypedDict", + "DocumentDeleteRequest", + "DocumentDeleteRequestTypedDict", + "DocumentDeleteResponse", + "DocumentDeleteResponseTypedDict", + "DocumentDeleteUnauthorizedError", + "DocumentDeleteUnauthorizedErrorData", + "DocumentDeleteUnauthorizedIssue", + "DocumentDeleteUnauthorizedIssueTypedDict", + "DocumentDirection1", + "DocumentDirection2", + "DocumentDistributeAuthOptions", + "DocumentDistributeAuthOptionsTypedDict", + "DocumentDistributeBadRequestError", + "DocumentDistributeBadRequestErrorData", + "DocumentDistributeBadRequestIssue", + "DocumentDistributeBadRequestIssueTypedDict", + "DocumentDistributeDateFormat", + "DocumentDistributeDistributionMethod", + "DocumentDistributeEmailSettings", + "DocumentDistributeEmailSettingsTypedDict", + "DocumentDistributeForbiddenError", + "DocumentDistributeForbiddenErrorData", + "DocumentDistributeForbiddenIssue", + "DocumentDistributeForbiddenIssueTypedDict", + "DocumentDistributeFormValues", + "DocumentDistributeFormValuesTypedDict", + "DocumentDistributeGlobalAccessAuth", + "DocumentDistributeGlobalActionAuth", + "DocumentDistributeInternalServerError", + "DocumentDistributeInternalServerErrorData", + "DocumentDistributeInternalServerErrorIssue", + "DocumentDistributeInternalServerErrorIssueTypedDict", + "DocumentDistributeLanguage", + "DocumentDistributeMeta", + "DocumentDistributeMetaTypedDict", + "DocumentDistributeRequest", + "DocumentDistributeRequestTypedDict", + "DocumentDistributeResponse", + "DocumentDistributeResponseTypedDict", + "DocumentDistributeSource", + "DocumentDistributeStatus", + "DocumentDistributeUnauthorizedError", + "DocumentDistributeUnauthorizedErrorData", + "DocumentDistributeUnauthorizedIssue", + "DocumentDistributeUnauthorizedIssueTypedDict", + "DocumentDistributeVisibility", "DocumentDistributionMethod", "DocumentDocumentDataType", - "DocumentDuplicateDocumentBadRequestError", - "DocumentDuplicateDocumentBadRequestErrorData", - "DocumentDuplicateDocumentBadRequestIssue", - "DocumentDuplicateDocumentBadRequestIssueTypedDict", - "DocumentDuplicateDocumentInternalServerError", - "DocumentDuplicateDocumentInternalServerErrorData", - "DocumentDuplicateDocumentInternalServerErrorIssue", - "DocumentDuplicateDocumentInternalServerErrorIssueTypedDict", - "DocumentDuplicateDocumentRequest", - "DocumentDuplicateDocumentRequestTypedDict", - "DocumentDuplicateDocumentResponse", - "DocumentDuplicateDocumentResponseTypedDict", + "DocumentDownloadBadRequestError", + "DocumentDownloadBadRequestErrorData", + "DocumentDownloadBadRequestIssue", + "DocumentDownloadBadRequestIssueTypedDict", + "DocumentDownloadBetaBadRequestError", + "DocumentDownloadBetaBadRequestErrorData", + "DocumentDownloadBetaBadRequestIssue", + "DocumentDownloadBetaBadRequestIssueTypedDict", + "DocumentDownloadBetaForbiddenError", + "DocumentDownloadBetaForbiddenErrorData", + "DocumentDownloadBetaForbiddenIssue", + "DocumentDownloadBetaForbiddenIssueTypedDict", + "DocumentDownloadBetaInternalServerError", + "DocumentDownloadBetaInternalServerErrorData", + "DocumentDownloadBetaInternalServerErrorIssue", + "DocumentDownloadBetaInternalServerErrorIssueTypedDict", + "DocumentDownloadBetaNotFoundError", + "DocumentDownloadBetaNotFoundErrorData", + "DocumentDownloadBetaNotFoundIssue", + "DocumentDownloadBetaNotFoundIssueTypedDict", + "DocumentDownloadBetaRequest", + "DocumentDownloadBetaRequestTypedDict", + "DocumentDownloadBetaResponse", + "DocumentDownloadBetaResponseTypedDict", + "DocumentDownloadBetaUnauthorizedError", + "DocumentDownloadBetaUnauthorizedErrorData", + "DocumentDownloadBetaUnauthorizedIssue", + "DocumentDownloadBetaUnauthorizedIssueTypedDict", + "DocumentDownloadBetaVersion", + "DocumentDownloadForbiddenError", + "DocumentDownloadForbiddenErrorData", + "DocumentDownloadForbiddenIssue", + "DocumentDownloadForbiddenIssueTypedDict", + "DocumentDownloadInternalServerError", + "DocumentDownloadInternalServerErrorData", + "DocumentDownloadInternalServerErrorIssue", + "DocumentDownloadInternalServerErrorIssueTypedDict", + "DocumentDownloadNotFoundError", + "DocumentDownloadNotFoundErrorData", + "DocumentDownloadNotFoundIssue", + "DocumentDownloadNotFoundIssueTypedDict", + "DocumentDownloadRequest", + "DocumentDownloadRequestTypedDict", + "DocumentDownloadResponse", + "DocumentDownloadResponseTypedDict", + "DocumentDownloadUnauthorizedError", + "DocumentDownloadUnauthorizedErrorData", + "DocumentDownloadUnauthorizedIssue", + "DocumentDownloadUnauthorizedIssueTypedDict", + "DocumentDownloadVersion", + "DocumentDuplicateBadRequestError", + "DocumentDuplicateBadRequestErrorData", + "DocumentDuplicateBadRequestIssue", + "DocumentDuplicateBadRequestIssueTypedDict", + "DocumentDuplicateForbiddenError", + "DocumentDuplicateForbiddenErrorData", + "DocumentDuplicateForbiddenIssue", + "DocumentDuplicateForbiddenIssueTypedDict", + "DocumentDuplicateInternalServerError", + "DocumentDuplicateInternalServerErrorData", + "DocumentDuplicateInternalServerErrorIssue", + "DocumentDuplicateInternalServerErrorIssueTypedDict", + "DocumentDuplicateRequest", + "DocumentDuplicateRequestTypedDict", + "DocumentDuplicateResponse", + "DocumentDuplicateResponseTypedDict", + "DocumentDuplicateUnauthorizedError", + "DocumentDuplicateUnauthorizedErrorData", + "DocumentDuplicateUnauthorizedIssue", + "DocumentDuplicateUnauthorizedIssueTypedDict", "DocumentEmailSettings", "DocumentEmailSettingsTypedDict", "DocumentField", @@ -2801,186 +5518,191 @@ "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", + "DocumentFindForbiddenError", + "DocumentFindForbiddenErrorData", + "DocumentFindForbiddenIssue", + "DocumentFindForbiddenIssueTypedDict", + "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", + "DocumentFindUnauthorizedError", + "DocumentFindUnauthorizedErrorData", + "DocumentFindUnauthorizedIssue", + "DocumentFindUnauthorizedIssueTypedDict", + "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", + "DocumentGetDirection1", + "DocumentGetDirection2", + "DocumentGetDistributionMethod", + "DocumentGetDocumentData", + "DocumentGetDocumentDataType", + "DocumentGetDocumentDataTypedDict", + "DocumentGetDocumentMeta", + "DocumentGetDocumentMetaTypedDict", + "DocumentGetEmailSettings", + "DocumentGetEmailSettingsTypedDict", + "DocumentGetEnvelopeItem", + "DocumentGetEnvelopeItemTypedDict", + "DocumentGetField", + "DocumentGetFieldMetaCheckbox", + "DocumentGetFieldMetaCheckboxTypedDict", + "DocumentGetFieldMetaDate", + "DocumentGetFieldMetaDateTypedDict", + "DocumentGetFieldMetaDropdown", + "DocumentGetFieldMetaDropdownTypedDict", + "DocumentGetFieldMetaEmail", + "DocumentGetFieldMetaEmailTypedDict", + "DocumentGetFieldMetaInitials", + "DocumentGetFieldMetaInitialsTypedDict", + "DocumentGetFieldMetaName", + "DocumentGetFieldMetaNameTypedDict", + "DocumentGetFieldMetaNumber", + "DocumentGetFieldMetaNumberTypedDict", + "DocumentGetFieldMetaRadio", + "DocumentGetFieldMetaRadioTypedDict", + "DocumentGetFieldMetaSignature", + "DocumentGetFieldMetaSignatureTypedDict", + "DocumentGetFieldMetaText", + "DocumentGetFieldMetaTextTypedDict", + "DocumentGetFieldMetaUnion", + "DocumentGetFieldMetaUnionTypedDict", + "DocumentGetFieldType", + "DocumentGetFieldTypedDict", + "DocumentGetFolder", + "DocumentGetFolderType", + "DocumentGetFolderTypedDict", + "DocumentGetFolderVisibility", + "DocumentGetForbiddenError", + "DocumentGetForbiddenErrorData", + "DocumentGetForbiddenIssue", + "DocumentGetForbiddenIssueTypedDict", + "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", + "DocumentGetTypeSignature", + "DocumentGetTypeText", + "DocumentGetUnauthorizedError", + "DocumentGetUnauthorizedErrorData", + "DocumentGetUnauthorizedIssue", + "DocumentGetUnauthorizedIssueTypedDict", + "DocumentGetValue1", + "DocumentGetValue1TypedDict", + "DocumentGetValue2", + "DocumentGetValue2TypedDict", + "DocumentGetValue3", + "DocumentGetValue3TypedDict", + "DocumentGetVerticalAlign1", + "DocumentGetVerticalAlign2", + "DocumentGetVisibility", "DocumentGlobalAccessAuth", "DocumentGlobalActionAuth", "DocumentRecipient", "DocumentRecipientTypedDict", - "DocumentResendDocumentBadRequestError", - "DocumentResendDocumentBadRequestErrorData", - "DocumentResendDocumentBadRequestIssue", - "DocumentResendDocumentBadRequestIssueTypedDict", - "DocumentResendDocumentInternalServerError", - "DocumentResendDocumentInternalServerErrorData", - "DocumentResendDocumentInternalServerErrorIssue", - "DocumentResendDocumentInternalServerErrorIssueTypedDict", - "DocumentResendDocumentRequest", - "DocumentResendDocumentRequestTypedDict", - "DocumentResendDocumentResponse", - "DocumentResendDocumentResponseTypedDict", + "DocumentRedistributeBadRequestError", + "DocumentRedistributeBadRequestErrorData", + "DocumentRedistributeBadRequestIssue", + "DocumentRedistributeBadRequestIssueTypedDict", + "DocumentRedistributeForbiddenError", + "DocumentRedistributeForbiddenErrorData", + "DocumentRedistributeForbiddenIssue", + "DocumentRedistributeForbiddenIssueTypedDict", + "DocumentRedistributeInternalServerError", + "DocumentRedistributeInternalServerErrorData", + "DocumentRedistributeInternalServerErrorIssue", + "DocumentRedistributeInternalServerErrorIssueTypedDict", + "DocumentRedistributeRequest", + "DocumentRedistributeRequestTypedDict", + "DocumentRedistributeResponse", + "DocumentRedistributeResponseTypedDict", + "DocumentRedistributeUnauthorizedError", + "DocumentRedistributeUnauthorizedErrorData", + "DocumentRedistributeUnauthorizedIssue", + "DocumentRedistributeUnauthorizedIssueTypedDict", "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", @@ -2996,53 +5718,67 @@ "DocumentTypeName", "DocumentTypeNumber", "DocumentTypeRadio", + "DocumentTypeSignature", "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", + "DocumentUpdateDataGlobalAccessAuth", + "DocumentUpdateDataGlobalActionAuth", + "DocumentUpdateDataTypedDict", + "DocumentUpdateDataVisibility", + "DocumentUpdateDateFormat", + "DocumentUpdateDistributionMethod", + "DocumentUpdateEmailSettings", + "DocumentUpdateEmailSettingsTypedDict", + "DocumentUpdateForbiddenError", + "DocumentUpdateForbiddenErrorData", + "DocumentUpdateForbiddenIssue", + "DocumentUpdateForbiddenIssueTypedDict", + "DocumentUpdateFormValues", + "DocumentUpdateFormValuesTypedDict", + "DocumentUpdateGlobalAccessAuthResponse", + "DocumentUpdateGlobalActionAuthResponse", + "DocumentUpdateInternalServerError", + "DocumentUpdateInternalServerErrorData", + "DocumentUpdateInternalServerErrorIssue", + "DocumentUpdateInternalServerErrorIssueTypedDict", + "DocumentUpdateLanguage", + "DocumentUpdateMeta", + "DocumentUpdateMetaTypedDict", + "DocumentUpdateRequest", + "DocumentUpdateRequestTypedDict", + "DocumentUpdateResponse", + "DocumentUpdateResponseTypedDict", + "DocumentUpdateSigningOrder", + "DocumentUpdateSource", + "DocumentUpdateStatus", + "DocumentUpdateUnauthorizedError", + "DocumentUpdateUnauthorizedErrorData", + "DocumentUpdateUnauthorizedIssue", + "DocumentUpdateUnauthorizedIssueTypedDict", + "DocumentUpdateVisibilityResponse", "DocumentValue1", "DocumentValue1TypedDict", "DocumentValue2", "DocumentValue2TypedDict", "DocumentValue3", "DocumentValue3TypedDict", + "DocumentVerticalAlign1", + "DocumentVerticalAlign2", "DocumentVisibility", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestErrorData", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssueTypedDict", + "EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError", + "EmbeddingPresignCreateEmbeddingPresignTokenForbiddenErrorData", + "EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssue", + "EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssueTypedDict", "EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError", "EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData", "EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue", @@ -3051,10 +5787,18 @@ "EmbeddingPresignCreateEmbeddingPresignTokenRequestTypedDict", "EmbeddingPresignCreateEmbeddingPresignTokenResponse", "EmbeddingPresignCreateEmbeddingPresignTokenResponseTypedDict", + "EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError", + "EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedErrorData", + "EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssue", + "EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssueTypedDict", "EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError", "EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestErrorData", "EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue", "EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssueTypedDict", + "EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError", + "EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenErrorData", + "EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssue", + "EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssueTypedDict", "EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError", "EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData", "EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue", @@ -3063,10 +5807,1222 @@ "EmbeddingPresignVerifyEmbeddingPresignTokenRequestTypedDict", "EmbeddingPresignVerifyEmbeddingPresignTokenResponse", "EmbeddingPresignVerifyEmbeddingPresignTokenResponseTypedDict", + "EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError", + "EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedErrorData", + "EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssue", + "EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssueTypedDict", + "EnvelopeAttachmentCreateBadRequestError", + "EnvelopeAttachmentCreateBadRequestErrorData", + "EnvelopeAttachmentCreateBadRequestIssue", + "EnvelopeAttachmentCreateBadRequestIssueTypedDict", + "EnvelopeAttachmentCreateData", + "EnvelopeAttachmentCreateDataTypedDict", + "EnvelopeAttachmentCreateForbiddenError", + "EnvelopeAttachmentCreateForbiddenErrorData", + "EnvelopeAttachmentCreateForbiddenIssue", + "EnvelopeAttachmentCreateForbiddenIssueTypedDict", + "EnvelopeAttachmentCreateInternalServerError", + "EnvelopeAttachmentCreateInternalServerErrorData", + "EnvelopeAttachmentCreateInternalServerErrorIssue", + "EnvelopeAttachmentCreateInternalServerErrorIssueTypedDict", + "EnvelopeAttachmentCreateRequest", + "EnvelopeAttachmentCreateRequestTypedDict", + "EnvelopeAttachmentCreateResponse", + "EnvelopeAttachmentCreateResponseTypedDict", + "EnvelopeAttachmentCreateUnauthorizedError", + "EnvelopeAttachmentCreateUnauthorizedErrorData", + "EnvelopeAttachmentCreateUnauthorizedIssue", + "EnvelopeAttachmentCreateUnauthorizedIssueTypedDict", + "EnvelopeAttachmentDeleteBadRequestError", + "EnvelopeAttachmentDeleteBadRequestErrorData", + "EnvelopeAttachmentDeleteBadRequestIssue", + "EnvelopeAttachmentDeleteBadRequestIssueTypedDict", + "EnvelopeAttachmentDeleteForbiddenError", + "EnvelopeAttachmentDeleteForbiddenErrorData", + "EnvelopeAttachmentDeleteForbiddenIssue", + "EnvelopeAttachmentDeleteForbiddenIssueTypedDict", + "EnvelopeAttachmentDeleteInternalServerError", + "EnvelopeAttachmentDeleteInternalServerErrorData", + "EnvelopeAttachmentDeleteInternalServerErrorIssue", + "EnvelopeAttachmentDeleteInternalServerErrorIssueTypedDict", + "EnvelopeAttachmentDeleteRequest", + "EnvelopeAttachmentDeleteRequestTypedDict", + "EnvelopeAttachmentDeleteResponse", + "EnvelopeAttachmentDeleteResponseTypedDict", + "EnvelopeAttachmentDeleteUnauthorizedError", + "EnvelopeAttachmentDeleteUnauthorizedErrorData", + "EnvelopeAttachmentDeleteUnauthorizedIssue", + "EnvelopeAttachmentDeleteUnauthorizedIssueTypedDict", + "EnvelopeAttachmentFindBadRequestError", + "EnvelopeAttachmentFindBadRequestErrorData", + "EnvelopeAttachmentFindBadRequestIssue", + "EnvelopeAttachmentFindBadRequestIssueTypedDict", + "EnvelopeAttachmentFindData", + "EnvelopeAttachmentFindDataTypedDict", + "EnvelopeAttachmentFindForbiddenError", + "EnvelopeAttachmentFindForbiddenErrorData", + "EnvelopeAttachmentFindForbiddenIssue", + "EnvelopeAttachmentFindForbiddenIssueTypedDict", + "EnvelopeAttachmentFindInternalServerError", + "EnvelopeAttachmentFindInternalServerErrorData", + "EnvelopeAttachmentFindInternalServerErrorIssue", + "EnvelopeAttachmentFindInternalServerErrorIssueTypedDict", + "EnvelopeAttachmentFindNotFoundError", + "EnvelopeAttachmentFindNotFoundErrorData", + "EnvelopeAttachmentFindNotFoundIssue", + "EnvelopeAttachmentFindNotFoundIssueTypedDict", + "EnvelopeAttachmentFindRequest", + "EnvelopeAttachmentFindRequestTypedDict", + "EnvelopeAttachmentFindResponse", + "EnvelopeAttachmentFindResponseTypedDict", + "EnvelopeAttachmentFindType", + "EnvelopeAttachmentFindUnauthorizedError", + "EnvelopeAttachmentFindUnauthorizedErrorData", + "EnvelopeAttachmentFindUnauthorizedIssue", + "EnvelopeAttachmentFindUnauthorizedIssueTypedDict", + "EnvelopeAttachmentUpdateBadRequestError", + "EnvelopeAttachmentUpdateBadRequestErrorData", + "EnvelopeAttachmentUpdateBadRequestIssue", + "EnvelopeAttachmentUpdateBadRequestIssueTypedDict", + "EnvelopeAttachmentUpdateData", + "EnvelopeAttachmentUpdateDataTypedDict", + "EnvelopeAttachmentUpdateForbiddenError", + "EnvelopeAttachmentUpdateForbiddenErrorData", + "EnvelopeAttachmentUpdateForbiddenIssue", + "EnvelopeAttachmentUpdateForbiddenIssueTypedDict", + "EnvelopeAttachmentUpdateInternalServerError", + "EnvelopeAttachmentUpdateInternalServerErrorData", + "EnvelopeAttachmentUpdateInternalServerErrorIssue", + "EnvelopeAttachmentUpdateInternalServerErrorIssueTypedDict", + "EnvelopeAttachmentUpdateRequest", + "EnvelopeAttachmentUpdateRequestTypedDict", + "EnvelopeAttachmentUpdateResponse", + "EnvelopeAttachmentUpdateResponseTypedDict", + "EnvelopeAttachmentUpdateUnauthorizedError", + "EnvelopeAttachmentUpdateUnauthorizedErrorData", + "EnvelopeAttachmentUpdateUnauthorizedIssue", + "EnvelopeAttachmentUpdateUnauthorizedIssueTypedDict", + "EnvelopeCreateAccessAuth", + "EnvelopeCreateActionAuth", + "EnvelopeCreateAttachment", + "EnvelopeCreateAttachmentTypedDict", + "EnvelopeCreateBadRequestError", + "EnvelopeCreateBadRequestErrorData", + "EnvelopeCreateBadRequestIssue", + "EnvelopeCreateBadRequestIssueTypedDict", + "EnvelopeCreateDateFormat", + "EnvelopeCreateDirectionCheckbox", + "EnvelopeCreateDirectionRadio", + "EnvelopeCreateDistributionMethod", + "EnvelopeCreateEmailSettings", + "EnvelopeCreateEmailSettingsTypedDict", + "EnvelopeCreateFieldCheckbox", + "EnvelopeCreateFieldCheckboxTypedDict", + "EnvelopeCreateFieldDate", + "EnvelopeCreateFieldDateTypedDict", + "EnvelopeCreateFieldDropdown", + "EnvelopeCreateFieldDropdownTypedDict", + "EnvelopeCreateFieldEmail", + "EnvelopeCreateFieldEmailTypedDict", + "EnvelopeCreateFieldFreeSignature", + "EnvelopeCreateFieldFreeSignatureTypedDict", + "EnvelopeCreateFieldInitials", + "EnvelopeCreateFieldInitialsTypedDict", + "EnvelopeCreateFieldMetaCheckbox", + "EnvelopeCreateFieldMetaCheckboxTypedDict", + "EnvelopeCreateFieldMetaDate", + "EnvelopeCreateFieldMetaDateTypedDict", + "EnvelopeCreateFieldMetaDropdown", + "EnvelopeCreateFieldMetaDropdownTypedDict", + "EnvelopeCreateFieldMetaEmail", + "EnvelopeCreateFieldMetaEmailTypedDict", + "EnvelopeCreateFieldMetaInitials", + "EnvelopeCreateFieldMetaInitialsTypedDict", + "EnvelopeCreateFieldMetaName", + "EnvelopeCreateFieldMetaNameTypedDict", + "EnvelopeCreateFieldMetaNumber", + "EnvelopeCreateFieldMetaNumberTypedDict", + "EnvelopeCreateFieldMetaRadio", + "EnvelopeCreateFieldMetaRadioTypedDict", + "EnvelopeCreateFieldMetaSignature", + "EnvelopeCreateFieldMetaSignatureTypedDict", + "EnvelopeCreateFieldMetaText", + "EnvelopeCreateFieldMetaTextTypedDict", + "EnvelopeCreateFieldName", + "EnvelopeCreateFieldNameTypedDict", + "EnvelopeCreateFieldNumber", + "EnvelopeCreateFieldNumberTypedDict", + "EnvelopeCreateFieldRadio", + "EnvelopeCreateFieldRadioTypedDict", + "EnvelopeCreateFieldSignature", + "EnvelopeCreateFieldSignatureTypedDict", + "EnvelopeCreateFieldText", + "EnvelopeCreateFieldTextTypedDict", + "EnvelopeCreateFieldUnion", + "EnvelopeCreateFieldUnionTypedDict", + "EnvelopeCreateFile", + "EnvelopeCreateFileTypedDict", + "EnvelopeCreateForbiddenError", + "EnvelopeCreateForbiddenErrorData", + "EnvelopeCreateForbiddenIssue", + "EnvelopeCreateForbiddenIssueTypedDict", + "EnvelopeCreateFormValues", + "EnvelopeCreateFormValuesTypedDict", + "EnvelopeCreateGlobalAccessAuth", + "EnvelopeCreateGlobalActionAuth", + "EnvelopeCreateIdentifier1", + "EnvelopeCreateIdentifier10", + "EnvelopeCreateIdentifier10TypedDict", + "EnvelopeCreateIdentifier11", + "EnvelopeCreateIdentifier11TypedDict", + "EnvelopeCreateIdentifier1TypedDict", + "EnvelopeCreateIdentifier2", + "EnvelopeCreateIdentifier2TypedDict", + "EnvelopeCreateIdentifier3", + "EnvelopeCreateIdentifier3TypedDict", + "EnvelopeCreateIdentifier4", + "EnvelopeCreateIdentifier4TypedDict", + "EnvelopeCreateIdentifier5", + "EnvelopeCreateIdentifier5TypedDict", + "EnvelopeCreateIdentifier6", + "EnvelopeCreateIdentifier6TypedDict", + "EnvelopeCreateIdentifier7", + "EnvelopeCreateIdentifier7TypedDict", + "EnvelopeCreateIdentifier8", + "EnvelopeCreateIdentifier8TypedDict", + "EnvelopeCreateIdentifier9", + "EnvelopeCreateIdentifier9TypedDict", + "EnvelopeCreateInternalServerError", + "EnvelopeCreateInternalServerErrorData", + "EnvelopeCreateInternalServerErrorIssue", + "EnvelopeCreateInternalServerErrorIssueTypedDict", + "EnvelopeCreateLanguage", + "EnvelopeCreateMeta", + "EnvelopeCreateMetaTypedDict", + "EnvelopeCreatePayload", + "EnvelopeCreatePayloadTypedDict", + "EnvelopeCreateRecipient", + "EnvelopeCreateRecipientTypedDict", + "EnvelopeCreateRequest", + "EnvelopeCreateRequestTypedDict", + "EnvelopeCreateResponse", + "EnvelopeCreateResponseTypedDict", + "EnvelopeCreateRole", + "EnvelopeCreateSigningOrder", + "EnvelopeCreateTextAlignDate", + "EnvelopeCreateTextAlignEmail", + "EnvelopeCreateTextAlignInitials", + "EnvelopeCreateTextAlignName", + "EnvelopeCreateTextAlignNumber", + "EnvelopeCreateTextAlignText", + "EnvelopeCreateType", + "EnvelopeCreateTypeCheckbox1", + "EnvelopeCreateTypeCheckbox2", + "EnvelopeCreateTypeDate1", + "EnvelopeCreateTypeDate2", + "EnvelopeCreateTypeDropdown1", + "EnvelopeCreateTypeDropdown2", + "EnvelopeCreateTypeEmail1", + "EnvelopeCreateTypeEmail2", + "EnvelopeCreateTypeFreeSignature", + "EnvelopeCreateTypeInitials1", + "EnvelopeCreateTypeInitials2", + "EnvelopeCreateTypeLink", + "EnvelopeCreateTypeName1", + "EnvelopeCreateTypeName2", + "EnvelopeCreateTypeNumber1", + "EnvelopeCreateTypeNumber2", + "EnvelopeCreateTypeRadio1", + "EnvelopeCreateTypeRadio2", + "EnvelopeCreateTypeSignature1", + "EnvelopeCreateTypeSignature2", + "EnvelopeCreateTypeText1", + "EnvelopeCreateTypeText2", + "EnvelopeCreateUnauthorizedError", + "EnvelopeCreateUnauthorizedErrorData", + "EnvelopeCreateUnauthorizedIssue", + "EnvelopeCreateUnauthorizedIssueTypedDict", + "EnvelopeCreateValueCheckbox", + "EnvelopeCreateValueCheckboxTypedDict", + "EnvelopeCreateValueDropdown", + "EnvelopeCreateValueDropdownTypedDict", + "EnvelopeCreateValueRadio", + "EnvelopeCreateValueRadioTypedDict", + "EnvelopeCreateVerticalAlignNumber", + "EnvelopeCreateVerticalAlignText", + "EnvelopeCreateVisibility", + "EnvelopeDeleteBadRequestError", + "EnvelopeDeleteBadRequestErrorData", + "EnvelopeDeleteBadRequestIssue", + "EnvelopeDeleteBadRequestIssueTypedDict", + "EnvelopeDeleteForbiddenError", + "EnvelopeDeleteForbiddenErrorData", + "EnvelopeDeleteForbiddenIssue", + "EnvelopeDeleteForbiddenIssueTypedDict", + "EnvelopeDeleteInternalServerError", + "EnvelopeDeleteInternalServerErrorData", + "EnvelopeDeleteInternalServerErrorIssue", + "EnvelopeDeleteInternalServerErrorIssueTypedDict", + "EnvelopeDeleteRequest", + "EnvelopeDeleteRequestTypedDict", + "EnvelopeDeleteResponse", + "EnvelopeDeleteResponseTypedDict", + "EnvelopeDeleteUnauthorizedError", + "EnvelopeDeleteUnauthorizedErrorData", + "EnvelopeDeleteUnauthorizedIssue", + "EnvelopeDeleteUnauthorizedIssueTypedDict", + "EnvelopeDistributeBadRequestError", + "EnvelopeDistributeBadRequestErrorData", + "EnvelopeDistributeBadRequestIssue", + "EnvelopeDistributeBadRequestIssueTypedDict", + "EnvelopeDistributeDateFormat", + "EnvelopeDistributeDistributionMethod", + "EnvelopeDistributeEmailSettings", + "EnvelopeDistributeEmailSettingsTypedDict", + "EnvelopeDistributeForbiddenError", + "EnvelopeDistributeForbiddenErrorData", + "EnvelopeDistributeForbiddenIssue", + "EnvelopeDistributeForbiddenIssueTypedDict", + "EnvelopeDistributeInternalServerError", + "EnvelopeDistributeInternalServerErrorData", + "EnvelopeDistributeInternalServerErrorIssue", + "EnvelopeDistributeInternalServerErrorIssueTypedDict", + "EnvelopeDistributeLanguage", + "EnvelopeDistributeMeta", + "EnvelopeDistributeMetaTypedDict", + "EnvelopeDistributeRequest", + "EnvelopeDistributeRequestTypedDict", + "EnvelopeDistributeResponse", + "EnvelopeDistributeResponseTypedDict", + "EnvelopeDistributeUnauthorizedError", + "EnvelopeDistributeUnauthorizedErrorData", + "EnvelopeDistributeUnauthorizedIssue", + "EnvelopeDistributeUnauthorizedIssueTypedDict", + "EnvelopeDuplicateBadRequestError", + "EnvelopeDuplicateBadRequestErrorData", + "EnvelopeDuplicateBadRequestIssue", + "EnvelopeDuplicateBadRequestIssueTypedDict", + "EnvelopeDuplicateForbiddenError", + "EnvelopeDuplicateForbiddenErrorData", + "EnvelopeDuplicateForbiddenIssue", + "EnvelopeDuplicateForbiddenIssueTypedDict", + "EnvelopeDuplicateInternalServerError", + "EnvelopeDuplicateInternalServerErrorData", + "EnvelopeDuplicateInternalServerErrorIssue", + "EnvelopeDuplicateInternalServerErrorIssueTypedDict", + "EnvelopeDuplicateRequest", + "EnvelopeDuplicateRequestTypedDict", + "EnvelopeDuplicateResponse", + "EnvelopeDuplicateResponseTypedDict", + "EnvelopeDuplicateUnauthorizedError", + "EnvelopeDuplicateUnauthorizedErrorData", + "EnvelopeDuplicateUnauthorizedIssue", + "EnvelopeDuplicateUnauthorizedIssueTypedDict", + "EnvelopeFieldCreateManyBadRequestError", + "EnvelopeFieldCreateManyBadRequestErrorData", + "EnvelopeFieldCreateManyBadRequestIssue", + "EnvelopeFieldCreateManyBadRequestIssueTypedDict", + "EnvelopeFieldCreateManyDataCheckbox", + "EnvelopeFieldCreateManyDataCheckboxTypedDict", + "EnvelopeFieldCreateManyDataDate", + "EnvelopeFieldCreateManyDataDateTypedDict", + "EnvelopeFieldCreateManyDataDropdown", + "EnvelopeFieldCreateManyDataDropdownTypedDict", + "EnvelopeFieldCreateManyDataEmail", + "EnvelopeFieldCreateManyDataEmailTypedDict", + "EnvelopeFieldCreateManyDataFreeSignature", + "EnvelopeFieldCreateManyDataFreeSignatureTypedDict", + "EnvelopeFieldCreateManyDataInitials", + "EnvelopeFieldCreateManyDataInitialsTypedDict", + "EnvelopeFieldCreateManyDataName", + "EnvelopeFieldCreateManyDataNameTypedDict", + "EnvelopeFieldCreateManyDataNumber", + "EnvelopeFieldCreateManyDataNumberTypedDict", + "EnvelopeFieldCreateManyDataRadio", + "EnvelopeFieldCreateManyDataRadioTypedDict", + "EnvelopeFieldCreateManyDataResponse", + "EnvelopeFieldCreateManyDataResponseTypedDict", + "EnvelopeFieldCreateManyDataSignature", + "EnvelopeFieldCreateManyDataSignatureTypedDict", + "EnvelopeFieldCreateManyDataText", + "EnvelopeFieldCreateManyDataTextTypedDict", + "EnvelopeFieldCreateManyDataUnion", + "EnvelopeFieldCreateManyDataUnionTypedDict", + "EnvelopeFieldCreateManyDirectionCheckbox", + "EnvelopeFieldCreateManyDirectionRadio", + "EnvelopeFieldCreateManyDirectionResponse1", + "EnvelopeFieldCreateManyDirectionResponse2", + "EnvelopeFieldCreateManyFieldMetaCheckboxRequest", + "EnvelopeFieldCreateManyFieldMetaCheckboxRequestTypedDict", + "EnvelopeFieldCreateManyFieldMetaCheckboxResponse", + "EnvelopeFieldCreateManyFieldMetaCheckboxResponseTypedDict", + "EnvelopeFieldCreateManyFieldMetaDateRequest", + "EnvelopeFieldCreateManyFieldMetaDateRequestTypedDict", + "EnvelopeFieldCreateManyFieldMetaDateResponse", + "EnvelopeFieldCreateManyFieldMetaDateResponseTypedDict", + "EnvelopeFieldCreateManyFieldMetaDropdownRequest", + "EnvelopeFieldCreateManyFieldMetaDropdownRequestTypedDict", + "EnvelopeFieldCreateManyFieldMetaDropdownResponse", + "EnvelopeFieldCreateManyFieldMetaDropdownResponseTypedDict", + "EnvelopeFieldCreateManyFieldMetaEmailRequest", + "EnvelopeFieldCreateManyFieldMetaEmailRequestTypedDict", + "EnvelopeFieldCreateManyFieldMetaEmailResponse", + "EnvelopeFieldCreateManyFieldMetaEmailResponseTypedDict", + "EnvelopeFieldCreateManyFieldMetaInitialsRequest", + "EnvelopeFieldCreateManyFieldMetaInitialsRequestTypedDict", + "EnvelopeFieldCreateManyFieldMetaInitialsResponse", + "EnvelopeFieldCreateManyFieldMetaInitialsResponseTypedDict", + "EnvelopeFieldCreateManyFieldMetaNameRequest", + "EnvelopeFieldCreateManyFieldMetaNameRequestTypedDict", + "EnvelopeFieldCreateManyFieldMetaNameResponse", + "EnvelopeFieldCreateManyFieldMetaNameResponseTypedDict", + "EnvelopeFieldCreateManyFieldMetaNumberRequest", + "EnvelopeFieldCreateManyFieldMetaNumberRequestTypedDict", + "EnvelopeFieldCreateManyFieldMetaNumberResponse", + "EnvelopeFieldCreateManyFieldMetaNumberResponseTypedDict", + "EnvelopeFieldCreateManyFieldMetaRadioRequest", + "EnvelopeFieldCreateManyFieldMetaRadioRequestTypedDict", + "EnvelopeFieldCreateManyFieldMetaRadioResponse", + "EnvelopeFieldCreateManyFieldMetaRadioResponseTypedDict", + "EnvelopeFieldCreateManyFieldMetaSignatureRequest", + "EnvelopeFieldCreateManyFieldMetaSignatureRequestTypedDict", + "EnvelopeFieldCreateManyFieldMetaSignatureResponse", + "EnvelopeFieldCreateManyFieldMetaSignatureResponseTypedDict", + "EnvelopeFieldCreateManyFieldMetaTextRequest", + "EnvelopeFieldCreateManyFieldMetaTextRequestTypedDict", + "EnvelopeFieldCreateManyFieldMetaTextResponse", + "EnvelopeFieldCreateManyFieldMetaTextResponseTypedDict", + "EnvelopeFieldCreateManyFieldMetaTypeCheckbox", + "EnvelopeFieldCreateManyFieldMetaTypeDate", + "EnvelopeFieldCreateManyFieldMetaTypeDropdown", + "EnvelopeFieldCreateManyFieldMetaTypeEmail", + "EnvelopeFieldCreateManyFieldMetaTypeInitials", + "EnvelopeFieldCreateManyFieldMetaTypeName", + "EnvelopeFieldCreateManyFieldMetaTypeNumber", + "EnvelopeFieldCreateManyFieldMetaTypeRadio", + "EnvelopeFieldCreateManyFieldMetaTypeSignature", + "EnvelopeFieldCreateManyFieldMetaTypeText", + "EnvelopeFieldCreateManyFieldMetaUnion", + "EnvelopeFieldCreateManyFieldMetaUnionTypedDict", + "EnvelopeFieldCreateManyForbiddenError", + "EnvelopeFieldCreateManyForbiddenErrorData", + "EnvelopeFieldCreateManyForbiddenIssue", + "EnvelopeFieldCreateManyForbiddenIssueTypedDict", + "EnvelopeFieldCreateManyInternalServerError", + "EnvelopeFieldCreateManyInternalServerErrorData", + "EnvelopeFieldCreateManyInternalServerErrorIssue", + "EnvelopeFieldCreateManyInternalServerErrorIssueTypedDict", + "EnvelopeFieldCreateManyRequest", + "EnvelopeFieldCreateManyRequestTypedDict", + "EnvelopeFieldCreateManyResponse", + "EnvelopeFieldCreateManyResponseTypedDict", + "EnvelopeFieldCreateManyTextAlignDate", + "EnvelopeFieldCreateManyTextAlignEmail", + "EnvelopeFieldCreateManyTextAlignInitials", + "EnvelopeFieldCreateManyTextAlignName", + "EnvelopeFieldCreateManyTextAlignNumber", + "EnvelopeFieldCreateManyTextAlignResponse1", + "EnvelopeFieldCreateManyTextAlignResponse2", + "EnvelopeFieldCreateManyTextAlignResponse3", + "EnvelopeFieldCreateManyTextAlignResponse4", + "EnvelopeFieldCreateManyTextAlignResponse5", + "EnvelopeFieldCreateManyTextAlignResponse6", + "EnvelopeFieldCreateManyTextAlignText", + "EnvelopeFieldCreateManyTypeCheckboxRequest1", + "EnvelopeFieldCreateManyTypeCheckboxRequest2", + "EnvelopeFieldCreateManyTypeDateRequest1", + "EnvelopeFieldCreateManyTypeDateRequest2", + "EnvelopeFieldCreateManyTypeDropdownRequest1", + "EnvelopeFieldCreateManyTypeDropdownRequest2", + "EnvelopeFieldCreateManyTypeEmailRequest1", + "EnvelopeFieldCreateManyTypeEmailRequest2", + "EnvelopeFieldCreateManyTypeFreeSignature", + "EnvelopeFieldCreateManyTypeInitialsRequest1", + "EnvelopeFieldCreateManyTypeInitialsRequest2", + "EnvelopeFieldCreateManyTypeNameRequest1", + "EnvelopeFieldCreateManyTypeNameRequest2", + "EnvelopeFieldCreateManyTypeNumberRequest1", + "EnvelopeFieldCreateManyTypeNumberRequest2", + "EnvelopeFieldCreateManyTypeRadioRequest1", + "EnvelopeFieldCreateManyTypeRadioRequest2", + "EnvelopeFieldCreateManyTypeResponse", + "EnvelopeFieldCreateManyTypeSignatureRequest1", + "EnvelopeFieldCreateManyTypeSignatureRequest2", + "EnvelopeFieldCreateManyTypeTextRequest1", + "EnvelopeFieldCreateManyTypeTextRequest2", + "EnvelopeFieldCreateManyUnauthorizedError", + "EnvelopeFieldCreateManyUnauthorizedErrorData", + "EnvelopeFieldCreateManyUnauthorizedIssue", + "EnvelopeFieldCreateManyUnauthorizedIssueTypedDict", + "EnvelopeFieldCreateManyValueCheckbox", + "EnvelopeFieldCreateManyValueCheckboxTypedDict", + "EnvelopeFieldCreateManyValueDropdown", + "EnvelopeFieldCreateManyValueDropdownTypedDict", + "EnvelopeFieldCreateManyValueRadio", + "EnvelopeFieldCreateManyValueRadioTypedDict", + "EnvelopeFieldCreateManyValueResponse1", + "EnvelopeFieldCreateManyValueResponse1TypedDict", + "EnvelopeFieldCreateManyValueResponse2", + "EnvelopeFieldCreateManyValueResponse2TypedDict", + "EnvelopeFieldCreateManyValueResponse3", + "EnvelopeFieldCreateManyValueResponse3TypedDict", + "EnvelopeFieldCreateManyVerticalAlignNumber", + "EnvelopeFieldCreateManyVerticalAlignResponse1", + "EnvelopeFieldCreateManyVerticalAlignResponse2", + "EnvelopeFieldCreateManyVerticalAlignText", + "EnvelopeFieldDeleteBadRequestError", + "EnvelopeFieldDeleteBadRequestErrorData", + "EnvelopeFieldDeleteBadRequestIssue", + "EnvelopeFieldDeleteBadRequestIssueTypedDict", + "EnvelopeFieldDeleteForbiddenError", + "EnvelopeFieldDeleteForbiddenErrorData", + "EnvelopeFieldDeleteForbiddenIssue", + "EnvelopeFieldDeleteForbiddenIssueTypedDict", + "EnvelopeFieldDeleteInternalServerError", + "EnvelopeFieldDeleteInternalServerErrorData", + "EnvelopeFieldDeleteInternalServerErrorIssue", + "EnvelopeFieldDeleteInternalServerErrorIssueTypedDict", + "EnvelopeFieldDeleteRequest", + "EnvelopeFieldDeleteRequestTypedDict", + "EnvelopeFieldDeleteResponse", + "EnvelopeFieldDeleteResponseTypedDict", + "EnvelopeFieldDeleteUnauthorizedError", + "EnvelopeFieldDeleteUnauthorizedErrorData", + "EnvelopeFieldDeleteUnauthorizedIssue", + "EnvelopeFieldDeleteUnauthorizedIssueTypedDict", + "EnvelopeFieldGetBadRequestError", + "EnvelopeFieldGetBadRequestErrorData", + "EnvelopeFieldGetBadRequestIssue", + "EnvelopeFieldGetBadRequestIssueTypedDict", + "EnvelopeFieldGetDirection1", + "EnvelopeFieldGetDirection2", + "EnvelopeFieldGetFieldMetaCheckbox", + "EnvelopeFieldGetFieldMetaCheckboxTypedDict", + "EnvelopeFieldGetFieldMetaDate", + "EnvelopeFieldGetFieldMetaDateTypedDict", + "EnvelopeFieldGetFieldMetaDropdown", + "EnvelopeFieldGetFieldMetaDropdownTypedDict", + "EnvelopeFieldGetFieldMetaEmail", + "EnvelopeFieldGetFieldMetaEmailTypedDict", + "EnvelopeFieldGetFieldMetaInitials", + "EnvelopeFieldGetFieldMetaInitialsTypedDict", + "EnvelopeFieldGetFieldMetaName", + "EnvelopeFieldGetFieldMetaNameTypedDict", + "EnvelopeFieldGetFieldMetaNumber", + "EnvelopeFieldGetFieldMetaNumberTypedDict", + "EnvelopeFieldGetFieldMetaRadio", + "EnvelopeFieldGetFieldMetaRadioTypedDict", + "EnvelopeFieldGetFieldMetaSignature", + "EnvelopeFieldGetFieldMetaSignatureTypedDict", + "EnvelopeFieldGetFieldMetaText", + "EnvelopeFieldGetFieldMetaTextTypedDict", + "EnvelopeFieldGetFieldMetaUnion", + "EnvelopeFieldGetFieldMetaUnionTypedDict", + "EnvelopeFieldGetForbiddenError", + "EnvelopeFieldGetForbiddenErrorData", + "EnvelopeFieldGetForbiddenIssue", + "EnvelopeFieldGetForbiddenIssueTypedDict", + "EnvelopeFieldGetInternalServerError", + "EnvelopeFieldGetInternalServerErrorData", + "EnvelopeFieldGetInternalServerErrorIssue", + "EnvelopeFieldGetInternalServerErrorIssueTypedDict", + "EnvelopeFieldGetNotFoundError", + "EnvelopeFieldGetNotFoundErrorData", + "EnvelopeFieldGetNotFoundIssue", + "EnvelopeFieldGetNotFoundIssueTypedDict", + "EnvelopeFieldGetRequest", + "EnvelopeFieldGetRequestTypedDict", + "EnvelopeFieldGetResponse", + "EnvelopeFieldGetResponseTypedDict", + "EnvelopeFieldGetTextAlign1", + "EnvelopeFieldGetTextAlign2", + "EnvelopeFieldGetTextAlign3", + "EnvelopeFieldGetTextAlign4", + "EnvelopeFieldGetTextAlign5", + "EnvelopeFieldGetTextAlign6", + "EnvelopeFieldGetType", + "EnvelopeFieldGetTypeCheckbox", + "EnvelopeFieldGetTypeDate", + "EnvelopeFieldGetTypeDropdown", + "EnvelopeFieldGetTypeEmail", + "EnvelopeFieldGetTypeInitials", + "EnvelopeFieldGetTypeName", + "EnvelopeFieldGetTypeNumber", + "EnvelopeFieldGetTypeRadio", + "EnvelopeFieldGetTypeSignature", + "EnvelopeFieldGetTypeText", + "EnvelopeFieldGetUnauthorizedError", + "EnvelopeFieldGetUnauthorizedErrorData", + "EnvelopeFieldGetUnauthorizedIssue", + "EnvelopeFieldGetUnauthorizedIssueTypedDict", + "EnvelopeFieldGetValue1", + "EnvelopeFieldGetValue1TypedDict", + "EnvelopeFieldGetValue2", + "EnvelopeFieldGetValue2TypedDict", + "EnvelopeFieldGetValue3", + "EnvelopeFieldGetValue3TypedDict", + "EnvelopeFieldGetVerticalAlign1", + "EnvelopeFieldGetVerticalAlign2", + "EnvelopeFieldUpdateManyBadRequestError", + "EnvelopeFieldUpdateManyBadRequestErrorData", + "EnvelopeFieldUpdateManyBadRequestIssue", + "EnvelopeFieldUpdateManyBadRequestIssueTypedDict", + "EnvelopeFieldUpdateManyDataCheckbox", + "EnvelopeFieldUpdateManyDataCheckboxTypedDict", + "EnvelopeFieldUpdateManyDataDate", + "EnvelopeFieldUpdateManyDataDateTypedDict", + "EnvelopeFieldUpdateManyDataDropdown", + "EnvelopeFieldUpdateManyDataDropdownTypedDict", + "EnvelopeFieldUpdateManyDataEmail", + "EnvelopeFieldUpdateManyDataEmailTypedDict", + "EnvelopeFieldUpdateManyDataFreeSignature", + "EnvelopeFieldUpdateManyDataFreeSignatureTypedDict", + "EnvelopeFieldUpdateManyDataInitials", + "EnvelopeFieldUpdateManyDataInitialsTypedDict", + "EnvelopeFieldUpdateManyDataName", + "EnvelopeFieldUpdateManyDataNameTypedDict", + "EnvelopeFieldUpdateManyDataNumber", + "EnvelopeFieldUpdateManyDataNumberTypedDict", + "EnvelopeFieldUpdateManyDataRadio", + "EnvelopeFieldUpdateManyDataRadioTypedDict", + "EnvelopeFieldUpdateManyDataResponse", + "EnvelopeFieldUpdateManyDataResponseTypedDict", + "EnvelopeFieldUpdateManyDataSignature", + "EnvelopeFieldUpdateManyDataSignatureTypedDict", + "EnvelopeFieldUpdateManyDataText", + "EnvelopeFieldUpdateManyDataTextTypedDict", + "EnvelopeFieldUpdateManyDataUnion", + "EnvelopeFieldUpdateManyDataUnionTypedDict", + "EnvelopeFieldUpdateManyDirectionCheckbox", + "EnvelopeFieldUpdateManyDirectionRadio", + "EnvelopeFieldUpdateManyDirectionResponse1", + "EnvelopeFieldUpdateManyDirectionResponse2", + "EnvelopeFieldUpdateManyFieldMetaCheckboxRequest", + "EnvelopeFieldUpdateManyFieldMetaCheckboxRequestTypedDict", + "EnvelopeFieldUpdateManyFieldMetaCheckboxResponse", + "EnvelopeFieldUpdateManyFieldMetaCheckboxResponseTypedDict", + "EnvelopeFieldUpdateManyFieldMetaDateRequest", + "EnvelopeFieldUpdateManyFieldMetaDateRequestTypedDict", + "EnvelopeFieldUpdateManyFieldMetaDateResponse", + "EnvelopeFieldUpdateManyFieldMetaDateResponseTypedDict", + "EnvelopeFieldUpdateManyFieldMetaDropdownRequest", + "EnvelopeFieldUpdateManyFieldMetaDropdownRequestTypedDict", + "EnvelopeFieldUpdateManyFieldMetaDropdownResponse", + "EnvelopeFieldUpdateManyFieldMetaDropdownResponseTypedDict", + "EnvelopeFieldUpdateManyFieldMetaEmailRequest", + "EnvelopeFieldUpdateManyFieldMetaEmailRequestTypedDict", + "EnvelopeFieldUpdateManyFieldMetaEmailResponse", + "EnvelopeFieldUpdateManyFieldMetaEmailResponseTypedDict", + "EnvelopeFieldUpdateManyFieldMetaInitialsRequest", + "EnvelopeFieldUpdateManyFieldMetaInitialsRequestTypedDict", + "EnvelopeFieldUpdateManyFieldMetaInitialsResponse", + "EnvelopeFieldUpdateManyFieldMetaInitialsResponseTypedDict", + "EnvelopeFieldUpdateManyFieldMetaNameRequest", + "EnvelopeFieldUpdateManyFieldMetaNameRequestTypedDict", + "EnvelopeFieldUpdateManyFieldMetaNameResponse", + "EnvelopeFieldUpdateManyFieldMetaNameResponseTypedDict", + "EnvelopeFieldUpdateManyFieldMetaNumberRequest", + "EnvelopeFieldUpdateManyFieldMetaNumberRequestTypedDict", + "EnvelopeFieldUpdateManyFieldMetaNumberResponse", + "EnvelopeFieldUpdateManyFieldMetaNumberResponseTypedDict", + "EnvelopeFieldUpdateManyFieldMetaRadioRequest", + "EnvelopeFieldUpdateManyFieldMetaRadioRequestTypedDict", + "EnvelopeFieldUpdateManyFieldMetaRadioResponse", + "EnvelopeFieldUpdateManyFieldMetaRadioResponseTypedDict", + "EnvelopeFieldUpdateManyFieldMetaSignatureRequest", + "EnvelopeFieldUpdateManyFieldMetaSignatureRequestTypedDict", + "EnvelopeFieldUpdateManyFieldMetaSignatureResponse", + "EnvelopeFieldUpdateManyFieldMetaSignatureResponseTypedDict", + "EnvelopeFieldUpdateManyFieldMetaTextRequest", + "EnvelopeFieldUpdateManyFieldMetaTextRequestTypedDict", + "EnvelopeFieldUpdateManyFieldMetaTextResponse", + "EnvelopeFieldUpdateManyFieldMetaTextResponseTypedDict", + "EnvelopeFieldUpdateManyFieldMetaTypeCheckbox", + "EnvelopeFieldUpdateManyFieldMetaTypeDate", + "EnvelopeFieldUpdateManyFieldMetaTypeDropdown", + "EnvelopeFieldUpdateManyFieldMetaTypeEmail", + "EnvelopeFieldUpdateManyFieldMetaTypeInitials", + "EnvelopeFieldUpdateManyFieldMetaTypeName", + "EnvelopeFieldUpdateManyFieldMetaTypeNumber", + "EnvelopeFieldUpdateManyFieldMetaTypeRadio", + "EnvelopeFieldUpdateManyFieldMetaTypeSignature", + "EnvelopeFieldUpdateManyFieldMetaTypeText", + "EnvelopeFieldUpdateManyFieldMetaUnion", + "EnvelopeFieldUpdateManyFieldMetaUnionTypedDict", + "EnvelopeFieldUpdateManyForbiddenError", + "EnvelopeFieldUpdateManyForbiddenErrorData", + "EnvelopeFieldUpdateManyForbiddenIssue", + "EnvelopeFieldUpdateManyForbiddenIssueTypedDict", + "EnvelopeFieldUpdateManyInternalServerError", + "EnvelopeFieldUpdateManyInternalServerErrorData", + "EnvelopeFieldUpdateManyInternalServerErrorIssue", + "EnvelopeFieldUpdateManyInternalServerErrorIssueTypedDict", + "EnvelopeFieldUpdateManyRequest", + "EnvelopeFieldUpdateManyRequestTypedDict", + "EnvelopeFieldUpdateManyResponse", + "EnvelopeFieldUpdateManyResponseTypedDict", + "EnvelopeFieldUpdateManyTextAlignDate", + "EnvelopeFieldUpdateManyTextAlignEmail", + "EnvelopeFieldUpdateManyTextAlignInitials", + "EnvelopeFieldUpdateManyTextAlignName", + "EnvelopeFieldUpdateManyTextAlignNumber", + "EnvelopeFieldUpdateManyTextAlignResponse1", + "EnvelopeFieldUpdateManyTextAlignResponse2", + "EnvelopeFieldUpdateManyTextAlignResponse3", + "EnvelopeFieldUpdateManyTextAlignResponse4", + "EnvelopeFieldUpdateManyTextAlignResponse5", + "EnvelopeFieldUpdateManyTextAlignResponse6", + "EnvelopeFieldUpdateManyTextAlignText", + "EnvelopeFieldUpdateManyTypeCheckboxRequest1", + "EnvelopeFieldUpdateManyTypeCheckboxRequest2", + "EnvelopeFieldUpdateManyTypeDateRequest1", + "EnvelopeFieldUpdateManyTypeDateRequest2", + "EnvelopeFieldUpdateManyTypeDropdownRequest1", + "EnvelopeFieldUpdateManyTypeDropdownRequest2", + "EnvelopeFieldUpdateManyTypeEmailRequest1", + "EnvelopeFieldUpdateManyTypeEmailRequest2", + "EnvelopeFieldUpdateManyTypeFreeSignature", + "EnvelopeFieldUpdateManyTypeInitialsRequest1", + "EnvelopeFieldUpdateManyTypeInitialsRequest2", + "EnvelopeFieldUpdateManyTypeNameRequest1", + "EnvelopeFieldUpdateManyTypeNameRequest2", + "EnvelopeFieldUpdateManyTypeNumberRequest1", + "EnvelopeFieldUpdateManyTypeNumberRequest2", + "EnvelopeFieldUpdateManyTypeRadioRequest1", + "EnvelopeFieldUpdateManyTypeRadioRequest2", + "EnvelopeFieldUpdateManyTypeResponse", + "EnvelopeFieldUpdateManyTypeSignatureRequest1", + "EnvelopeFieldUpdateManyTypeSignatureRequest2", + "EnvelopeFieldUpdateManyTypeTextRequest1", + "EnvelopeFieldUpdateManyTypeTextRequest2", + "EnvelopeFieldUpdateManyUnauthorizedError", + "EnvelopeFieldUpdateManyUnauthorizedErrorData", + "EnvelopeFieldUpdateManyUnauthorizedIssue", + "EnvelopeFieldUpdateManyUnauthorizedIssueTypedDict", + "EnvelopeFieldUpdateManyValueCheckbox", + "EnvelopeFieldUpdateManyValueCheckboxTypedDict", + "EnvelopeFieldUpdateManyValueDropdown", + "EnvelopeFieldUpdateManyValueDropdownTypedDict", + "EnvelopeFieldUpdateManyValueRadio", + "EnvelopeFieldUpdateManyValueRadioTypedDict", + "EnvelopeFieldUpdateManyValueResponse1", + "EnvelopeFieldUpdateManyValueResponse1TypedDict", + "EnvelopeFieldUpdateManyValueResponse2", + "EnvelopeFieldUpdateManyValueResponse2TypedDict", + "EnvelopeFieldUpdateManyValueResponse3", + "EnvelopeFieldUpdateManyValueResponse3TypedDict", + "EnvelopeFieldUpdateManyVerticalAlignNumber", + "EnvelopeFieldUpdateManyVerticalAlignResponse1", + "EnvelopeFieldUpdateManyVerticalAlignResponse2", + "EnvelopeFieldUpdateManyVerticalAlignText", + "EnvelopeGetAccessAuth", + "EnvelopeGetActionAuth", + "EnvelopeGetAuthOptions", + "EnvelopeGetAuthOptionsTypedDict", + "EnvelopeGetBadRequestError", + "EnvelopeGetBadRequestErrorData", + "EnvelopeGetBadRequestIssue", + "EnvelopeGetBadRequestIssueTypedDict", + "EnvelopeGetDirectLink", + "EnvelopeGetDirectLinkTypedDict", + "EnvelopeGetDirection1", + "EnvelopeGetDirection2", + "EnvelopeGetDistributionMethod", + "EnvelopeGetDocumentMeta", + "EnvelopeGetDocumentMetaTypedDict", + "EnvelopeGetEmailSettings", + "EnvelopeGetEmailSettingsTypedDict", + "EnvelopeGetEnvelopeItem", + "EnvelopeGetEnvelopeItemTypedDict", + "EnvelopeGetField", + "EnvelopeGetFieldMetaCheckbox", + "EnvelopeGetFieldMetaCheckboxTypedDict", + "EnvelopeGetFieldMetaDate", + "EnvelopeGetFieldMetaDateTypedDict", + "EnvelopeGetFieldMetaDropdown", + "EnvelopeGetFieldMetaDropdownTypedDict", + "EnvelopeGetFieldMetaEmail", + "EnvelopeGetFieldMetaEmailTypedDict", + "EnvelopeGetFieldMetaInitials", + "EnvelopeGetFieldMetaInitialsTypedDict", + "EnvelopeGetFieldMetaName", + "EnvelopeGetFieldMetaNameTypedDict", + "EnvelopeGetFieldMetaNumber", + "EnvelopeGetFieldMetaNumberTypedDict", + "EnvelopeGetFieldMetaRadio", + "EnvelopeGetFieldMetaRadioTypedDict", + "EnvelopeGetFieldMetaSignature", + "EnvelopeGetFieldMetaSignatureTypedDict", + "EnvelopeGetFieldMetaText", + "EnvelopeGetFieldMetaTextTypedDict", + "EnvelopeGetFieldMetaUnion", + "EnvelopeGetFieldMetaUnionTypedDict", + "EnvelopeGetFieldType", + "EnvelopeGetFieldTypedDict", + "EnvelopeGetForbiddenError", + "EnvelopeGetForbiddenErrorData", + "EnvelopeGetForbiddenIssue", + "EnvelopeGetForbiddenIssueTypedDict", + "EnvelopeGetFormValues", + "EnvelopeGetFormValuesTypedDict", + "EnvelopeGetGlobalAccessAuth", + "EnvelopeGetGlobalActionAuth", + "EnvelopeGetInternalServerError", + "EnvelopeGetInternalServerErrorData", + "EnvelopeGetInternalServerErrorIssue", + "EnvelopeGetInternalServerErrorIssueTypedDict", + "EnvelopeGetNotFoundError", + "EnvelopeGetNotFoundErrorData", + "EnvelopeGetNotFoundIssue", + "EnvelopeGetNotFoundIssueTypedDict", + "EnvelopeGetReadStatus", + "EnvelopeGetRecipient", + "EnvelopeGetRecipientAuthOptions", + "EnvelopeGetRecipientAuthOptionsTypedDict", + "EnvelopeGetRecipientTypedDict", + "EnvelopeGetRequest", + "EnvelopeGetRequestTypedDict", + "EnvelopeGetResponse", + "EnvelopeGetResponseTypedDict", + "EnvelopeGetRole", + "EnvelopeGetSendStatus", + "EnvelopeGetSigningOrder", + "EnvelopeGetSigningStatus", + "EnvelopeGetSource", + "EnvelopeGetStatus", + "EnvelopeGetTeam", + "EnvelopeGetTeamTypedDict", + "EnvelopeGetTemplateType", + "EnvelopeGetTextAlign1", + "EnvelopeGetTextAlign2", + "EnvelopeGetTextAlign3", + "EnvelopeGetTextAlign4", + "EnvelopeGetTextAlign5", + "EnvelopeGetTextAlign6", + "EnvelopeGetType", + "EnvelopeGetTypeCheckbox", + "EnvelopeGetTypeDate", + "EnvelopeGetTypeDropdown", + "EnvelopeGetTypeEmail", + "EnvelopeGetTypeInitials", + "EnvelopeGetTypeName", + "EnvelopeGetTypeNumber", + "EnvelopeGetTypeRadio", + "EnvelopeGetTypeSignature", + "EnvelopeGetTypeText", + "EnvelopeGetUnauthorizedError", + "EnvelopeGetUnauthorizedErrorData", + "EnvelopeGetUnauthorizedIssue", + "EnvelopeGetUnauthorizedIssueTypedDict", + "EnvelopeGetUser", + "EnvelopeGetUserTypedDict", + "EnvelopeGetValue1", + "EnvelopeGetValue1TypedDict", + "EnvelopeGetValue2", + "EnvelopeGetValue2TypedDict", + "EnvelopeGetValue3", + "EnvelopeGetValue3TypedDict", + "EnvelopeGetVerticalAlign1", + "EnvelopeGetVerticalAlign2", + "EnvelopeGetVisibility", + "EnvelopeItemCreateManyBadRequestError", + "EnvelopeItemCreateManyBadRequestErrorData", + "EnvelopeItemCreateManyBadRequestIssue", + "EnvelopeItemCreateManyBadRequestIssueTypedDict", + "EnvelopeItemCreateManyData", + "EnvelopeItemCreateManyDataTypedDict", + "EnvelopeItemCreateManyFile", + "EnvelopeItemCreateManyFileTypedDict", + "EnvelopeItemCreateManyForbiddenError", + "EnvelopeItemCreateManyForbiddenErrorData", + "EnvelopeItemCreateManyForbiddenIssue", + "EnvelopeItemCreateManyForbiddenIssueTypedDict", + "EnvelopeItemCreateManyInternalServerError", + "EnvelopeItemCreateManyInternalServerErrorData", + "EnvelopeItemCreateManyInternalServerErrorIssue", + "EnvelopeItemCreateManyInternalServerErrorIssueTypedDict", + "EnvelopeItemCreateManyPayload", + "EnvelopeItemCreateManyPayloadTypedDict", + "EnvelopeItemCreateManyRequest", + "EnvelopeItemCreateManyRequestTypedDict", + "EnvelopeItemCreateManyResponse", + "EnvelopeItemCreateManyResponseTypedDict", + "EnvelopeItemCreateManyUnauthorizedError", + "EnvelopeItemCreateManyUnauthorizedErrorData", + "EnvelopeItemCreateManyUnauthorizedIssue", + "EnvelopeItemCreateManyUnauthorizedIssueTypedDict", + "EnvelopeItemDeleteBadRequestError", + "EnvelopeItemDeleteBadRequestErrorData", + "EnvelopeItemDeleteBadRequestIssue", + "EnvelopeItemDeleteBadRequestIssueTypedDict", + "EnvelopeItemDeleteForbiddenError", + "EnvelopeItemDeleteForbiddenErrorData", + "EnvelopeItemDeleteForbiddenIssue", + "EnvelopeItemDeleteForbiddenIssueTypedDict", + "EnvelopeItemDeleteInternalServerError", + "EnvelopeItemDeleteInternalServerErrorData", + "EnvelopeItemDeleteInternalServerErrorIssue", + "EnvelopeItemDeleteInternalServerErrorIssueTypedDict", + "EnvelopeItemDeleteRequest", + "EnvelopeItemDeleteRequestTypedDict", + "EnvelopeItemDeleteResponse", + "EnvelopeItemDeleteResponseTypedDict", + "EnvelopeItemDeleteUnauthorizedError", + "EnvelopeItemDeleteUnauthorizedErrorData", + "EnvelopeItemDeleteUnauthorizedIssue", + "EnvelopeItemDeleteUnauthorizedIssueTypedDict", + "EnvelopeItemDownloadBadRequestError", + "EnvelopeItemDownloadBadRequestErrorData", + "EnvelopeItemDownloadBadRequestIssue", + "EnvelopeItemDownloadBadRequestIssueTypedDict", + "EnvelopeItemDownloadForbiddenError", + "EnvelopeItemDownloadForbiddenErrorData", + "EnvelopeItemDownloadForbiddenIssue", + "EnvelopeItemDownloadForbiddenIssueTypedDict", + "EnvelopeItemDownloadInternalServerError", + "EnvelopeItemDownloadInternalServerErrorData", + "EnvelopeItemDownloadInternalServerErrorIssue", + "EnvelopeItemDownloadInternalServerErrorIssueTypedDict", + "EnvelopeItemDownloadNotFoundError", + "EnvelopeItemDownloadNotFoundErrorData", + "EnvelopeItemDownloadNotFoundIssue", + "EnvelopeItemDownloadNotFoundIssueTypedDict", + "EnvelopeItemDownloadRequest", + "EnvelopeItemDownloadRequestTypedDict", + "EnvelopeItemDownloadResponse", + "EnvelopeItemDownloadResponseTypedDict", + "EnvelopeItemDownloadUnauthorizedError", + "EnvelopeItemDownloadUnauthorizedErrorData", + "EnvelopeItemDownloadUnauthorizedIssue", + "EnvelopeItemDownloadUnauthorizedIssueTypedDict", + "EnvelopeItemDownloadVersion", + "EnvelopeItemUpdateManyBadRequestError", + "EnvelopeItemUpdateManyBadRequestErrorData", + "EnvelopeItemUpdateManyBadRequestIssue", + "EnvelopeItemUpdateManyBadRequestIssueTypedDict", + "EnvelopeItemUpdateManyDataRequest", + "EnvelopeItemUpdateManyDataRequestTypedDict", + "EnvelopeItemUpdateManyDataResponse", + "EnvelopeItemUpdateManyDataResponseTypedDict", + "EnvelopeItemUpdateManyForbiddenError", + "EnvelopeItemUpdateManyForbiddenErrorData", + "EnvelopeItemUpdateManyForbiddenIssue", + "EnvelopeItemUpdateManyForbiddenIssueTypedDict", + "EnvelopeItemUpdateManyInternalServerError", + "EnvelopeItemUpdateManyInternalServerErrorData", + "EnvelopeItemUpdateManyInternalServerErrorIssue", + "EnvelopeItemUpdateManyInternalServerErrorIssueTypedDict", + "EnvelopeItemUpdateManyRequest", + "EnvelopeItemUpdateManyRequestTypedDict", + "EnvelopeItemUpdateManyResponse", + "EnvelopeItemUpdateManyResponseTypedDict", + "EnvelopeItemUpdateManyUnauthorizedError", + "EnvelopeItemUpdateManyUnauthorizedErrorData", + "EnvelopeItemUpdateManyUnauthorizedIssue", + "EnvelopeItemUpdateManyUnauthorizedIssueTypedDict", + "EnvelopeRecipientCreateManyAccessAuthRequest", + "EnvelopeRecipientCreateManyAccessAuthResponse", + "EnvelopeRecipientCreateManyActionAuthRequest", + "EnvelopeRecipientCreateManyActionAuthResponse", + "EnvelopeRecipientCreateManyAuthOptions", + "EnvelopeRecipientCreateManyAuthOptionsTypedDict", + "EnvelopeRecipientCreateManyBadRequestError", + "EnvelopeRecipientCreateManyBadRequestErrorData", + "EnvelopeRecipientCreateManyBadRequestIssue", + "EnvelopeRecipientCreateManyBadRequestIssueTypedDict", + "EnvelopeRecipientCreateManyDataRequest", + "EnvelopeRecipientCreateManyDataRequestTypedDict", + "EnvelopeRecipientCreateManyDataResponse", + "EnvelopeRecipientCreateManyDataResponseTypedDict", + "EnvelopeRecipientCreateManyForbiddenError", + "EnvelopeRecipientCreateManyForbiddenErrorData", + "EnvelopeRecipientCreateManyForbiddenIssue", + "EnvelopeRecipientCreateManyForbiddenIssueTypedDict", + "EnvelopeRecipientCreateManyInternalServerError", + "EnvelopeRecipientCreateManyInternalServerErrorData", + "EnvelopeRecipientCreateManyInternalServerErrorIssue", + "EnvelopeRecipientCreateManyInternalServerErrorIssueTypedDict", + "EnvelopeRecipientCreateManyReadStatus", + "EnvelopeRecipientCreateManyRequest", + "EnvelopeRecipientCreateManyRequestTypedDict", + "EnvelopeRecipientCreateManyResponse", + "EnvelopeRecipientCreateManyResponseTypedDict", + "EnvelopeRecipientCreateManyRoleRequest", + "EnvelopeRecipientCreateManyRoleResponse", + "EnvelopeRecipientCreateManySendStatus", + "EnvelopeRecipientCreateManySigningStatus", + "EnvelopeRecipientCreateManyUnauthorizedError", + "EnvelopeRecipientCreateManyUnauthorizedErrorData", + "EnvelopeRecipientCreateManyUnauthorizedIssue", + "EnvelopeRecipientCreateManyUnauthorizedIssueTypedDict", + "EnvelopeRecipientDeleteBadRequestError", + "EnvelopeRecipientDeleteBadRequestErrorData", + "EnvelopeRecipientDeleteBadRequestIssue", + "EnvelopeRecipientDeleteBadRequestIssueTypedDict", + "EnvelopeRecipientDeleteForbiddenError", + "EnvelopeRecipientDeleteForbiddenErrorData", + "EnvelopeRecipientDeleteForbiddenIssue", + "EnvelopeRecipientDeleteForbiddenIssueTypedDict", + "EnvelopeRecipientDeleteInternalServerError", + "EnvelopeRecipientDeleteInternalServerErrorData", + "EnvelopeRecipientDeleteInternalServerErrorIssue", + "EnvelopeRecipientDeleteInternalServerErrorIssueTypedDict", + "EnvelopeRecipientDeleteRequest", + "EnvelopeRecipientDeleteRequestTypedDict", + "EnvelopeRecipientDeleteResponse", + "EnvelopeRecipientDeleteResponseTypedDict", + "EnvelopeRecipientDeleteUnauthorizedError", + "EnvelopeRecipientDeleteUnauthorizedErrorData", + "EnvelopeRecipientDeleteUnauthorizedIssue", + "EnvelopeRecipientDeleteUnauthorizedIssueTypedDict", + "EnvelopeRecipientGetAccessAuth", + "EnvelopeRecipientGetActionAuth", + "EnvelopeRecipientGetAuthOptions", + "EnvelopeRecipientGetAuthOptionsTypedDict", + "EnvelopeRecipientGetBadRequestError", + "EnvelopeRecipientGetBadRequestErrorData", + "EnvelopeRecipientGetBadRequestIssue", + "EnvelopeRecipientGetBadRequestIssueTypedDict", + "EnvelopeRecipientGetDirection1", + "EnvelopeRecipientGetDirection2", + "EnvelopeRecipientGetField", + "EnvelopeRecipientGetFieldMetaCheckbox", + "EnvelopeRecipientGetFieldMetaCheckboxTypedDict", + "EnvelopeRecipientGetFieldMetaDate", + "EnvelopeRecipientGetFieldMetaDateTypedDict", + "EnvelopeRecipientGetFieldMetaDropdown", + "EnvelopeRecipientGetFieldMetaDropdownTypedDict", + "EnvelopeRecipientGetFieldMetaEmail", + "EnvelopeRecipientGetFieldMetaEmailTypedDict", + "EnvelopeRecipientGetFieldMetaInitials", + "EnvelopeRecipientGetFieldMetaInitialsTypedDict", + "EnvelopeRecipientGetFieldMetaName", + "EnvelopeRecipientGetFieldMetaNameTypedDict", + "EnvelopeRecipientGetFieldMetaNumber", + "EnvelopeRecipientGetFieldMetaNumberTypedDict", + "EnvelopeRecipientGetFieldMetaRadio", + "EnvelopeRecipientGetFieldMetaRadioTypedDict", + "EnvelopeRecipientGetFieldMetaSignature", + "EnvelopeRecipientGetFieldMetaSignatureTypedDict", + "EnvelopeRecipientGetFieldMetaText", + "EnvelopeRecipientGetFieldMetaTextTypedDict", + "EnvelopeRecipientGetFieldMetaUnion", + "EnvelopeRecipientGetFieldMetaUnionTypedDict", + "EnvelopeRecipientGetFieldTypedDict", + "EnvelopeRecipientGetForbiddenError", + "EnvelopeRecipientGetForbiddenErrorData", + "EnvelopeRecipientGetForbiddenIssue", + "EnvelopeRecipientGetForbiddenIssueTypedDict", + "EnvelopeRecipientGetInternalServerError", + "EnvelopeRecipientGetInternalServerErrorData", + "EnvelopeRecipientGetInternalServerErrorIssue", + "EnvelopeRecipientGetInternalServerErrorIssueTypedDict", + "EnvelopeRecipientGetNotFoundError", + "EnvelopeRecipientGetNotFoundErrorData", + "EnvelopeRecipientGetNotFoundIssue", + "EnvelopeRecipientGetNotFoundIssueTypedDict", + "EnvelopeRecipientGetReadStatus", + "EnvelopeRecipientGetRequest", + "EnvelopeRecipientGetRequestTypedDict", + "EnvelopeRecipientGetResponse", + "EnvelopeRecipientGetResponseTypedDict", + "EnvelopeRecipientGetRole", + "EnvelopeRecipientGetSendStatus", + "EnvelopeRecipientGetSigningStatus", + "EnvelopeRecipientGetTextAlign1", + "EnvelopeRecipientGetTextAlign2", + "EnvelopeRecipientGetTextAlign3", + "EnvelopeRecipientGetTextAlign4", + "EnvelopeRecipientGetTextAlign5", + "EnvelopeRecipientGetTextAlign6", + "EnvelopeRecipientGetType", + "EnvelopeRecipientGetTypeCheckbox", + "EnvelopeRecipientGetTypeDate", + "EnvelopeRecipientGetTypeDropdown", + "EnvelopeRecipientGetTypeEmail", + "EnvelopeRecipientGetTypeInitials", + "EnvelopeRecipientGetTypeName", + "EnvelopeRecipientGetTypeNumber", + "EnvelopeRecipientGetTypeRadio", + "EnvelopeRecipientGetTypeSignature", + "EnvelopeRecipientGetTypeText", + "EnvelopeRecipientGetUnauthorizedError", + "EnvelopeRecipientGetUnauthorizedErrorData", + "EnvelopeRecipientGetUnauthorizedIssue", + "EnvelopeRecipientGetUnauthorizedIssueTypedDict", + "EnvelopeRecipientGetValue1", + "EnvelopeRecipientGetValue1TypedDict", + "EnvelopeRecipientGetValue2", + "EnvelopeRecipientGetValue2TypedDict", + "EnvelopeRecipientGetValue3", + "EnvelopeRecipientGetValue3TypedDict", + "EnvelopeRecipientGetVerticalAlign1", + "EnvelopeRecipientGetVerticalAlign2", + "EnvelopeRecipientUpdateManyAccessAuthRequest", + "EnvelopeRecipientUpdateManyAccessAuthResponse", + "EnvelopeRecipientUpdateManyActionAuthRequest", + "EnvelopeRecipientUpdateManyActionAuthResponse", + "EnvelopeRecipientUpdateManyAuthOptions", + "EnvelopeRecipientUpdateManyAuthOptionsTypedDict", + "EnvelopeRecipientUpdateManyBadRequestError", + "EnvelopeRecipientUpdateManyBadRequestErrorData", + "EnvelopeRecipientUpdateManyBadRequestIssue", + "EnvelopeRecipientUpdateManyBadRequestIssueTypedDict", + "EnvelopeRecipientUpdateManyDataRequest", + "EnvelopeRecipientUpdateManyDataRequestTypedDict", + "EnvelopeRecipientUpdateManyDataResponse", + "EnvelopeRecipientUpdateManyDataResponseTypedDict", + "EnvelopeRecipientUpdateManyForbiddenError", + "EnvelopeRecipientUpdateManyForbiddenErrorData", + "EnvelopeRecipientUpdateManyForbiddenIssue", + "EnvelopeRecipientUpdateManyForbiddenIssueTypedDict", + "EnvelopeRecipientUpdateManyInternalServerError", + "EnvelopeRecipientUpdateManyInternalServerErrorData", + "EnvelopeRecipientUpdateManyInternalServerErrorIssue", + "EnvelopeRecipientUpdateManyInternalServerErrorIssueTypedDict", + "EnvelopeRecipientUpdateManyReadStatus", + "EnvelopeRecipientUpdateManyRequest", + "EnvelopeRecipientUpdateManyRequestTypedDict", + "EnvelopeRecipientUpdateManyResponse", + "EnvelopeRecipientUpdateManyResponseTypedDict", + "EnvelopeRecipientUpdateManyRoleRequest", + "EnvelopeRecipientUpdateManyRoleResponse", + "EnvelopeRecipientUpdateManySendStatus", + "EnvelopeRecipientUpdateManySigningStatus", + "EnvelopeRecipientUpdateManyUnauthorizedError", + "EnvelopeRecipientUpdateManyUnauthorizedErrorData", + "EnvelopeRecipientUpdateManyUnauthorizedIssue", + "EnvelopeRecipientUpdateManyUnauthorizedIssueTypedDict", + "EnvelopeRedistributeBadRequestError", + "EnvelopeRedistributeBadRequestErrorData", + "EnvelopeRedistributeBadRequestIssue", + "EnvelopeRedistributeBadRequestIssueTypedDict", + "EnvelopeRedistributeForbiddenError", + "EnvelopeRedistributeForbiddenErrorData", + "EnvelopeRedistributeForbiddenIssue", + "EnvelopeRedistributeForbiddenIssueTypedDict", + "EnvelopeRedistributeInternalServerError", + "EnvelopeRedistributeInternalServerErrorData", + "EnvelopeRedistributeInternalServerErrorIssue", + "EnvelopeRedistributeInternalServerErrorIssueTypedDict", + "EnvelopeRedistributeRequest", + "EnvelopeRedistributeRequestTypedDict", + "EnvelopeRedistributeResponse", + "EnvelopeRedistributeResponseTypedDict", + "EnvelopeRedistributeUnauthorizedError", + "EnvelopeRedistributeUnauthorizedErrorData", + "EnvelopeRedistributeUnauthorizedIssue", + "EnvelopeRedistributeUnauthorizedIssueTypedDict", + "EnvelopeUpdateAuthOptions", + "EnvelopeUpdateAuthOptionsTypedDict", + "EnvelopeUpdateBadRequestError", + "EnvelopeUpdateBadRequestErrorData", + "EnvelopeUpdateBadRequestIssue", + "EnvelopeUpdateBadRequestIssueTypedDict", + "EnvelopeUpdateData", + "EnvelopeUpdateDataGlobalAccessAuth", + "EnvelopeUpdateDataGlobalActionAuth", + "EnvelopeUpdateDataTypedDict", + "EnvelopeUpdateDataVisibility", + "EnvelopeUpdateDateFormat", + "EnvelopeUpdateDistributionMethod", + "EnvelopeUpdateEmailSettings", + "EnvelopeUpdateEmailSettingsTypedDict", + "EnvelopeUpdateForbiddenError", + "EnvelopeUpdateForbiddenErrorData", + "EnvelopeUpdateForbiddenIssue", + "EnvelopeUpdateForbiddenIssueTypedDict", + "EnvelopeUpdateFormValues", + "EnvelopeUpdateFormValuesTypedDict", + "EnvelopeUpdateGlobalAccessAuthResponse", + "EnvelopeUpdateGlobalActionAuthResponse", + "EnvelopeUpdateInternalServerError", + "EnvelopeUpdateInternalServerErrorData", + "EnvelopeUpdateInternalServerErrorIssue", + "EnvelopeUpdateInternalServerErrorIssueTypedDict", + "EnvelopeUpdateLanguage", + "EnvelopeUpdateMeta", + "EnvelopeUpdateMetaTypedDict", + "EnvelopeUpdateRequest", + "EnvelopeUpdateRequestTypedDict", + "EnvelopeUpdateResponse", + "EnvelopeUpdateResponseTypedDict", + "EnvelopeUpdateSigningOrder", + "EnvelopeUpdateSource", + "EnvelopeUpdateStatus", + "EnvelopeUpdateTemplateType", + "EnvelopeUpdateType", + "EnvelopeUpdateUnauthorizedError", + "EnvelopeUpdateUnauthorizedErrorData", + "EnvelopeUpdateUnauthorizedIssue", + "EnvelopeUpdateUnauthorizedIssueTypedDict", + "EnvelopeUpdateVisibilityResponse", + "EnvelopeUseAttachment", + "EnvelopeUseAttachmentTypedDict", + "EnvelopeUseBadRequestError", + "EnvelopeUseBadRequestErrorData", + "EnvelopeUseBadRequestIssue", + "EnvelopeUseBadRequestIssueTypedDict", + "EnvelopeUseCustomDocumentDatum", + "EnvelopeUseCustomDocumentDatumTypedDict", + "EnvelopeUseDateFormat", + "EnvelopeUseDistributionMethod", + "EnvelopeUseEmailSettings", + "EnvelopeUseEmailSettingsTypedDict", + "EnvelopeUseFile", + "EnvelopeUseFileTypedDict", + "EnvelopeUseForbiddenError", + "EnvelopeUseForbiddenErrorData", + "EnvelopeUseForbiddenIssue", + "EnvelopeUseForbiddenIssueTypedDict", + "EnvelopeUseIdentifier", + "EnvelopeUseIdentifierTypedDict", + "EnvelopeUseInternalServerError", + "EnvelopeUseInternalServerErrorData", + "EnvelopeUseInternalServerErrorIssue", + "EnvelopeUseInternalServerErrorIssueTypedDict", + "EnvelopeUseLanguage", + "EnvelopeUsePayload", + "EnvelopeUsePayloadTypedDict", + "EnvelopeUsePrefillFieldCheckbox", + "EnvelopeUsePrefillFieldCheckboxTypedDict", + "EnvelopeUsePrefillFieldDate", + "EnvelopeUsePrefillFieldDateTypedDict", + "EnvelopeUsePrefillFieldDropdown", + "EnvelopeUsePrefillFieldDropdownTypedDict", + "EnvelopeUsePrefillFieldNumber", + "EnvelopeUsePrefillFieldNumberTypedDict", + "EnvelopeUsePrefillFieldRadio", + "EnvelopeUsePrefillFieldRadioTypedDict", + "EnvelopeUsePrefillFieldText", + "EnvelopeUsePrefillFieldTextTypedDict", + "EnvelopeUsePrefillFieldUnion", + "EnvelopeUsePrefillFieldUnionTypedDict", + "EnvelopeUseRecipient", + "EnvelopeUseRecipientTypedDict", + "EnvelopeUseRequest", + "EnvelopeUseRequestTypedDict", + "EnvelopeUseResponse", + "EnvelopeUseResponseTypedDict", + "EnvelopeUseTypeCheckbox", + "EnvelopeUseTypeDate", + "EnvelopeUseTypeDropdown", + "EnvelopeUseTypeLink", + "EnvelopeUseTypeNumber", + "EnvelopeUseTypeRadio", + "EnvelopeUseTypeText", + "EnvelopeUseUnauthorizedError", + "EnvelopeUseUnauthorizedErrorData", + "EnvelopeUseUnauthorizedIssue", + "EnvelopeUseUnauthorizedIssueTypedDict", "FieldCreateDocumentFieldBadRequestError", "FieldCreateDocumentFieldBadRequestErrorData", "FieldCreateDocumentFieldBadRequestIssue", "FieldCreateDocumentFieldBadRequestIssueTypedDict", + "FieldCreateDocumentFieldDirectionCheckbox", + "FieldCreateDocumentFieldDirectionRadio", + "FieldCreateDocumentFieldDirectionResponse1", + "FieldCreateDocumentFieldDirectionResponse2", "FieldCreateDocumentFieldFieldCheckbox", "FieldCreateDocumentFieldFieldCheckboxTypedDict", "FieldCreateDocumentFieldFieldDate", @@ -3111,6 +7067,10 @@ "FieldCreateDocumentFieldFieldMetaRadioRequestTypedDict", "FieldCreateDocumentFieldFieldMetaRadioResponse", "FieldCreateDocumentFieldFieldMetaRadioResponseTypedDict", + "FieldCreateDocumentFieldFieldMetaSignatureRequest", + "FieldCreateDocumentFieldFieldMetaSignatureRequestTypedDict", + "FieldCreateDocumentFieldFieldMetaSignatureResponse", + "FieldCreateDocumentFieldFieldMetaSignatureResponseTypedDict", "FieldCreateDocumentFieldFieldMetaTextRequest", "FieldCreateDocumentFieldFieldMetaTextRequestTypedDict", "FieldCreateDocumentFieldFieldMetaTextResponse", @@ -3123,6 +7083,7 @@ "FieldCreateDocumentFieldFieldMetaTypeName", "FieldCreateDocumentFieldFieldMetaTypeNumber", "FieldCreateDocumentFieldFieldMetaTypeRadio", + "FieldCreateDocumentFieldFieldMetaTypeSignature", "FieldCreateDocumentFieldFieldMetaTypeText", "FieldCreateDocumentFieldFieldMetaUnion", "FieldCreateDocumentFieldFieldMetaUnionTypedDict", @@ -3138,6 +7099,10 @@ "FieldCreateDocumentFieldFieldTextTypedDict", "FieldCreateDocumentFieldFieldUnion", "FieldCreateDocumentFieldFieldUnionTypedDict", + "FieldCreateDocumentFieldForbiddenError", + "FieldCreateDocumentFieldForbiddenErrorData", + "FieldCreateDocumentFieldForbiddenIssue", + "FieldCreateDocumentFieldForbiddenIssueTypedDict", "FieldCreateDocumentFieldInternalServerError", "FieldCreateDocumentFieldInternalServerErrorData", "FieldCreateDocumentFieldInternalServerErrorIssue", @@ -3176,9 +7141,14 @@ "FieldCreateDocumentFieldTypeRadioRequest1", "FieldCreateDocumentFieldTypeRadioRequest2", "FieldCreateDocumentFieldTypeResponse", - "FieldCreateDocumentFieldTypeSignature", + "FieldCreateDocumentFieldTypeSignatureRequest1", + "FieldCreateDocumentFieldTypeSignatureRequest2", "FieldCreateDocumentFieldTypeTextRequest1", "FieldCreateDocumentFieldTypeTextRequest2", + "FieldCreateDocumentFieldUnauthorizedError", + "FieldCreateDocumentFieldUnauthorizedErrorData", + "FieldCreateDocumentFieldUnauthorizedIssue", + "FieldCreateDocumentFieldUnauthorizedIssueTypedDict", "FieldCreateDocumentFieldValueCheckbox", "FieldCreateDocumentFieldValueCheckboxTypedDict", "FieldCreateDocumentFieldValueDropdown", @@ -3191,10 +7161,18 @@ "FieldCreateDocumentFieldValueResponse2TypedDict", "FieldCreateDocumentFieldValueResponse3", "FieldCreateDocumentFieldValueResponse3TypedDict", + "FieldCreateDocumentFieldVerticalAlignNumber", + "FieldCreateDocumentFieldVerticalAlignResponse1", + "FieldCreateDocumentFieldVerticalAlignResponse2", + "FieldCreateDocumentFieldVerticalAlignText", "FieldCreateDocumentFieldsBadRequestError", "FieldCreateDocumentFieldsBadRequestErrorData", "FieldCreateDocumentFieldsBadRequestIssue", "FieldCreateDocumentFieldsBadRequestIssueTypedDict", + "FieldCreateDocumentFieldsDirectionCheckbox", + "FieldCreateDocumentFieldsDirectionRadio", + "FieldCreateDocumentFieldsDirectionResponse1", + "FieldCreateDocumentFieldsDirectionResponse2", "FieldCreateDocumentFieldsFieldCheckbox", "FieldCreateDocumentFieldsFieldCheckboxTypedDict", "FieldCreateDocumentFieldsFieldDate", @@ -3239,6 +7217,10 @@ "FieldCreateDocumentFieldsFieldMetaRadioRequestTypedDict", "FieldCreateDocumentFieldsFieldMetaRadioResponse", "FieldCreateDocumentFieldsFieldMetaRadioResponseTypedDict", + "FieldCreateDocumentFieldsFieldMetaSignatureRequest", + "FieldCreateDocumentFieldsFieldMetaSignatureRequestTypedDict", + "FieldCreateDocumentFieldsFieldMetaSignatureResponse", + "FieldCreateDocumentFieldsFieldMetaSignatureResponseTypedDict", "FieldCreateDocumentFieldsFieldMetaTextRequest", "FieldCreateDocumentFieldsFieldMetaTextRequestTypedDict", "FieldCreateDocumentFieldsFieldMetaTextResponse", @@ -3251,6 +7233,7 @@ "FieldCreateDocumentFieldsFieldMetaTypeName", "FieldCreateDocumentFieldsFieldMetaTypeNumber", "FieldCreateDocumentFieldsFieldMetaTypeRadio", + "FieldCreateDocumentFieldsFieldMetaTypeSignature", "FieldCreateDocumentFieldsFieldMetaTypeText", "FieldCreateDocumentFieldsFieldMetaUnion", "FieldCreateDocumentFieldsFieldMetaUnionTypedDict", @@ -3268,6 +7251,10 @@ "FieldCreateDocumentFieldsFieldTextTypedDict", "FieldCreateDocumentFieldsFieldUnion", "FieldCreateDocumentFieldsFieldUnionTypedDict", + "FieldCreateDocumentFieldsForbiddenError", + "FieldCreateDocumentFieldsForbiddenErrorData", + "FieldCreateDocumentFieldsForbiddenIssue", + "FieldCreateDocumentFieldsForbiddenIssueTypedDict", "FieldCreateDocumentFieldsInternalServerError", "FieldCreateDocumentFieldsInternalServerErrorData", "FieldCreateDocumentFieldsInternalServerErrorIssue", @@ -3306,9 +7293,14 @@ "FieldCreateDocumentFieldsTypeRadioRequest1", "FieldCreateDocumentFieldsTypeRadioRequest2", "FieldCreateDocumentFieldsTypeResponse", - "FieldCreateDocumentFieldsTypeSignature", + "FieldCreateDocumentFieldsTypeSignatureRequest1", + "FieldCreateDocumentFieldsTypeSignatureRequest2", "FieldCreateDocumentFieldsTypeTextRequest1", "FieldCreateDocumentFieldsTypeTextRequest2", + "FieldCreateDocumentFieldsUnauthorizedError", + "FieldCreateDocumentFieldsUnauthorizedErrorData", + "FieldCreateDocumentFieldsUnauthorizedIssue", + "FieldCreateDocumentFieldsUnauthorizedIssueTypedDict", "FieldCreateDocumentFieldsValueCheckbox", "FieldCreateDocumentFieldsValueCheckboxTypedDict", "FieldCreateDocumentFieldsValueDropdown", @@ -3321,10 +7313,18 @@ "FieldCreateDocumentFieldsValueResponse2TypedDict", "FieldCreateDocumentFieldsValueResponse3", "FieldCreateDocumentFieldsValueResponse3TypedDict", + "FieldCreateDocumentFieldsVerticalAlignNumber", + "FieldCreateDocumentFieldsVerticalAlignResponse1", + "FieldCreateDocumentFieldsVerticalAlignResponse2", + "FieldCreateDocumentFieldsVerticalAlignText", "FieldCreateTemplateFieldBadRequestError", "FieldCreateTemplateFieldBadRequestErrorData", "FieldCreateTemplateFieldBadRequestIssue", "FieldCreateTemplateFieldBadRequestIssueTypedDict", + "FieldCreateTemplateFieldDirectionCheckbox", + "FieldCreateTemplateFieldDirectionRadio", + "FieldCreateTemplateFieldDirectionResponse1", + "FieldCreateTemplateFieldDirectionResponse2", "FieldCreateTemplateFieldFieldCheckbox", "FieldCreateTemplateFieldFieldCheckboxTypedDict", "FieldCreateTemplateFieldFieldDate", @@ -3369,6 +7369,10 @@ "FieldCreateTemplateFieldFieldMetaRadioRequestTypedDict", "FieldCreateTemplateFieldFieldMetaRadioResponse", "FieldCreateTemplateFieldFieldMetaRadioResponseTypedDict", + "FieldCreateTemplateFieldFieldMetaSignatureRequest", + "FieldCreateTemplateFieldFieldMetaSignatureRequestTypedDict", + "FieldCreateTemplateFieldFieldMetaSignatureResponse", + "FieldCreateTemplateFieldFieldMetaSignatureResponseTypedDict", "FieldCreateTemplateFieldFieldMetaTextRequest", "FieldCreateTemplateFieldFieldMetaTextRequestTypedDict", "FieldCreateTemplateFieldFieldMetaTextResponse", @@ -3381,6 +7385,7 @@ "FieldCreateTemplateFieldFieldMetaTypeName", "FieldCreateTemplateFieldFieldMetaTypeNumber", "FieldCreateTemplateFieldFieldMetaTypeRadio", + "FieldCreateTemplateFieldFieldMetaTypeSignature", "FieldCreateTemplateFieldFieldMetaTypeText", "FieldCreateTemplateFieldFieldMetaUnion", "FieldCreateTemplateFieldFieldMetaUnionTypedDict", @@ -3396,6 +7401,10 @@ "FieldCreateTemplateFieldFieldTextTypedDict", "FieldCreateTemplateFieldFieldUnion", "FieldCreateTemplateFieldFieldUnionTypedDict", + "FieldCreateTemplateFieldForbiddenError", + "FieldCreateTemplateFieldForbiddenErrorData", + "FieldCreateTemplateFieldForbiddenIssue", + "FieldCreateTemplateFieldForbiddenIssueTypedDict", "FieldCreateTemplateFieldInternalServerError", "FieldCreateTemplateFieldInternalServerErrorData", "FieldCreateTemplateFieldInternalServerErrorIssue", @@ -3434,9 +7443,14 @@ "FieldCreateTemplateFieldTypeRadioRequest1", "FieldCreateTemplateFieldTypeRadioRequest2", "FieldCreateTemplateFieldTypeResponse", - "FieldCreateTemplateFieldTypeSignature", + "FieldCreateTemplateFieldTypeSignatureRequest1", + "FieldCreateTemplateFieldTypeSignatureRequest2", "FieldCreateTemplateFieldTypeTextRequest1", "FieldCreateTemplateFieldTypeTextRequest2", + "FieldCreateTemplateFieldUnauthorizedError", + "FieldCreateTemplateFieldUnauthorizedErrorData", + "FieldCreateTemplateFieldUnauthorizedIssue", + "FieldCreateTemplateFieldUnauthorizedIssueTypedDict", "FieldCreateTemplateFieldValueCheckbox", "FieldCreateTemplateFieldValueCheckboxTypedDict", "FieldCreateTemplateFieldValueDropdown", @@ -3449,10 +7463,18 @@ "FieldCreateTemplateFieldValueResponse2TypedDict", "FieldCreateTemplateFieldValueResponse3", "FieldCreateTemplateFieldValueResponse3TypedDict", + "FieldCreateTemplateFieldVerticalAlignNumber", + "FieldCreateTemplateFieldVerticalAlignResponse1", + "FieldCreateTemplateFieldVerticalAlignResponse2", + "FieldCreateTemplateFieldVerticalAlignText", "FieldCreateTemplateFieldsBadRequestError", "FieldCreateTemplateFieldsBadRequestErrorData", "FieldCreateTemplateFieldsBadRequestIssue", "FieldCreateTemplateFieldsBadRequestIssueTypedDict", + "FieldCreateTemplateFieldsDirectionCheckbox", + "FieldCreateTemplateFieldsDirectionRadio", + "FieldCreateTemplateFieldsDirectionResponse1", + "FieldCreateTemplateFieldsDirectionResponse2", "FieldCreateTemplateFieldsFieldCheckbox", "FieldCreateTemplateFieldsFieldCheckboxTypedDict", "FieldCreateTemplateFieldsFieldDate", @@ -3497,6 +7519,10 @@ "FieldCreateTemplateFieldsFieldMetaRadioRequestTypedDict", "FieldCreateTemplateFieldsFieldMetaRadioResponse", "FieldCreateTemplateFieldsFieldMetaRadioResponseTypedDict", + "FieldCreateTemplateFieldsFieldMetaSignatureRequest", + "FieldCreateTemplateFieldsFieldMetaSignatureRequestTypedDict", + "FieldCreateTemplateFieldsFieldMetaSignatureResponse", + "FieldCreateTemplateFieldsFieldMetaSignatureResponseTypedDict", "FieldCreateTemplateFieldsFieldMetaTextRequest", "FieldCreateTemplateFieldsFieldMetaTextRequestTypedDict", "FieldCreateTemplateFieldsFieldMetaTextResponse", @@ -3509,6 +7535,7 @@ "FieldCreateTemplateFieldsFieldMetaTypeName", "FieldCreateTemplateFieldsFieldMetaTypeNumber", "FieldCreateTemplateFieldsFieldMetaTypeRadio", + "FieldCreateTemplateFieldsFieldMetaTypeSignature", "FieldCreateTemplateFieldsFieldMetaTypeText", "FieldCreateTemplateFieldsFieldMetaUnion", "FieldCreateTemplateFieldsFieldMetaUnionTypedDict", @@ -3526,6 +7553,10 @@ "FieldCreateTemplateFieldsFieldTextTypedDict", "FieldCreateTemplateFieldsFieldUnion", "FieldCreateTemplateFieldsFieldUnionTypedDict", + "FieldCreateTemplateFieldsForbiddenError", + "FieldCreateTemplateFieldsForbiddenErrorData", + "FieldCreateTemplateFieldsForbiddenIssue", + "FieldCreateTemplateFieldsForbiddenIssueTypedDict", "FieldCreateTemplateFieldsInternalServerError", "FieldCreateTemplateFieldsInternalServerErrorData", "FieldCreateTemplateFieldsInternalServerErrorIssue", @@ -3564,9 +7595,14 @@ "FieldCreateTemplateFieldsTypeRadioRequest1", "FieldCreateTemplateFieldsTypeRadioRequest2", "FieldCreateTemplateFieldsTypeResponse", - "FieldCreateTemplateFieldsTypeSignature", + "FieldCreateTemplateFieldsTypeSignatureRequest1", + "FieldCreateTemplateFieldsTypeSignatureRequest2", "FieldCreateTemplateFieldsTypeTextRequest1", "FieldCreateTemplateFieldsTypeTextRequest2", + "FieldCreateTemplateFieldsUnauthorizedError", + "FieldCreateTemplateFieldsUnauthorizedErrorData", + "FieldCreateTemplateFieldsUnauthorizedIssue", + "FieldCreateTemplateFieldsUnauthorizedIssueTypedDict", "FieldCreateTemplateFieldsValueCheckbox", "FieldCreateTemplateFieldsValueCheckboxTypedDict", "FieldCreateTemplateFieldsValueDropdown", @@ -3579,10 +7615,18 @@ "FieldCreateTemplateFieldsValueResponse2TypedDict", "FieldCreateTemplateFieldsValueResponse3", "FieldCreateTemplateFieldsValueResponse3TypedDict", + "FieldCreateTemplateFieldsVerticalAlignNumber", + "FieldCreateTemplateFieldsVerticalAlignResponse1", + "FieldCreateTemplateFieldsVerticalAlignResponse2", + "FieldCreateTemplateFieldsVerticalAlignText", "FieldDeleteDocumentFieldBadRequestError", "FieldDeleteDocumentFieldBadRequestErrorData", "FieldDeleteDocumentFieldBadRequestIssue", "FieldDeleteDocumentFieldBadRequestIssueTypedDict", + "FieldDeleteDocumentFieldForbiddenError", + "FieldDeleteDocumentFieldForbiddenErrorData", + "FieldDeleteDocumentFieldForbiddenIssue", + "FieldDeleteDocumentFieldForbiddenIssueTypedDict", "FieldDeleteDocumentFieldInternalServerError", "FieldDeleteDocumentFieldInternalServerErrorData", "FieldDeleteDocumentFieldInternalServerErrorIssue", @@ -3591,10 +7635,18 @@ "FieldDeleteDocumentFieldRequestTypedDict", "FieldDeleteDocumentFieldResponse", "FieldDeleteDocumentFieldResponseTypedDict", + "FieldDeleteDocumentFieldUnauthorizedError", + "FieldDeleteDocumentFieldUnauthorizedErrorData", + "FieldDeleteDocumentFieldUnauthorizedIssue", + "FieldDeleteDocumentFieldUnauthorizedIssueTypedDict", "FieldDeleteTemplateFieldBadRequestError", "FieldDeleteTemplateFieldBadRequestErrorData", "FieldDeleteTemplateFieldBadRequestIssue", "FieldDeleteTemplateFieldBadRequestIssueTypedDict", + "FieldDeleteTemplateFieldForbiddenError", + "FieldDeleteTemplateFieldForbiddenErrorData", + "FieldDeleteTemplateFieldForbiddenIssue", + "FieldDeleteTemplateFieldForbiddenIssueTypedDict", "FieldDeleteTemplateFieldInternalServerError", "FieldDeleteTemplateFieldInternalServerErrorData", "FieldDeleteTemplateFieldInternalServerErrorIssue", @@ -3603,10 +7655,16 @@ "FieldDeleteTemplateFieldRequestTypedDict", "FieldDeleteTemplateFieldResponse", "FieldDeleteTemplateFieldResponseTypedDict", + "FieldDeleteTemplateFieldUnauthorizedError", + "FieldDeleteTemplateFieldUnauthorizedErrorData", + "FieldDeleteTemplateFieldUnauthorizedIssue", + "FieldDeleteTemplateFieldUnauthorizedIssueTypedDict", "FieldGetDocumentFieldBadRequestError", "FieldGetDocumentFieldBadRequestErrorData", "FieldGetDocumentFieldBadRequestIssue", "FieldGetDocumentFieldBadRequestIssueTypedDict", + "FieldGetDocumentFieldDirection1", + "FieldGetDocumentFieldDirection2", "FieldGetDocumentFieldFieldMetaCheckbox", "FieldGetDocumentFieldFieldMetaCheckboxTypedDict", "FieldGetDocumentFieldFieldMetaDate", @@ -3623,10 +7681,16 @@ "FieldGetDocumentFieldFieldMetaNumberTypedDict", "FieldGetDocumentFieldFieldMetaRadio", "FieldGetDocumentFieldFieldMetaRadioTypedDict", + "FieldGetDocumentFieldFieldMetaSignature", + "FieldGetDocumentFieldFieldMetaSignatureTypedDict", "FieldGetDocumentFieldFieldMetaText", "FieldGetDocumentFieldFieldMetaTextTypedDict", "FieldGetDocumentFieldFieldMetaUnion", "FieldGetDocumentFieldFieldMetaUnionTypedDict", + "FieldGetDocumentFieldForbiddenError", + "FieldGetDocumentFieldForbiddenErrorData", + "FieldGetDocumentFieldForbiddenIssue", + "FieldGetDocumentFieldForbiddenIssueTypedDict", "FieldGetDocumentFieldInternalServerError", "FieldGetDocumentFieldInternalServerErrorData", "FieldGetDocumentFieldInternalServerErrorIssue", @@ -3654,17 +7718,26 @@ "FieldGetDocumentFieldTypeName", "FieldGetDocumentFieldTypeNumber", "FieldGetDocumentFieldTypeRadio", + "FieldGetDocumentFieldTypeSignature", "FieldGetDocumentFieldTypeText", + "FieldGetDocumentFieldUnauthorizedError", + "FieldGetDocumentFieldUnauthorizedErrorData", + "FieldGetDocumentFieldUnauthorizedIssue", + "FieldGetDocumentFieldUnauthorizedIssueTypedDict", "FieldGetDocumentFieldValue1", "FieldGetDocumentFieldValue1TypedDict", "FieldGetDocumentFieldValue2", "FieldGetDocumentFieldValue2TypedDict", "FieldGetDocumentFieldValue3", "FieldGetDocumentFieldValue3TypedDict", + "FieldGetDocumentFieldVerticalAlign1", + "FieldGetDocumentFieldVerticalAlign2", "FieldGetTemplateFieldBadRequestError", "FieldGetTemplateFieldBadRequestErrorData", "FieldGetTemplateFieldBadRequestIssue", "FieldGetTemplateFieldBadRequestIssueTypedDict", + "FieldGetTemplateFieldDirection1", + "FieldGetTemplateFieldDirection2", "FieldGetTemplateFieldFieldMetaCheckbox", "FieldGetTemplateFieldFieldMetaCheckboxTypedDict", "FieldGetTemplateFieldFieldMetaDate", @@ -3681,10 +7754,16 @@ "FieldGetTemplateFieldFieldMetaNumberTypedDict", "FieldGetTemplateFieldFieldMetaRadio", "FieldGetTemplateFieldFieldMetaRadioTypedDict", + "FieldGetTemplateFieldFieldMetaSignature", + "FieldGetTemplateFieldFieldMetaSignatureTypedDict", "FieldGetTemplateFieldFieldMetaText", "FieldGetTemplateFieldFieldMetaTextTypedDict", "FieldGetTemplateFieldFieldMetaUnion", "FieldGetTemplateFieldFieldMetaUnionTypedDict", + "FieldGetTemplateFieldForbiddenError", + "FieldGetTemplateFieldForbiddenErrorData", + "FieldGetTemplateFieldForbiddenIssue", + "FieldGetTemplateFieldForbiddenIssueTypedDict", "FieldGetTemplateFieldInternalServerError", "FieldGetTemplateFieldInternalServerErrorData", "FieldGetTemplateFieldInternalServerErrorIssue", @@ -3712,13 +7791,20 @@ "FieldGetTemplateFieldTypeName", "FieldGetTemplateFieldTypeNumber", "FieldGetTemplateFieldTypeRadio", + "FieldGetTemplateFieldTypeSignature", "FieldGetTemplateFieldTypeText", + "FieldGetTemplateFieldUnauthorizedError", + "FieldGetTemplateFieldUnauthorizedErrorData", + "FieldGetTemplateFieldUnauthorizedIssue", + "FieldGetTemplateFieldUnauthorizedIssueTypedDict", "FieldGetTemplateFieldValue1", "FieldGetTemplateFieldValue1TypedDict", "FieldGetTemplateFieldValue2", "FieldGetTemplateFieldValue2TypedDict", "FieldGetTemplateFieldValue3", "FieldGetTemplateFieldValue3TypedDict", + "FieldGetTemplateFieldVerticalAlign1", + "FieldGetTemplateFieldVerticalAlign2", "FieldMetaDocumentCheckbox", "FieldMetaDocumentCheckboxTypedDict", "FieldMetaDocumentDate", @@ -3735,12 +7821,18 @@ "FieldMetaDocumentNumberTypedDict", "FieldMetaDocumentRadio", "FieldMetaDocumentRadioTypedDict", + "FieldMetaDocumentSignature", + "FieldMetaDocumentSignatureTypedDict", "FieldMetaDocumentText", "FieldMetaDocumentTextTypedDict", "FieldUpdateDocumentFieldBadRequestError", "FieldUpdateDocumentFieldBadRequestErrorData", "FieldUpdateDocumentFieldBadRequestIssue", "FieldUpdateDocumentFieldBadRequestIssueTypedDict", + "FieldUpdateDocumentFieldDirectionCheckbox", + "FieldUpdateDocumentFieldDirectionRadio", + "FieldUpdateDocumentFieldDirectionResponse1", + "FieldUpdateDocumentFieldDirectionResponse2", "FieldUpdateDocumentFieldFieldCheckbox", "FieldUpdateDocumentFieldFieldCheckboxTypedDict", "FieldUpdateDocumentFieldFieldDate", @@ -3785,6 +7877,10 @@ "FieldUpdateDocumentFieldFieldMetaRadioRequestTypedDict", "FieldUpdateDocumentFieldFieldMetaRadioResponse", "FieldUpdateDocumentFieldFieldMetaRadioResponseTypedDict", + "FieldUpdateDocumentFieldFieldMetaSignatureRequest", + "FieldUpdateDocumentFieldFieldMetaSignatureRequestTypedDict", + "FieldUpdateDocumentFieldFieldMetaSignatureResponse", + "FieldUpdateDocumentFieldFieldMetaSignatureResponseTypedDict", "FieldUpdateDocumentFieldFieldMetaTextRequest", "FieldUpdateDocumentFieldFieldMetaTextRequestTypedDict", "FieldUpdateDocumentFieldFieldMetaTextResponse", @@ -3797,6 +7893,7 @@ "FieldUpdateDocumentFieldFieldMetaTypeName", "FieldUpdateDocumentFieldFieldMetaTypeNumber", "FieldUpdateDocumentFieldFieldMetaTypeRadio", + "FieldUpdateDocumentFieldFieldMetaTypeSignature", "FieldUpdateDocumentFieldFieldMetaTypeText", "FieldUpdateDocumentFieldFieldMetaUnion", "FieldUpdateDocumentFieldFieldMetaUnionTypedDict", @@ -3812,6 +7909,10 @@ "FieldUpdateDocumentFieldFieldTextTypedDict", "FieldUpdateDocumentFieldFieldUnion", "FieldUpdateDocumentFieldFieldUnionTypedDict", + "FieldUpdateDocumentFieldForbiddenError", + "FieldUpdateDocumentFieldForbiddenErrorData", + "FieldUpdateDocumentFieldForbiddenIssue", + "FieldUpdateDocumentFieldForbiddenIssueTypedDict", "FieldUpdateDocumentFieldInternalServerError", "FieldUpdateDocumentFieldInternalServerErrorData", "FieldUpdateDocumentFieldInternalServerErrorIssue", @@ -3850,9 +7951,14 @@ "FieldUpdateDocumentFieldTypeRadioRequest1", "FieldUpdateDocumentFieldTypeRadioRequest2", "FieldUpdateDocumentFieldTypeResponse", - "FieldUpdateDocumentFieldTypeSignature", + "FieldUpdateDocumentFieldTypeSignatureRequest1", + "FieldUpdateDocumentFieldTypeSignatureRequest2", "FieldUpdateDocumentFieldTypeTextRequest1", "FieldUpdateDocumentFieldTypeTextRequest2", + "FieldUpdateDocumentFieldUnauthorizedError", + "FieldUpdateDocumentFieldUnauthorizedErrorData", + "FieldUpdateDocumentFieldUnauthorizedIssue", + "FieldUpdateDocumentFieldUnauthorizedIssueTypedDict", "FieldUpdateDocumentFieldValueCheckbox", "FieldUpdateDocumentFieldValueCheckboxTypedDict", "FieldUpdateDocumentFieldValueDropdown", @@ -3865,10 +7971,18 @@ "FieldUpdateDocumentFieldValueResponse2TypedDict", "FieldUpdateDocumentFieldValueResponse3", "FieldUpdateDocumentFieldValueResponse3TypedDict", + "FieldUpdateDocumentFieldVerticalAlignNumber", + "FieldUpdateDocumentFieldVerticalAlignResponse1", + "FieldUpdateDocumentFieldVerticalAlignResponse2", + "FieldUpdateDocumentFieldVerticalAlignText", "FieldUpdateDocumentFieldsBadRequestError", "FieldUpdateDocumentFieldsBadRequestErrorData", "FieldUpdateDocumentFieldsBadRequestIssue", "FieldUpdateDocumentFieldsBadRequestIssueTypedDict", + "FieldUpdateDocumentFieldsDirectionCheckbox", + "FieldUpdateDocumentFieldsDirectionRadio", + "FieldUpdateDocumentFieldsDirectionResponse1", + "FieldUpdateDocumentFieldsDirectionResponse2", "FieldUpdateDocumentFieldsFieldCheckbox", "FieldUpdateDocumentFieldsFieldCheckboxTypedDict", "FieldUpdateDocumentFieldsFieldDate", @@ -3913,6 +8027,10 @@ "FieldUpdateDocumentFieldsFieldMetaRadioRequestTypedDict", "FieldUpdateDocumentFieldsFieldMetaRadioResponse", "FieldUpdateDocumentFieldsFieldMetaRadioResponseTypedDict", + "FieldUpdateDocumentFieldsFieldMetaSignatureRequest", + "FieldUpdateDocumentFieldsFieldMetaSignatureRequestTypedDict", + "FieldUpdateDocumentFieldsFieldMetaSignatureResponse", + "FieldUpdateDocumentFieldsFieldMetaSignatureResponseTypedDict", "FieldUpdateDocumentFieldsFieldMetaTextRequest", "FieldUpdateDocumentFieldsFieldMetaTextRequestTypedDict", "FieldUpdateDocumentFieldsFieldMetaTextResponse", @@ -3925,6 +8043,7 @@ "FieldUpdateDocumentFieldsFieldMetaTypeName", "FieldUpdateDocumentFieldsFieldMetaTypeNumber", "FieldUpdateDocumentFieldsFieldMetaTypeRadio", + "FieldUpdateDocumentFieldsFieldMetaTypeSignature", "FieldUpdateDocumentFieldsFieldMetaTypeText", "FieldUpdateDocumentFieldsFieldMetaUnion", "FieldUpdateDocumentFieldsFieldMetaUnionTypedDict", @@ -3942,6 +8061,10 @@ "FieldUpdateDocumentFieldsFieldTextTypedDict", "FieldUpdateDocumentFieldsFieldUnion", "FieldUpdateDocumentFieldsFieldUnionTypedDict", + "FieldUpdateDocumentFieldsForbiddenError", + "FieldUpdateDocumentFieldsForbiddenErrorData", + "FieldUpdateDocumentFieldsForbiddenIssue", + "FieldUpdateDocumentFieldsForbiddenIssueTypedDict", "FieldUpdateDocumentFieldsInternalServerError", "FieldUpdateDocumentFieldsInternalServerErrorData", "FieldUpdateDocumentFieldsInternalServerErrorIssue", @@ -3980,9 +8103,14 @@ "FieldUpdateDocumentFieldsTypeRadioRequest1", "FieldUpdateDocumentFieldsTypeRadioRequest2", "FieldUpdateDocumentFieldsTypeResponse", - "FieldUpdateDocumentFieldsTypeSignature", + "FieldUpdateDocumentFieldsTypeSignatureRequest1", + "FieldUpdateDocumentFieldsTypeSignatureRequest2", "FieldUpdateDocumentFieldsTypeTextRequest1", "FieldUpdateDocumentFieldsTypeTextRequest2", + "FieldUpdateDocumentFieldsUnauthorizedError", + "FieldUpdateDocumentFieldsUnauthorizedErrorData", + "FieldUpdateDocumentFieldsUnauthorizedIssue", + "FieldUpdateDocumentFieldsUnauthorizedIssueTypedDict", "FieldUpdateDocumentFieldsValueCheckbox", "FieldUpdateDocumentFieldsValueCheckboxTypedDict", "FieldUpdateDocumentFieldsValueDropdown", @@ -3995,10 +8123,18 @@ "FieldUpdateDocumentFieldsValueResponse2TypedDict", "FieldUpdateDocumentFieldsValueResponse3", "FieldUpdateDocumentFieldsValueResponse3TypedDict", + "FieldUpdateDocumentFieldsVerticalAlignNumber", + "FieldUpdateDocumentFieldsVerticalAlignResponse1", + "FieldUpdateDocumentFieldsVerticalAlignResponse2", + "FieldUpdateDocumentFieldsVerticalAlignText", "FieldUpdateTemplateFieldBadRequestError", "FieldUpdateTemplateFieldBadRequestErrorData", "FieldUpdateTemplateFieldBadRequestIssue", "FieldUpdateTemplateFieldBadRequestIssueTypedDict", + "FieldUpdateTemplateFieldDirectionCheckbox", + "FieldUpdateTemplateFieldDirectionRadio", + "FieldUpdateTemplateFieldDirectionResponse1", + "FieldUpdateTemplateFieldDirectionResponse2", "FieldUpdateTemplateFieldFieldCheckbox", "FieldUpdateTemplateFieldFieldCheckboxTypedDict", "FieldUpdateTemplateFieldFieldDate", @@ -4043,6 +8179,10 @@ "FieldUpdateTemplateFieldFieldMetaRadioRequestTypedDict", "FieldUpdateTemplateFieldFieldMetaRadioResponse", "FieldUpdateTemplateFieldFieldMetaRadioResponseTypedDict", + "FieldUpdateTemplateFieldFieldMetaSignatureRequest", + "FieldUpdateTemplateFieldFieldMetaSignatureRequestTypedDict", + "FieldUpdateTemplateFieldFieldMetaSignatureResponse", + "FieldUpdateTemplateFieldFieldMetaSignatureResponseTypedDict", "FieldUpdateTemplateFieldFieldMetaTextRequest", "FieldUpdateTemplateFieldFieldMetaTextRequestTypedDict", "FieldUpdateTemplateFieldFieldMetaTextResponse", @@ -4055,6 +8195,7 @@ "FieldUpdateTemplateFieldFieldMetaTypeName", "FieldUpdateTemplateFieldFieldMetaTypeNumber", "FieldUpdateTemplateFieldFieldMetaTypeRadio", + "FieldUpdateTemplateFieldFieldMetaTypeSignature", "FieldUpdateTemplateFieldFieldMetaTypeText", "FieldUpdateTemplateFieldFieldMetaUnion", "FieldUpdateTemplateFieldFieldMetaUnionTypedDict", @@ -4070,6 +8211,10 @@ "FieldUpdateTemplateFieldFieldTextTypedDict", "FieldUpdateTemplateFieldFieldUnion", "FieldUpdateTemplateFieldFieldUnionTypedDict", + "FieldUpdateTemplateFieldForbiddenError", + "FieldUpdateTemplateFieldForbiddenErrorData", + "FieldUpdateTemplateFieldForbiddenIssue", + "FieldUpdateTemplateFieldForbiddenIssueTypedDict", "FieldUpdateTemplateFieldInternalServerError", "FieldUpdateTemplateFieldInternalServerErrorData", "FieldUpdateTemplateFieldInternalServerErrorIssue", @@ -4108,9 +8253,14 @@ "FieldUpdateTemplateFieldTypeRadioRequest1", "FieldUpdateTemplateFieldTypeRadioRequest2", "FieldUpdateTemplateFieldTypeResponse", - "FieldUpdateTemplateFieldTypeSignature", + "FieldUpdateTemplateFieldTypeSignatureRequest1", + "FieldUpdateTemplateFieldTypeSignatureRequest2", "FieldUpdateTemplateFieldTypeTextRequest1", "FieldUpdateTemplateFieldTypeTextRequest2", + "FieldUpdateTemplateFieldUnauthorizedError", + "FieldUpdateTemplateFieldUnauthorizedErrorData", + "FieldUpdateTemplateFieldUnauthorizedIssue", + "FieldUpdateTemplateFieldUnauthorizedIssueTypedDict", "FieldUpdateTemplateFieldValueCheckbox", "FieldUpdateTemplateFieldValueCheckboxTypedDict", "FieldUpdateTemplateFieldValueDropdown", @@ -4123,10 +8273,18 @@ "FieldUpdateTemplateFieldValueResponse2TypedDict", "FieldUpdateTemplateFieldValueResponse3", "FieldUpdateTemplateFieldValueResponse3TypedDict", + "FieldUpdateTemplateFieldVerticalAlignNumber", + "FieldUpdateTemplateFieldVerticalAlignResponse1", + "FieldUpdateTemplateFieldVerticalAlignResponse2", + "FieldUpdateTemplateFieldVerticalAlignText", "FieldUpdateTemplateFieldsBadRequestError", "FieldUpdateTemplateFieldsBadRequestErrorData", "FieldUpdateTemplateFieldsBadRequestIssue", "FieldUpdateTemplateFieldsBadRequestIssueTypedDict", + "FieldUpdateTemplateFieldsDirectionCheckbox", + "FieldUpdateTemplateFieldsDirectionRadio", + "FieldUpdateTemplateFieldsDirectionResponse1", + "FieldUpdateTemplateFieldsDirectionResponse2", "FieldUpdateTemplateFieldsFieldCheckbox", "FieldUpdateTemplateFieldsFieldCheckboxTypedDict", "FieldUpdateTemplateFieldsFieldDate", @@ -4171,6 +8329,10 @@ "FieldUpdateTemplateFieldsFieldMetaRadioRequestTypedDict", "FieldUpdateTemplateFieldsFieldMetaRadioResponse", "FieldUpdateTemplateFieldsFieldMetaRadioResponseTypedDict", + "FieldUpdateTemplateFieldsFieldMetaSignatureRequest", + "FieldUpdateTemplateFieldsFieldMetaSignatureRequestTypedDict", + "FieldUpdateTemplateFieldsFieldMetaSignatureResponse", + "FieldUpdateTemplateFieldsFieldMetaSignatureResponseTypedDict", "FieldUpdateTemplateFieldsFieldMetaTextRequest", "FieldUpdateTemplateFieldsFieldMetaTextRequestTypedDict", "FieldUpdateTemplateFieldsFieldMetaTextResponse", @@ -4183,6 +8345,7 @@ "FieldUpdateTemplateFieldsFieldMetaTypeName", "FieldUpdateTemplateFieldsFieldMetaTypeNumber", "FieldUpdateTemplateFieldsFieldMetaTypeRadio", + "FieldUpdateTemplateFieldsFieldMetaTypeSignature", "FieldUpdateTemplateFieldsFieldMetaTypeText", "FieldUpdateTemplateFieldsFieldMetaUnion", "FieldUpdateTemplateFieldsFieldMetaUnionTypedDict", @@ -4200,6 +8363,10 @@ "FieldUpdateTemplateFieldsFieldTextTypedDict", "FieldUpdateTemplateFieldsFieldUnion", "FieldUpdateTemplateFieldsFieldUnionTypedDict", + "FieldUpdateTemplateFieldsForbiddenError", + "FieldUpdateTemplateFieldsForbiddenErrorData", + "FieldUpdateTemplateFieldsForbiddenIssue", + "FieldUpdateTemplateFieldsForbiddenIssueTypedDict", "FieldUpdateTemplateFieldsInternalServerError", "FieldUpdateTemplateFieldsInternalServerErrorData", "FieldUpdateTemplateFieldsInternalServerErrorIssue", @@ -4238,9 +8405,14 @@ "FieldUpdateTemplateFieldsTypeRadioRequest1", "FieldUpdateTemplateFieldsTypeRadioRequest2", "FieldUpdateTemplateFieldsTypeResponse", - "FieldUpdateTemplateFieldsTypeSignature", + "FieldUpdateTemplateFieldsTypeSignatureRequest1", + "FieldUpdateTemplateFieldsTypeSignatureRequest2", "FieldUpdateTemplateFieldsTypeTextRequest1", "FieldUpdateTemplateFieldsTypeTextRequest2", + "FieldUpdateTemplateFieldsUnauthorizedError", + "FieldUpdateTemplateFieldsUnauthorizedErrorData", + "FieldUpdateTemplateFieldsUnauthorizedIssue", + "FieldUpdateTemplateFieldsUnauthorizedIssueTypedDict", "FieldUpdateTemplateFieldsValueCheckbox", "FieldUpdateTemplateFieldsValueCheckboxTypedDict", "FieldUpdateTemplateFieldsValueDropdown", @@ -4253,34 +8425,114 @@ "FieldUpdateTemplateFieldsValueResponse2TypedDict", "FieldUpdateTemplateFieldsValueResponse3", "FieldUpdateTemplateFieldsValueResponse3TypedDict", - "FormValuesRequest", - "FormValuesRequestTypedDict", + "FieldUpdateTemplateFieldsVerticalAlignNumber", + "FieldUpdateTemplateFieldsVerticalAlignResponse1", + "FieldUpdateTemplateFieldsVerticalAlignResponse2", + "FieldUpdateTemplateFieldsVerticalAlignText", + "FolderCreateFolderBadRequestError", + "FolderCreateFolderBadRequestErrorData", + "FolderCreateFolderBadRequestIssue", + "FolderCreateFolderBadRequestIssueTypedDict", + "FolderCreateFolderForbiddenError", + "FolderCreateFolderForbiddenErrorData", + "FolderCreateFolderForbiddenIssue", + "FolderCreateFolderForbiddenIssueTypedDict", + "FolderCreateFolderInternalServerError", + "FolderCreateFolderInternalServerErrorData", + "FolderCreateFolderInternalServerErrorIssue", + "FolderCreateFolderInternalServerErrorIssueTypedDict", + "FolderCreateFolderRequest", + "FolderCreateFolderRequestTypedDict", + "FolderCreateFolderResponse", + "FolderCreateFolderResponseTypedDict", + "FolderCreateFolderTypeRequest", + "FolderCreateFolderTypeResponse", + "FolderCreateFolderUnauthorizedError", + "FolderCreateFolderUnauthorizedErrorData", + "FolderCreateFolderUnauthorizedIssue", + "FolderCreateFolderUnauthorizedIssueTypedDict", + "FolderCreateFolderVisibility", + "FolderDeleteFolderBadRequestError", + "FolderDeleteFolderBadRequestErrorData", + "FolderDeleteFolderBadRequestIssue", + "FolderDeleteFolderBadRequestIssueTypedDict", + "FolderDeleteFolderForbiddenError", + "FolderDeleteFolderForbiddenErrorData", + "FolderDeleteFolderForbiddenIssue", + "FolderDeleteFolderForbiddenIssueTypedDict", + "FolderDeleteFolderInternalServerError", + "FolderDeleteFolderInternalServerErrorData", + "FolderDeleteFolderInternalServerErrorIssue", + "FolderDeleteFolderInternalServerErrorIssueTypedDict", + "FolderDeleteFolderRequest", + "FolderDeleteFolderRequestTypedDict", + "FolderDeleteFolderResponse", + "FolderDeleteFolderResponseTypedDict", + "FolderDeleteFolderUnauthorizedError", + "FolderDeleteFolderUnauthorizedErrorData", + "FolderDeleteFolderUnauthorizedIssue", + "FolderDeleteFolderUnauthorizedIssueTypedDict", + "FolderFindFoldersBadRequestError", + "FolderFindFoldersBadRequestErrorData", + "FolderFindFoldersBadRequestIssue", + "FolderFindFoldersBadRequestIssueTypedDict", + "FolderFindFoldersData", + "FolderFindFoldersDataType", + "FolderFindFoldersDataTypedDict", + "FolderFindFoldersForbiddenError", + "FolderFindFoldersForbiddenErrorData", + "FolderFindFoldersForbiddenIssue", + "FolderFindFoldersForbiddenIssueTypedDict", + "FolderFindFoldersInternalServerError", + "FolderFindFoldersInternalServerErrorData", + "FolderFindFoldersInternalServerErrorIssue", + "FolderFindFoldersInternalServerErrorIssueTypedDict", + "FolderFindFoldersNotFoundError", + "FolderFindFoldersNotFoundErrorData", + "FolderFindFoldersNotFoundIssue", + "FolderFindFoldersNotFoundIssueTypedDict", + "FolderFindFoldersQueryParamType", + "FolderFindFoldersRequest", + "FolderFindFoldersRequestTypedDict", + "FolderFindFoldersResponse", + "FolderFindFoldersResponseTypedDict", + "FolderFindFoldersUnauthorizedError", + "FolderFindFoldersUnauthorizedErrorData", + "FolderFindFoldersUnauthorizedIssue", + "FolderFindFoldersUnauthorizedIssueTypedDict", + "FolderFindFoldersVisibility", + "FolderUpdateFolderBadRequestError", + "FolderUpdateFolderBadRequestErrorData", + "FolderUpdateFolderBadRequestIssue", + "FolderUpdateFolderBadRequestIssueTypedDict", + "FolderUpdateFolderData", + "FolderUpdateFolderDataTypedDict", + "FolderUpdateFolderDataVisibility", + "FolderUpdateFolderForbiddenError", + "FolderUpdateFolderForbiddenErrorData", + "FolderUpdateFolderForbiddenIssue", + "FolderUpdateFolderForbiddenIssueTypedDict", + "FolderUpdateFolderInternalServerError", + "FolderUpdateFolderInternalServerErrorData", + "FolderUpdateFolderInternalServerErrorIssue", + "FolderUpdateFolderInternalServerErrorIssueTypedDict", + "FolderUpdateFolderRequest", + "FolderUpdateFolderRequestTypedDict", + "FolderUpdateFolderResponse", + "FolderUpdateFolderResponseTypedDict", + "FolderUpdateFolderType", + "FolderUpdateFolderUnauthorizedError", + "FolderUpdateFolderUnauthorizedErrorData", + "FolderUpdateFolderUnauthorizedIssue", + "FolderUpdateFolderUnauthorizedIssueTypedDict", + "FolderUpdateFolderVisibilityResponse", "NoResponseError", "OrderByColumn", "OrderByDirection", - "PrefillField", - "PrefillFieldCheckbox", - "PrefillFieldCheckboxTypedDict", - "PrefillFieldDate", - "PrefillFieldDateTypedDict", - "PrefillFieldDropdown", - "PrefillFieldDropdownTypedDict", - "PrefillFieldNumber", - "PrefillFieldNumberTypedDict", - "PrefillFieldRadio", - "PrefillFieldRadioTypedDict", - "PrefillFieldText", - "PrefillFieldTextTypedDict", - "PrefillFieldTypeCheckbox", - "PrefillFieldTypeDate", - "PrefillFieldTypeDropdown", - "PrefillFieldTypeNumber", - "PrefillFieldTypeRadio", - "PrefillFieldTypeText", - "PrefillFieldTypedDict", + "Override", + "OverrideTypedDict", "QueryParamSource", "QueryParamStatus", - "QueryParamType", "RecipientCreateDocumentRecipientAccessAuthRequest", "RecipientCreateDocumentRecipientAccessAuthResponse", "RecipientCreateDocumentRecipientActionAuthRequest", @@ -4291,6 +8543,10 @@ "RecipientCreateDocumentRecipientBadRequestErrorData", "RecipientCreateDocumentRecipientBadRequestIssue", "RecipientCreateDocumentRecipientBadRequestIssueTypedDict", + "RecipientCreateDocumentRecipientForbiddenError", + "RecipientCreateDocumentRecipientForbiddenErrorData", + "RecipientCreateDocumentRecipientForbiddenIssue", + "RecipientCreateDocumentRecipientForbiddenIssueTypedDict", "RecipientCreateDocumentRecipientInternalServerError", "RecipientCreateDocumentRecipientInternalServerErrorData", "RecipientCreateDocumentRecipientInternalServerErrorIssue", @@ -4306,6 +8562,10 @@ "RecipientCreateDocumentRecipientRoleResponse", "RecipientCreateDocumentRecipientSendStatus", "RecipientCreateDocumentRecipientSigningStatus", + "RecipientCreateDocumentRecipientUnauthorizedError", + "RecipientCreateDocumentRecipientUnauthorizedErrorData", + "RecipientCreateDocumentRecipientUnauthorizedIssue", + "RecipientCreateDocumentRecipientUnauthorizedIssueTypedDict", "RecipientCreateDocumentRecipientsAccessAuthRequest", "RecipientCreateDocumentRecipientsAccessAuthResponse", "RecipientCreateDocumentRecipientsActionAuthRequest", @@ -4316,6 +8576,10 @@ "RecipientCreateDocumentRecipientsBadRequestErrorData", "RecipientCreateDocumentRecipientsBadRequestIssue", "RecipientCreateDocumentRecipientsBadRequestIssueTypedDict", + "RecipientCreateDocumentRecipientsForbiddenError", + "RecipientCreateDocumentRecipientsForbiddenErrorData", + "RecipientCreateDocumentRecipientsForbiddenIssue", + "RecipientCreateDocumentRecipientsForbiddenIssueTypedDict", "RecipientCreateDocumentRecipientsInternalServerError", "RecipientCreateDocumentRecipientsInternalServerErrorData", "RecipientCreateDocumentRecipientsInternalServerErrorIssue", @@ -4333,6 +8597,10 @@ "RecipientCreateDocumentRecipientsRoleResponse", "RecipientCreateDocumentRecipientsSendStatus", "RecipientCreateDocumentRecipientsSigningStatus", + "RecipientCreateDocumentRecipientsUnauthorizedError", + "RecipientCreateDocumentRecipientsUnauthorizedErrorData", + "RecipientCreateDocumentRecipientsUnauthorizedIssue", + "RecipientCreateDocumentRecipientsUnauthorizedIssueTypedDict", "RecipientCreateTemplateRecipientAccessAuthRequest", "RecipientCreateTemplateRecipientAccessAuthResponse", "RecipientCreateTemplateRecipientActionAuthRequest", @@ -4343,6 +8611,10 @@ "RecipientCreateTemplateRecipientBadRequestErrorData", "RecipientCreateTemplateRecipientBadRequestIssue", "RecipientCreateTemplateRecipientBadRequestIssueTypedDict", + "RecipientCreateTemplateRecipientForbiddenError", + "RecipientCreateTemplateRecipientForbiddenErrorData", + "RecipientCreateTemplateRecipientForbiddenIssue", + "RecipientCreateTemplateRecipientForbiddenIssueTypedDict", "RecipientCreateTemplateRecipientInternalServerError", "RecipientCreateTemplateRecipientInternalServerErrorData", "RecipientCreateTemplateRecipientInternalServerErrorIssue", @@ -4358,6 +8630,10 @@ "RecipientCreateTemplateRecipientRoleResponse", "RecipientCreateTemplateRecipientSendStatus", "RecipientCreateTemplateRecipientSigningStatus", + "RecipientCreateTemplateRecipientUnauthorizedError", + "RecipientCreateTemplateRecipientUnauthorizedErrorData", + "RecipientCreateTemplateRecipientUnauthorizedIssue", + "RecipientCreateTemplateRecipientUnauthorizedIssueTypedDict", "RecipientCreateTemplateRecipientsAccessAuthRequest", "RecipientCreateTemplateRecipientsAccessAuthResponse", "RecipientCreateTemplateRecipientsActionAuthRequest", @@ -4368,6 +8644,10 @@ "RecipientCreateTemplateRecipientsBadRequestErrorData", "RecipientCreateTemplateRecipientsBadRequestIssue", "RecipientCreateTemplateRecipientsBadRequestIssueTypedDict", + "RecipientCreateTemplateRecipientsForbiddenError", + "RecipientCreateTemplateRecipientsForbiddenErrorData", + "RecipientCreateTemplateRecipientsForbiddenIssue", + "RecipientCreateTemplateRecipientsForbiddenIssueTypedDict", "RecipientCreateTemplateRecipientsInternalServerError", "RecipientCreateTemplateRecipientsInternalServerErrorData", "RecipientCreateTemplateRecipientsInternalServerErrorIssue", @@ -4385,10 +8665,18 @@ "RecipientCreateTemplateRecipientsRoleResponse", "RecipientCreateTemplateRecipientsSendStatus", "RecipientCreateTemplateRecipientsSigningStatus", + "RecipientCreateTemplateRecipientsUnauthorizedError", + "RecipientCreateTemplateRecipientsUnauthorizedErrorData", + "RecipientCreateTemplateRecipientsUnauthorizedIssue", + "RecipientCreateTemplateRecipientsUnauthorizedIssueTypedDict", "RecipientDeleteDocumentRecipientBadRequestError", "RecipientDeleteDocumentRecipientBadRequestErrorData", "RecipientDeleteDocumentRecipientBadRequestIssue", "RecipientDeleteDocumentRecipientBadRequestIssueTypedDict", + "RecipientDeleteDocumentRecipientForbiddenError", + "RecipientDeleteDocumentRecipientForbiddenErrorData", + "RecipientDeleteDocumentRecipientForbiddenIssue", + "RecipientDeleteDocumentRecipientForbiddenIssueTypedDict", "RecipientDeleteDocumentRecipientInternalServerError", "RecipientDeleteDocumentRecipientInternalServerErrorData", "RecipientDeleteDocumentRecipientInternalServerErrorIssue", @@ -4397,10 +8685,18 @@ "RecipientDeleteDocumentRecipientRequestTypedDict", "RecipientDeleteDocumentRecipientResponse", "RecipientDeleteDocumentRecipientResponseTypedDict", + "RecipientDeleteDocumentRecipientUnauthorizedError", + "RecipientDeleteDocumentRecipientUnauthorizedErrorData", + "RecipientDeleteDocumentRecipientUnauthorizedIssue", + "RecipientDeleteDocumentRecipientUnauthorizedIssueTypedDict", "RecipientDeleteTemplateRecipientBadRequestError", "RecipientDeleteTemplateRecipientBadRequestErrorData", "RecipientDeleteTemplateRecipientBadRequestIssue", "RecipientDeleteTemplateRecipientBadRequestIssueTypedDict", + "RecipientDeleteTemplateRecipientForbiddenError", + "RecipientDeleteTemplateRecipientForbiddenErrorData", + "RecipientDeleteTemplateRecipientForbiddenIssue", + "RecipientDeleteTemplateRecipientForbiddenIssueTypedDict", "RecipientDeleteTemplateRecipientInternalServerError", "RecipientDeleteTemplateRecipientInternalServerErrorData", "RecipientDeleteTemplateRecipientInternalServerErrorIssue", @@ -4409,6 +8705,10 @@ "RecipientDeleteTemplateRecipientRequestTypedDict", "RecipientDeleteTemplateRecipientResponse", "RecipientDeleteTemplateRecipientResponseTypedDict", + "RecipientDeleteTemplateRecipientUnauthorizedError", + "RecipientDeleteTemplateRecipientUnauthorizedErrorData", + "RecipientDeleteTemplateRecipientUnauthorizedIssue", + "RecipientDeleteTemplateRecipientUnauthorizedIssueTypedDict", "RecipientGetDocumentRecipientAccessAuth", "RecipientGetDocumentRecipientActionAuth", "RecipientGetDocumentRecipientAuthOptions", @@ -4417,6 +8717,8 @@ "RecipientGetDocumentRecipientBadRequestErrorData", "RecipientGetDocumentRecipientBadRequestIssue", "RecipientGetDocumentRecipientBadRequestIssueTypedDict", + "RecipientGetDocumentRecipientDirection1", + "RecipientGetDocumentRecipientDirection2", "RecipientGetDocumentRecipientField", "RecipientGetDocumentRecipientFieldMetaCheckbox", "RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict", @@ -4434,11 +8736,17 @@ "RecipientGetDocumentRecipientFieldMetaNumberTypedDict", "RecipientGetDocumentRecipientFieldMetaRadio", "RecipientGetDocumentRecipientFieldMetaRadioTypedDict", + "RecipientGetDocumentRecipientFieldMetaSignature", + "RecipientGetDocumentRecipientFieldMetaSignatureTypedDict", "RecipientGetDocumentRecipientFieldMetaText", "RecipientGetDocumentRecipientFieldMetaTextTypedDict", "RecipientGetDocumentRecipientFieldMetaUnion", "RecipientGetDocumentRecipientFieldMetaUnionTypedDict", "RecipientGetDocumentRecipientFieldTypedDict", + "RecipientGetDocumentRecipientForbiddenError", + "RecipientGetDocumentRecipientForbiddenErrorData", + "RecipientGetDocumentRecipientForbiddenIssue", + "RecipientGetDocumentRecipientForbiddenIssueTypedDict", "RecipientGetDocumentRecipientInternalServerError", "RecipientGetDocumentRecipientInternalServerErrorData", "RecipientGetDocumentRecipientInternalServerErrorIssue", @@ -4470,13 +8778,20 @@ "RecipientGetDocumentRecipientTypeName", "RecipientGetDocumentRecipientTypeNumber", "RecipientGetDocumentRecipientTypeRadio", + "RecipientGetDocumentRecipientTypeSignature", "RecipientGetDocumentRecipientTypeText", + "RecipientGetDocumentRecipientUnauthorizedError", + "RecipientGetDocumentRecipientUnauthorizedErrorData", + "RecipientGetDocumentRecipientUnauthorizedIssue", + "RecipientGetDocumentRecipientUnauthorizedIssueTypedDict", "RecipientGetDocumentRecipientValue1", "RecipientGetDocumentRecipientValue1TypedDict", "RecipientGetDocumentRecipientValue2", "RecipientGetDocumentRecipientValue2TypedDict", "RecipientGetDocumentRecipientValue3", "RecipientGetDocumentRecipientValue3TypedDict", + "RecipientGetDocumentRecipientVerticalAlign1", + "RecipientGetDocumentRecipientVerticalAlign2", "RecipientGetTemplateRecipientAccessAuth", "RecipientGetTemplateRecipientActionAuth", "RecipientGetTemplateRecipientAuthOptions", @@ -4485,6 +8800,8 @@ "RecipientGetTemplateRecipientBadRequestErrorData", "RecipientGetTemplateRecipientBadRequestIssue", "RecipientGetTemplateRecipientBadRequestIssueTypedDict", + "RecipientGetTemplateRecipientDirection1", + "RecipientGetTemplateRecipientDirection2", "RecipientGetTemplateRecipientField", "RecipientGetTemplateRecipientFieldMetaCheckbox", "RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict", @@ -4502,11 +8819,17 @@ "RecipientGetTemplateRecipientFieldMetaNumberTypedDict", "RecipientGetTemplateRecipientFieldMetaRadio", "RecipientGetTemplateRecipientFieldMetaRadioTypedDict", + "RecipientGetTemplateRecipientFieldMetaSignature", + "RecipientGetTemplateRecipientFieldMetaSignatureTypedDict", "RecipientGetTemplateRecipientFieldMetaText", "RecipientGetTemplateRecipientFieldMetaTextTypedDict", "RecipientGetTemplateRecipientFieldMetaUnion", "RecipientGetTemplateRecipientFieldMetaUnionTypedDict", "RecipientGetTemplateRecipientFieldTypedDict", + "RecipientGetTemplateRecipientForbiddenError", + "RecipientGetTemplateRecipientForbiddenErrorData", + "RecipientGetTemplateRecipientForbiddenIssue", + "RecipientGetTemplateRecipientForbiddenIssueTypedDict", "RecipientGetTemplateRecipientInternalServerError", "RecipientGetTemplateRecipientInternalServerErrorData", "RecipientGetTemplateRecipientInternalServerErrorIssue", @@ -4538,13 +8861,20 @@ "RecipientGetTemplateRecipientTypeName", "RecipientGetTemplateRecipientTypeNumber", "RecipientGetTemplateRecipientTypeRadio", + "RecipientGetTemplateRecipientTypeSignature", "RecipientGetTemplateRecipientTypeText", + "RecipientGetTemplateRecipientUnauthorizedError", + "RecipientGetTemplateRecipientUnauthorizedErrorData", + "RecipientGetTemplateRecipientUnauthorizedIssue", + "RecipientGetTemplateRecipientUnauthorizedIssueTypedDict", "RecipientGetTemplateRecipientValue1", "RecipientGetTemplateRecipientValue1TypedDict", "RecipientGetTemplateRecipientValue2", "RecipientGetTemplateRecipientValue2TypedDict", "RecipientGetTemplateRecipientValue3", "RecipientGetTemplateRecipientValue3TypedDict", + "RecipientGetTemplateRecipientVerticalAlign1", + "RecipientGetTemplateRecipientVerticalAlign2", "RecipientUpdateDocumentRecipientAccessAuthRequest", "RecipientUpdateDocumentRecipientAccessAuthResponse", "RecipientUpdateDocumentRecipientActionAuthRequest", @@ -4555,6 +8885,8 @@ "RecipientUpdateDocumentRecipientBadRequestErrorData", "RecipientUpdateDocumentRecipientBadRequestIssue", "RecipientUpdateDocumentRecipientBadRequestIssueTypedDict", + "RecipientUpdateDocumentRecipientDirection1", + "RecipientUpdateDocumentRecipientDirection2", "RecipientUpdateDocumentRecipientField", "RecipientUpdateDocumentRecipientFieldMetaCheckbox", "RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict", @@ -4572,11 +8904,17 @@ "RecipientUpdateDocumentRecipientFieldMetaNumberTypedDict", "RecipientUpdateDocumentRecipientFieldMetaRadio", "RecipientUpdateDocumentRecipientFieldMetaRadioTypedDict", + "RecipientUpdateDocumentRecipientFieldMetaSignature", + "RecipientUpdateDocumentRecipientFieldMetaSignatureTypedDict", "RecipientUpdateDocumentRecipientFieldMetaText", "RecipientUpdateDocumentRecipientFieldMetaTextTypedDict", "RecipientUpdateDocumentRecipientFieldMetaUnion", "RecipientUpdateDocumentRecipientFieldMetaUnionTypedDict", "RecipientUpdateDocumentRecipientFieldTypedDict", + "RecipientUpdateDocumentRecipientForbiddenError", + "RecipientUpdateDocumentRecipientForbiddenErrorData", + "RecipientUpdateDocumentRecipientForbiddenIssue", + "RecipientUpdateDocumentRecipientForbiddenIssueTypedDict", "RecipientUpdateDocumentRecipientInternalServerError", "RecipientUpdateDocumentRecipientInternalServerErrorData", "RecipientUpdateDocumentRecipientInternalServerErrorIssue", @@ -4607,13 +8945,20 @@ "RecipientUpdateDocumentRecipientTypeName", "RecipientUpdateDocumentRecipientTypeNumber", "RecipientUpdateDocumentRecipientTypeRadio", + "RecipientUpdateDocumentRecipientTypeSignature", "RecipientUpdateDocumentRecipientTypeText", + "RecipientUpdateDocumentRecipientUnauthorizedError", + "RecipientUpdateDocumentRecipientUnauthorizedErrorData", + "RecipientUpdateDocumentRecipientUnauthorizedIssue", + "RecipientUpdateDocumentRecipientUnauthorizedIssueTypedDict", "RecipientUpdateDocumentRecipientValue1", "RecipientUpdateDocumentRecipientValue1TypedDict", "RecipientUpdateDocumentRecipientValue2", "RecipientUpdateDocumentRecipientValue2TypedDict", "RecipientUpdateDocumentRecipientValue3", "RecipientUpdateDocumentRecipientValue3TypedDict", + "RecipientUpdateDocumentRecipientVerticalAlign1", + "RecipientUpdateDocumentRecipientVerticalAlign2", "RecipientUpdateDocumentRecipientsAccessAuthRequest", "RecipientUpdateDocumentRecipientsAccessAuthResponse", "RecipientUpdateDocumentRecipientsActionAuthRequest", @@ -4624,6 +8969,8 @@ "RecipientUpdateDocumentRecipientsBadRequestErrorData", "RecipientUpdateDocumentRecipientsBadRequestIssue", "RecipientUpdateDocumentRecipientsBadRequestIssueTypedDict", + "RecipientUpdateDocumentRecipientsDirection1", + "RecipientUpdateDocumentRecipientsDirection2", "RecipientUpdateDocumentRecipientsField", "RecipientUpdateDocumentRecipientsFieldMetaCheckbox", "RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict", @@ -4641,11 +8988,17 @@ "RecipientUpdateDocumentRecipientsFieldMetaNumberTypedDict", "RecipientUpdateDocumentRecipientsFieldMetaRadio", "RecipientUpdateDocumentRecipientsFieldMetaRadioTypedDict", + "RecipientUpdateDocumentRecipientsFieldMetaSignature", + "RecipientUpdateDocumentRecipientsFieldMetaSignatureTypedDict", "RecipientUpdateDocumentRecipientsFieldMetaText", "RecipientUpdateDocumentRecipientsFieldMetaTextTypedDict", "RecipientUpdateDocumentRecipientsFieldMetaUnion", "RecipientUpdateDocumentRecipientsFieldMetaUnionTypedDict", "RecipientUpdateDocumentRecipientsFieldTypedDict", + "RecipientUpdateDocumentRecipientsForbiddenError", + "RecipientUpdateDocumentRecipientsForbiddenErrorData", + "RecipientUpdateDocumentRecipientsForbiddenIssue", + "RecipientUpdateDocumentRecipientsForbiddenIssueTypedDict", "RecipientUpdateDocumentRecipientsInternalServerError", "RecipientUpdateDocumentRecipientsInternalServerErrorData", "RecipientUpdateDocumentRecipientsInternalServerErrorIssue", @@ -4678,13 +9031,20 @@ "RecipientUpdateDocumentRecipientsTypeName", "RecipientUpdateDocumentRecipientsTypeNumber", "RecipientUpdateDocumentRecipientsTypeRadio", + "RecipientUpdateDocumentRecipientsTypeSignature", "RecipientUpdateDocumentRecipientsTypeText", + "RecipientUpdateDocumentRecipientsUnauthorizedError", + "RecipientUpdateDocumentRecipientsUnauthorizedErrorData", + "RecipientUpdateDocumentRecipientsUnauthorizedIssue", + "RecipientUpdateDocumentRecipientsUnauthorizedIssueTypedDict", "RecipientUpdateDocumentRecipientsValue1", "RecipientUpdateDocumentRecipientsValue1TypedDict", "RecipientUpdateDocumentRecipientsValue2", "RecipientUpdateDocumentRecipientsValue2TypedDict", "RecipientUpdateDocumentRecipientsValue3", "RecipientUpdateDocumentRecipientsValue3TypedDict", + "RecipientUpdateDocumentRecipientsVerticalAlign1", + "RecipientUpdateDocumentRecipientsVerticalAlign2", "RecipientUpdateTemplateRecipientAccessAuthRequest", "RecipientUpdateTemplateRecipientAccessAuthResponse", "RecipientUpdateTemplateRecipientActionAuthRequest", @@ -4695,6 +9055,8 @@ "RecipientUpdateTemplateRecipientBadRequestErrorData", "RecipientUpdateTemplateRecipientBadRequestIssue", "RecipientUpdateTemplateRecipientBadRequestIssueTypedDict", + "RecipientUpdateTemplateRecipientDirection1", + "RecipientUpdateTemplateRecipientDirection2", "RecipientUpdateTemplateRecipientField", "RecipientUpdateTemplateRecipientFieldMetaCheckbox", "RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict", @@ -4712,11 +9074,17 @@ "RecipientUpdateTemplateRecipientFieldMetaNumberTypedDict", "RecipientUpdateTemplateRecipientFieldMetaRadio", "RecipientUpdateTemplateRecipientFieldMetaRadioTypedDict", + "RecipientUpdateTemplateRecipientFieldMetaSignature", + "RecipientUpdateTemplateRecipientFieldMetaSignatureTypedDict", "RecipientUpdateTemplateRecipientFieldMetaText", "RecipientUpdateTemplateRecipientFieldMetaTextTypedDict", "RecipientUpdateTemplateRecipientFieldMetaUnion", "RecipientUpdateTemplateRecipientFieldMetaUnionTypedDict", "RecipientUpdateTemplateRecipientFieldTypedDict", + "RecipientUpdateTemplateRecipientForbiddenError", + "RecipientUpdateTemplateRecipientForbiddenErrorData", + "RecipientUpdateTemplateRecipientForbiddenIssue", + "RecipientUpdateTemplateRecipientForbiddenIssueTypedDict", "RecipientUpdateTemplateRecipientInternalServerError", "RecipientUpdateTemplateRecipientInternalServerErrorData", "RecipientUpdateTemplateRecipientInternalServerErrorIssue", @@ -4747,13 +9115,20 @@ "RecipientUpdateTemplateRecipientTypeName", "RecipientUpdateTemplateRecipientTypeNumber", "RecipientUpdateTemplateRecipientTypeRadio", + "RecipientUpdateTemplateRecipientTypeSignature", "RecipientUpdateTemplateRecipientTypeText", + "RecipientUpdateTemplateRecipientUnauthorizedError", + "RecipientUpdateTemplateRecipientUnauthorizedErrorData", + "RecipientUpdateTemplateRecipientUnauthorizedIssue", + "RecipientUpdateTemplateRecipientUnauthorizedIssueTypedDict", "RecipientUpdateTemplateRecipientValue1", "RecipientUpdateTemplateRecipientValue1TypedDict", "RecipientUpdateTemplateRecipientValue2", "RecipientUpdateTemplateRecipientValue2TypedDict", "RecipientUpdateTemplateRecipientValue3", "RecipientUpdateTemplateRecipientValue3TypedDict", + "RecipientUpdateTemplateRecipientVerticalAlign1", + "RecipientUpdateTemplateRecipientVerticalAlign2", "RecipientUpdateTemplateRecipientsAccessAuthRequest", "RecipientUpdateTemplateRecipientsAccessAuthResponse", "RecipientUpdateTemplateRecipientsActionAuthRequest", @@ -4764,6 +9139,8 @@ "RecipientUpdateTemplateRecipientsBadRequestErrorData", "RecipientUpdateTemplateRecipientsBadRequestIssue", "RecipientUpdateTemplateRecipientsBadRequestIssueTypedDict", + "RecipientUpdateTemplateRecipientsDirection1", + "RecipientUpdateTemplateRecipientsDirection2", "RecipientUpdateTemplateRecipientsField", "RecipientUpdateTemplateRecipientsFieldMetaCheckbox", "RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict", @@ -4781,11 +9158,17 @@ "RecipientUpdateTemplateRecipientsFieldMetaNumberTypedDict", "RecipientUpdateTemplateRecipientsFieldMetaRadio", "RecipientUpdateTemplateRecipientsFieldMetaRadioTypedDict", + "RecipientUpdateTemplateRecipientsFieldMetaSignature", + "RecipientUpdateTemplateRecipientsFieldMetaSignatureTypedDict", "RecipientUpdateTemplateRecipientsFieldMetaText", "RecipientUpdateTemplateRecipientsFieldMetaTextTypedDict", "RecipientUpdateTemplateRecipientsFieldMetaUnion", "RecipientUpdateTemplateRecipientsFieldMetaUnionTypedDict", "RecipientUpdateTemplateRecipientsFieldTypedDict", + "RecipientUpdateTemplateRecipientsForbiddenError", + "RecipientUpdateTemplateRecipientsForbiddenErrorData", + "RecipientUpdateTemplateRecipientsForbiddenIssue", + "RecipientUpdateTemplateRecipientsForbiddenIssueTypedDict", "RecipientUpdateTemplateRecipientsInternalServerError", "RecipientUpdateTemplateRecipientsInternalServerErrorData", "RecipientUpdateTemplateRecipientsInternalServerErrorIssue", @@ -4818,13 +9201,20 @@ "RecipientUpdateTemplateRecipientsTypeName", "RecipientUpdateTemplateRecipientsTypeNumber", "RecipientUpdateTemplateRecipientsTypeRadio", + "RecipientUpdateTemplateRecipientsTypeSignature", "RecipientUpdateTemplateRecipientsTypeText", + "RecipientUpdateTemplateRecipientsUnauthorizedError", + "RecipientUpdateTemplateRecipientsUnauthorizedErrorData", + "RecipientUpdateTemplateRecipientsUnauthorizedIssue", + "RecipientUpdateTemplateRecipientsUnauthorizedIssueTypedDict", "RecipientUpdateTemplateRecipientsValue1", "RecipientUpdateTemplateRecipientsValue1TypedDict", "RecipientUpdateTemplateRecipientsValue2", "RecipientUpdateTemplateRecipientsValue2TypedDict", "RecipientUpdateTemplateRecipientsValue3", "RecipientUpdateTemplateRecipientsValue3TypedDict", + "RecipientUpdateTemplateRecipientsVerticalAlign1", + "RecipientUpdateTemplateRecipientsVerticalAlign2", "ResponseValidationError", "Security", "SecurityTypedDict", @@ -4836,6 +9226,10 @@ "TemplateCreateDocumentFromTemplateBadRequestErrorData", "TemplateCreateDocumentFromTemplateBadRequestIssue", "TemplateCreateDocumentFromTemplateBadRequestIssueTypedDict", + "TemplateCreateDocumentFromTemplateCustomDocumentDatum", + "TemplateCreateDocumentFromTemplateCustomDocumentDatumTypedDict", + "TemplateCreateDocumentFromTemplateDirection1", + "TemplateCreateDocumentFromTemplateDirection2", "TemplateCreateDocumentFromTemplateDistributionMethod", "TemplateCreateDocumentFromTemplateDocumentData", "TemplateCreateDocumentFromTemplateDocumentDataType", @@ -4844,6 +9238,8 @@ "TemplateCreateDocumentFromTemplateDocumentMetaTypedDict", "TemplateCreateDocumentFromTemplateEmailSettings", "TemplateCreateDocumentFromTemplateEmailSettingsTypedDict", + "TemplateCreateDocumentFromTemplateEnvelopeItem", + "TemplateCreateDocumentFromTemplateEnvelopeItemTypedDict", "TemplateCreateDocumentFromTemplateField", "TemplateCreateDocumentFromTemplateFieldMetaCheckbox", "TemplateCreateDocumentFromTemplateFieldMetaCheckboxTypedDict", @@ -4861,6 +9257,8 @@ "TemplateCreateDocumentFromTemplateFieldMetaNumberTypedDict", "TemplateCreateDocumentFromTemplateFieldMetaRadio", "TemplateCreateDocumentFromTemplateFieldMetaRadioTypedDict", + "TemplateCreateDocumentFromTemplateFieldMetaSignature", + "TemplateCreateDocumentFromTemplateFieldMetaSignatureTypedDict", "TemplateCreateDocumentFromTemplateFieldMetaText", "TemplateCreateDocumentFromTemplateFieldMetaTextTypedDict", "TemplateCreateDocumentFromTemplateFieldMetaTypeCheckbox", @@ -4877,6 +9275,10 @@ "TemplateCreateDocumentFromTemplateFolderType", "TemplateCreateDocumentFromTemplateFolderTypedDict", "TemplateCreateDocumentFromTemplateFolderVisibility", + "TemplateCreateDocumentFromTemplateForbiddenError", + "TemplateCreateDocumentFromTemplateForbiddenErrorData", + "TemplateCreateDocumentFromTemplateForbiddenIssue", + "TemplateCreateDocumentFromTemplateForbiddenIssueTypedDict", "TemplateCreateDocumentFromTemplateFormValues", "TemplateCreateDocumentFromTemplateFormValuesTypedDict", "TemplateCreateDocumentFromTemplateGlobalAccessAuth", @@ -4885,6 +9287,26 @@ "TemplateCreateDocumentFromTemplateInternalServerErrorData", "TemplateCreateDocumentFromTemplateInternalServerErrorIssue", "TemplateCreateDocumentFromTemplateInternalServerErrorIssueTypedDict", + "TemplateCreateDocumentFromTemplatePrefillFieldCheckbox", + "TemplateCreateDocumentFromTemplatePrefillFieldCheckboxTypedDict", + "TemplateCreateDocumentFromTemplatePrefillFieldDate", + "TemplateCreateDocumentFromTemplatePrefillFieldDateTypedDict", + "TemplateCreateDocumentFromTemplatePrefillFieldDropdown", + "TemplateCreateDocumentFromTemplatePrefillFieldDropdownTypedDict", + "TemplateCreateDocumentFromTemplatePrefillFieldNumber", + "TemplateCreateDocumentFromTemplatePrefillFieldNumberTypedDict", + "TemplateCreateDocumentFromTemplatePrefillFieldRadio", + "TemplateCreateDocumentFromTemplatePrefillFieldRadioTypedDict", + "TemplateCreateDocumentFromTemplatePrefillFieldText", + "TemplateCreateDocumentFromTemplatePrefillFieldTextTypedDict", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeCheckbox", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeDate", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeDropdown", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeNumber", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeRadio", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeText", + "TemplateCreateDocumentFromTemplatePrefillFieldUnion", + "TemplateCreateDocumentFromTemplatePrefillFieldUnionTypedDict", "TemplateCreateDocumentFromTemplateReadStatus", "TemplateCreateDocumentFromTemplateRecipientAuthOptions", "TemplateCreateDocumentFromTemplateRecipientAuthOptionsTypedDict", @@ -4911,17 +9333,35 @@ "TemplateCreateDocumentFromTemplateTypeEmail", "TemplateCreateDocumentFromTemplateTypeInitials", "TemplateCreateDocumentFromTemplateTypeName", + "TemplateCreateDocumentFromTemplateTypeSignature", + "TemplateCreateDocumentFromTemplateUnauthorizedError", + "TemplateCreateDocumentFromTemplateUnauthorizedErrorData", + "TemplateCreateDocumentFromTemplateUnauthorizedIssue", + "TemplateCreateDocumentFromTemplateUnauthorizedIssueTypedDict", "TemplateCreateDocumentFromTemplateValue1", "TemplateCreateDocumentFromTemplateValue1TypedDict", "TemplateCreateDocumentFromTemplateValue2", "TemplateCreateDocumentFromTemplateValue2TypedDict", "TemplateCreateDocumentFromTemplateValue3", "TemplateCreateDocumentFromTemplateValue3TypedDict", + "TemplateCreateDocumentFromTemplateVerticalAlign1", + "TemplateCreateDocumentFromTemplateVerticalAlign2", "TemplateCreateDocumentFromTemplateVisibility", + "TemplateCreateTemplateAttachment", + "TemplateCreateTemplateAttachmentTypedDict", + "TemplateCreateTemplateBadRequestError", + "TemplateCreateTemplateBadRequestErrorData", + "TemplateCreateTemplateBadRequestIssue", + "TemplateCreateTemplateBadRequestIssueTypedDict", + "TemplateCreateTemplateDateFormat", "TemplateCreateTemplateDirectLinkBadRequestError", "TemplateCreateTemplateDirectLinkBadRequestErrorData", "TemplateCreateTemplateDirectLinkBadRequestIssue", "TemplateCreateTemplateDirectLinkBadRequestIssueTypedDict", + "TemplateCreateTemplateDirectLinkForbiddenError", + "TemplateCreateTemplateDirectLinkForbiddenErrorData", + "TemplateCreateTemplateDirectLinkForbiddenIssue", + "TemplateCreateTemplateDirectLinkForbiddenIssueTypedDict", "TemplateCreateTemplateDirectLinkInternalServerError", "TemplateCreateTemplateDirectLinkInternalServerErrorData", "TemplateCreateTemplateDirectLinkInternalServerErrorIssue", @@ -4930,6 +9370,165 @@ "TemplateCreateTemplateDirectLinkRequestTypedDict", "TemplateCreateTemplateDirectLinkResponse", "TemplateCreateTemplateDirectLinkResponseTypedDict", + "TemplateCreateTemplateDirectLinkUnauthorizedError", + "TemplateCreateTemplateDirectLinkUnauthorizedErrorData", + "TemplateCreateTemplateDirectLinkUnauthorizedIssue", + "TemplateCreateTemplateDirectLinkUnauthorizedIssueTypedDict", + "TemplateCreateTemplateDistributionMethod", + "TemplateCreateTemplateEmailSettings", + "TemplateCreateTemplateEmailSettingsTypedDict", + "TemplateCreateTemplateFile", + "TemplateCreateTemplateFileTypedDict", + "TemplateCreateTemplateForbiddenError", + "TemplateCreateTemplateForbiddenErrorData", + "TemplateCreateTemplateForbiddenIssue", + "TemplateCreateTemplateForbiddenIssueTypedDict", + "TemplateCreateTemplateGlobalAccessAuth", + "TemplateCreateTemplateGlobalActionAuth", + "TemplateCreateTemplateInternalServerError", + "TemplateCreateTemplateInternalServerErrorData", + "TemplateCreateTemplateInternalServerErrorIssue", + "TemplateCreateTemplateInternalServerErrorIssueTypedDict", + "TemplateCreateTemplateLanguage", + "TemplateCreateTemplateMeta", + "TemplateCreateTemplateMetaTypedDict", + "TemplateCreateTemplatePayload", + "TemplateCreateTemplatePayloadTypedDict", + "TemplateCreateTemplateRequest", + "TemplateCreateTemplateRequestTypedDict", + "TemplateCreateTemplateResponse", + "TemplateCreateTemplateResponseTypedDict", + "TemplateCreateTemplateSigningOrder", + "TemplateCreateTemplateTemporaryAccessAuth", + "TemplateCreateTemplateTemporaryActionAuth", + "TemplateCreateTemplateTemporaryAttachment", + "TemplateCreateTemplateTemporaryAttachmentTypedDict", + "TemplateCreateTemplateTemporaryAuthOptions", + "TemplateCreateTemplateTemporaryAuthOptionsTypedDict", + "TemplateCreateTemplateTemporaryBadRequestError", + "TemplateCreateTemplateTemporaryBadRequestErrorData", + "TemplateCreateTemplateTemporaryBadRequestIssue", + "TemplateCreateTemplateTemporaryBadRequestIssueTypedDict", + "TemplateCreateTemplateTemporaryDateFormat", + "TemplateCreateTemplateTemporaryDirectLink", + "TemplateCreateTemplateTemporaryDirectLinkTypedDict", + "TemplateCreateTemplateTemporaryDirection1", + "TemplateCreateTemplateTemporaryDirection2", + "TemplateCreateTemplateTemporaryEnvelopeItem", + "TemplateCreateTemplateTemporaryEnvelopeItemTypedDict", + "TemplateCreateTemplateTemporaryField", + "TemplateCreateTemplateTemporaryFieldMetaCheckbox", + "TemplateCreateTemplateTemporaryFieldMetaCheckboxTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaDate", + "TemplateCreateTemplateTemporaryFieldMetaDateTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaDropdown", + "TemplateCreateTemplateTemporaryFieldMetaDropdownTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaEmail", + "TemplateCreateTemplateTemporaryFieldMetaEmailTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaInitials", + "TemplateCreateTemplateTemporaryFieldMetaInitialsTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaName", + "TemplateCreateTemplateTemporaryFieldMetaNameTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaNumber", + "TemplateCreateTemplateTemporaryFieldMetaNumberTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaRadio", + "TemplateCreateTemplateTemporaryFieldMetaRadioTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaSignature", + "TemplateCreateTemplateTemporaryFieldMetaSignatureTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaText", + "TemplateCreateTemplateTemporaryFieldMetaTextTypedDict", + "TemplateCreateTemplateTemporaryFieldMetaUnion", + "TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict", + "TemplateCreateTemplateTemporaryFieldType", + "TemplateCreateTemplateTemporaryFieldTypedDict", + "TemplateCreateTemplateTemporaryFolder", + "TemplateCreateTemplateTemporaryFolderType", + "TemplateCreateTemplateTemporaryFolderTypedDict", + "TemplateCreateTemplateTemporaryFolderVisibility", + "TemplateCreateTemplateTemporaryForbiddenError", + "TemplateCreateTemplateTemporaryForbiddenErrorData", + "TemplateCreateTemplateTemporaryForbiddenIssue", + "TemplateCreateTemplateTemporaryForbiddenIssueTypedDict", + "TemplateCreateTemplateTemporaryGlobalAccessAuthRequest", + "TemplateCreateTemplateTemporaryGlobalAccessAuthResponse", + "TemplateCreateTemplateTemporaryGlobalActionAuthRequest", + "TemplateCreateTemplateTemporaryGlobalActionAuthResponse", + "TemplateCreateTemplateTemporaryInternalServerError", + "TemplateCreateTemplateTemporaryInternalServerErrorData", + "TemplateCreateTemplateTemporaryInternalServerErrorIssue", + "TemplateCreateTemplateTemporaryInternalServerErrorIssueTypedDict", + "TemplateCreateTemplateTemporaryLanguage", + "TemplateCreateTemplateTemporaryMeta", + "TemplateCreateTemplateTemporaryMetaDistributionMethod", + "TemplateCreateTemplateTemporaryMetaEmailSettings", + "TemplateCreateTemplateTemporaryMetaEmailSettingsTypedDict", + "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", + "TemplateCreateTemplateTemporaryTypeLink", + "TemplateCreateTemplateTemporaryTypeName", + "TemplateCreateTemplateTemporaryTypeNumber", + "TemplateCreateTemplateTemporaryTypeRadio", + "TemplateCreateTemplateTemporaryTypeRequest", + "TemplateCreateTemplateTemporaryTypeResponse", + "TemplateCreateTemplateTemporaryTypeSignature", + "TemplateCreateTemplateTemporaryTypeText", + "TemplateCreateTemplateTemporaryUnauthorizedError", + "TemplateCreateTemplateTemporaryUnauthorizedErrorData", + "TemplateCreateTemplateTemporaryUnauthorizedIssue", + "TemplateCreateTemplateTemporaryUnauthorizedIssueTypedDict", + "TemplateCreateTemplateTemporaryUser", + "TemplateCreateTemplateTemporaryUserTypedDict", + "TemplateCreateTemplateTemporaryValue1", + "TemplateCreateTemplateTemporaryValue1TypedDict", + "TemplateCreateTemplateTemporaryValue2", + "TemplateCreateTemplateTemporaryValue2TypedDict", + "TemplateCreateTemplateTemporaryValue3", + "TemplateCreateTemplateTemporaryValue3TypedDict", + "TemplateCreateTemplateTemporaryVerticalAlign1", + "TemplateCreateTemplateTemporaryVerticalAlign2", + "TemplateCreateTemplateTemporaryVisibilityRequest", + "TemplateCreateTemplateTemporaryVisibilityResponse", + "TemplateCreateTemplateType", + "TemplateCreateTemplateTypeLink", + "TemplateCreateTemplateUnauthorizedError", + "TemplateCreateTemplateUnauthorizedErrorData", + "TemplateCreateTemplateUnauthorizedIssue", + "TemplateCreateTemplateUnauthorizedIssueTypedDict", + "TemplateCreateTemplateVisibility", "TemplateDeleteTemplateBadRequestError", "TemplateDeleteTemplateBadRequestErrorData", "TemplateDeleteTemplateBadRequestIssue", @@ -4938,6 +9537,10 @@ "TemplateDeleteTemplateDirectLinkBadRequestErrorData", "TemplateDeleteTemplateDirectLinkBadRequestIssue", "TemplateDeleteTemplateDirectLinkBadRequestIssueTypedDict", + "TemplateDeleteTemplateDirectLinkForbiddenError", + "TemplateDeleteTemplateDirectLinkForbiddenErrorData", + "TemplateDeleteTemplateDirectLinkForbiddenIssue", + "TemplateDeleteTemplateDirectLinkForbiddenIssueTypedDict", "TemplateDeleteTemplateDirectLinkInternalServerError", "TemplateDeleteTemplateDirectLinkInternalServerErrorData", "TemplateDeleteTemplateDirectLinkInternalServerErrorIssue", @@ -4946,6 +9549,14 @@ "TemplateDeleteTemplateDirectLinkRequestTypedDict", "TemplateDeleteTemplateDirectLinkResponse", "TemplateDeleteTemplateDirectLinkResponseTypedDict", + "TemplateDeleteTemplateDirectLinkUnauthorizedError", + "TemplateDeleteTemplateDirectLinkUnauthorizedErrorData", + "TemplateDeleteTemplateDirectLinkUnauthorizedIssue", + "TemplateDeleteTemplateDirectLinkUnauthorizedIssueTypedDict", + "TemplateDeleteTemplateForbiddenError", + "TemplateDeleteTemplateForbiddenErrorData", + "TemplateDeleteTemplateForbiddenIssue", + "TemplateDeleteTemplateForbiddenIssueTypedDict", "TemplateDeleteTemplateInternalServerError", "TemplateDeleteTemplateInternalServerErrorData", "TemplateDeleteTemplateInternalServerErrorIssue", @@ -4954,15 +9565,20 @@ "TemplateDeleteTemplateRequestTypedDict", "TemplateDeleteTemplateResponse", "TemplateDeleteTemplateResponseTypedDict", - "TemplateDocumentData", - "TemplateDocumentDataType", - "TemplateDocumentDataTypedDict", + "TemplateDeleteTemplateUnauthorizedError", + "TemplateDeleteTemplateUnauthorizedErrorData", + "TemplateDeleteTemplateUnauthorizedIssue", + "TemplateDeleteTemplateUnauthorizedIssueTypedDict", "TemplateDuplicateTemplateAuthOptions", "TemplateDuplicateTemplateAuthOptionsTypedDict", "TemplateDuplicateTemplateBadRequestError", "TemplateDuplicateTemplateBadRequestErrorData", "TemplateDuplicateTemplateBadRequestIssue", "TemplateDuplicateTemplateBadRequestIssueTypedDict", + "TemplateDuplicateTemplateForbiddenError", + "TemplateDuplicateTemplateForbiddenErrorData", + "TemplateDuplicateTemplateForbiddenIssue", + "TemplateDuplicateTemplateForbiddenIssueTypedDict", "TemplateDuplicateTemplateGlobalAccessAuth", "TemplateDuplicateTemplateGlobalActionAuth", "TemplateDuplicateTemplateInternalServerError", @@ -4974,6 +9590,10 @@ "TemplateDuplicateTemplateResponse", "TemplateDuplicateTemplateResponseTypedDict", "TemplateDuplicateTemplateType", + "TemplateDuplicateTemplateUnauthorizedError", + "TemplateDuplicateTemplateUnauthorizedErrorData", + "TemplateDuplicateTemplateUnauthorizedIssue", + "TemplateDuplicateTemplateUnauthorizedIssueTypedDict", "TemplateDuplicateTemplateVisibility", "TemplateFindTemplatesAccessAuth", "TemplateFindTemplatesActionAuth", @@ -4988,6 +9608,8 @@ "TemplateFindTemplatesDataTypedDict", "TemplateFindTemplatesDirectLink", "TemplateFindTemplatesDirectLinkTypedDict", + "TemplateFindTemplatesDirection1", + "TemplateFindTemplatesDirection2", "TemplateFindTemplatesDistributionMethod", "TemplateFindTemplatesField", "TemplateFindTemplatesFieldMetaCheckbox", @@ -5006,12 +9628,18 @@ "TemplateFindTemplatesFieldMetaNumberTypedDict", "TemplateFindTemplatesFieldMetaRadio", "TemplateFindTemplatesFieldMetaRadioTypedDict", + "TemplateFindTemplatesFieldMetaSignature", + "TemplateFindTemplatesFieldMetaSignatureTypedDict", "TemplateFindTemplatesFieldMetaText", "TemplateFindTemplatesFieldMetaTextTypedDict", "TemplateFindTemplatesFieldMetaUnion", "TemplateFindTemplatesFieldMetaUnionTypedDict", "TemplateFindTemplatesFieldType", "TemplateFindTemplatesFieldTypedDict", + "TemplateFindTemplatesForbiddenError", + "TemplateFindTemplatesForbiddenErrorData", + "TemplateFindTemplatesForbiddenIssue", + "TemplateFindTemplatesForbiddenIssueTypedDict", "TemplateFindTemplatesGlobalAccessAuth", "TemplateFindTemplatesGlobalActionAuth", "TemplateFindTemplatesInternalServerError", @@ -5022,6 +9650,7 @@ "TemplateFindTemplatesNotFoundErrorData", "TemplateFindTemplatesNotFoundIssue", "TemplateFindTemplatesNotFoundIssueTypedDict", + "TemplateFindTemplatesQueryParamType", "TemplateFindTemplatesReadStatus", "TemplateFindTemplatesRecipient", "TemplateFindTemplatesRecipientAuthOptions", @@ -5053,13 +9682,20 @@ "TemplateFindTemplatesTypeName", "TemplateFindTemplatesTypeNumber", "TemplateFindTemplatesTypeRadio", + "TemplateFindTemplatesTypeSignature", "TemplateFindTemplatesTypeText", + "TemplateFindTemplatesUnauthorizedError", + "TemplateFindTemplatesUnauthorizedErrorData", + "TemplateFindTemplatesUnauthorizedIssue", + "TemplateFindTemplatesUnauthorizedIssueTypedDict", "TemplateFindTemplatesValue1", "TemplateFindTemplatesValue1TypedDict", "TemplateFindTemplatesValue2", "TemplateFindTemplatesValue2TypedDict", "TemplateFindTemplatesValue3", "TemplateFindTemplatesValue3TypedDict", + "TemplateFindTemplatesVerticalAlign1", + "TemplateFindTemplatesVerticalAlign2", "TemplateFindTemplatesVisibility", "TemplateGetTemplateByIDAccessAuth", "TemplateGetTemplateByIDActionAuth", @@ -5071,9 +9707,13 @@ "TemplateGetTemplateByIDBadRequestIssueTypedDict", "TemplateGetTemplateByIDDirectLink", "TemplateGetTemplateByIDDirectLinkTypedDict", + "TemplateGetTemplateByIDDirection1", + "TemplateGetTemplateByIDDirection2", "TemplateGetTemplateByIDDistributionMethod", "TemplateGetTemplateByIDEmailSettings", "TemplateGetTemplateByIDEmailSettingsTypedDict", + "TemplateGetTemplateByIDEnvelopeItem", + "TemplateGetTemplateByIDEnvelopeItemTypedDict", "TemplateGetTemplateByIDField", "TemplateGetTemplateByIDFieldMetaCheckbox", "TemplateGetTemplateByIDFieldMetaCheckboxTypedDict", @@ -5091,6 +9731,8 @@ "TemplateGetTemplateByIDFieldMetaNumberTypedDict", "TemplateGetTemplateByIDFieldMetaRadio", "TemplateGetTemplateByIDFieldMetaRadioTypedDict", + "TemplateGetTemplateByIDFieldMetaSignature", + "TemplateGetTemplateByIDFieldMetaSignatureTypedDict", "TemplateGetTemplateByIDFieldMetaText", "TemplateGetTemplateByIDFieldMetaTextTypedDict", "TemplateGetTemplateByIDFieldMetaUnion", @@ -5101,6 +9743,10 @@ "TemplateGetTemplateByIDFolderType", "TemplateGetTemplateByIDFolderTypedDict", "TemplateGetTemplateByIDFolderVisibility", + "TemplateGetTemplateByIDForbiddenError", + "TemplateGetTemplateByIDForbiddenErrorData", + "TemplateGetTemplateByIDForbiddenIssue", + "TemplateGetTemplateByIDForbiddenIssueTypedDict", "TemplateGetTemplateByIDGlobalAccessAuth", "TemplateGetTemplateByIDGlobalActionAuth", "TemplateGetTemplateByIDInternalServerError", @@ -5124,6 +9770,9 @@ "TemplateGetTemplateByIDSendStatus", "TemplateGetTemplateByIDSigningOrder", "TemplateGetTemplateByIDSigningStatus", + "TemplateGetTemplateByIDTemplateDocumentData", + "TemplateGetTemplateByIDTemplateDocumentDataType", + "TemplateGetTemplateByIDTemplateDocumentDataTypedDict", "TemplateGetTemplateByIDTemplateMeta", "TemplateGetTemplateByIDTemplateMetaTypedDict", "TemplateGetTemplateByIDTextAlign1", @@ -5141,7 +9790,12 @@ "TemplateGetTemplateByIDTypeName", "TemplateGetTemplateByIDTypeNumber", "TemplateGetTemplateByIDTypeRadio", + "TemplateGetTemplateByIDTypeSignature", "TemplateGetTemplateByIDTypeText", + "TemplateGetTemplateByIDUnauthorizedError", + "TemplateGetTemplateByIDUnauthorizedErrorData", + "TemplateGetTemplateByIDUnauthorizedIssue", + "TemplateGetTemplateByIDUnauthorizedIssueTypedDict", "TemplateGetTemplateByIDUser", "TemplateGetTemplateByIDUserTypedDict", "TemplateGetTemplateByIDValue1", @@ -5150,11 +9804,17 @@ "TemplateGetTemplateByIDValue2TypedDict", "TemplateGetTemplateByIDValue3", "TemplateGetTemplateByIDValue3TypedDict", + "TemplateGetTemplateByIDVerticalAlign1", + "TemplateGetTemplateByIDVerticalAlign2", "TemplateGetTemplateByIDVisibility", "TemplateToggleTemplateDirectLinkBadRequestError", "TemplateToggleTemplateDirectLinkBadRequestErrorData", "TemplateToggleTemplateDirectLinkBadRequestIssue", "TemplateToggleTemplateDirectLinkBadRequestIssueTypedDict", + "TemplateToggleTemplateDirectLinkForbiddenError", + "TemplateToggleTemplateDirectLinkForbiddenErrorData", + "TemplateToggleTemplateDirectLinkForbiddenIssue", + "TemplateToggleTemplateDirectLinkForbiddenIssueTypedDict", "TemplateToggleTemplateDirectLinkInternalServerError", "TemplateToggleTemplateDirectLinkInternalServerErrorData", "TemplateToggleTemplateDirectLinkInternalServerErrorIssue", @@ -5163,6 +9823,10 @@ "TemplateToggleTemplateDirectLinkRequestTypedDict", "TemplateToggleTemplateDirectLinkResponse", "TemplateToggleTemplateDirectLinkResponseTypedDict", + "TemplateToggleTemplateDirectLinkUnauthorizedError", + "TemplateToggleTemplateDirectLinkUnauthorizedErrorData", + "TemplateToggleTemplateDirectLinkUnauthorizedIssue", + "TemplateToggleTemplateDirectLinkUnauthorizedIssueTypedDict", "TemplateUpdateTemplateAuthOptions", "TemplateUpdateTemplateAuthOptionsTypedDict", "TemplateUpdateTemplateBadRequestError", @@ -5170,15 +9834,20 @@ "TemplateUpdateTemplateBadRequestIssue", "TemplateUpdateTemplateBadRequestIssueTypedDict", "TemplateUpdateTemplateData", + "TemplateUpdateTemplateDataGlobalAccessAuth", + "TemplateUpdateTemplateDataGlobalActionAuth", "TemplateUpdateTemplateDataType", "TemplateUpdateTemplateDataTypedDict", + "TemplateUpdateTemplateDataVisibility", "TemplateUpdateTemplateDateFormat", "TemplateUpdateTemplateDistributionMethod", "TemplateUpdateTemplateEmailSettings", "TemplateUpdateTemplateEmailSettingsTypedDict", - "TemplateUpdateTemplateGlobalAccessAuthRequest", + "TemplateUpdateTemplateForbiddenError", + "TemplateUpdateTemplateForbiddenErrorData", + "TemplateUpdateTemplateForbiddenIssue", + "TemplateUpdateTemplateForbiddenIssueTypedDict", "TemplateUpdateTemplateGlobalAccessAuthResponse", - "TemplateUpdateTemplateGlobalActionAuthRequest", "TemplateUpdateTemplateGlobalActionAuthResponse", "TemplateUpdateTemplateInternalServerError", "TemplateUpdateTemplateInternalServerErrorData", @@ -5193,17 +9862,112 @@ "TemplateUpdateTemplateResponseTypedDict", "TemplateUpdateTemplateSigningOrder", "TemplateUpdateTemplateTypeResponse", - "TemplateUpdateTemplateVisibilityRequest", + "TemplateUpdateTemplateUnauthorizedError", + "TemplateUpdateTemplateUnauthorizedErrorData", + "TemplateUpdateTemplateUnauthorizedIssue", + "TemplateUpdateTemplateUnauthorizedIssueTypedDict", "TemplateUpdateTemplateVisibilityResponse", ] _dynamic_imports: dict[str, str] = { "APIError": ".apierror", - "Document": ".document_createdocumenttemporaryop", + "DocumentAttachmentCreateBadRequestError": ".document_attachment_createop", + "DocumentAttachmentCreateBadRequestErrorData": ".document_attachment_createop", + "DocumentAttachmentCreateBadRequestIssue": ".document_attachment_createop", + "DocumentAttachmentCreateBadRequestIssueTypedDict": ".document_attachment_createop", + "DocumentAttachmentCreateData": ".document_attachment_createop", + "DocumentAttachmentCreateDataTypedDict": ".document_attachment_createop", + "DocumentAttachmentCreateForbiddenError": ".document_attachment_createop", + "DocumentAttachmentCreateForbiddenErrorData": ".document_attachment_createop", + "DocumentAttachmentCreateForbiddenIssue": ".document_attachment_createop", + "DocumentAttachmentCreateForbiddenIssueTypedDict": ".document_attachment_createop", + "DocumentAttachmentCreateInternalServerError": ".document_attachment_createop", + "DocumentAttachmentCreateInternalServerErrorData": ".document_attachment_createop", + "DocumentAttachmentCreateInternalServerErrorIssue": ".document_attachment_createop", + "DocumentAttachmentCreateInternalServerErrorIssueTypedDict": ".document_attachment_createop", + "DocumentAttachmentCreateRequest": ".document_attachment_createop", + "DocumentAttachmentCreateRequestTypedDict": ".document_attachment_createop", + "DocumentAttachmentCreateResponse": ".document_attachment_createop", + "DocumentAttachmentCreateResponseTypedDict": ".document_attachment_createop", + "DocumentAttachmentCreateUnauthorizedError": ".document_attachment_createop", + "DocumentAttachmentCreateUnauthorizedErrorData": ".document_attachment_createop", + "DocumentAttachmentCreateUnauthorizedIssue": ".document_attachment_createop", + "DocumentAttachmentCreateUnauthorizedIssueTypedDict": ".document_attachment_createop", + "DocumentAttachmentDeleteBadRequestError": ".document_attachment_deleteop", + "DocumentAttachmentDeleteBadRequestErrorData": ".document_attachment_deleteop", + "DocumentAttachmentDeleteBadRequestIssue": ".document_attachment_deleteop", + "DocumentAttachmentDeleteBadRequestIssueTypedDict": ".document_attachment_deleteop", + "DocumentAttachmentDeleteForbiddenError": ".document_attachment_deleteop", + "DocumentAttachmentDeleteForbiddenErrorData": ".document_attachment_deleteop", + "DocumentAttachmentDeleteForbiddenIssue": ".document_attachment_deleteop", + "DocumentAttachmentDeleteForbiddenIssueTypedDict": ".document_attachment_deleteop", + "DocumentAttachmentDeleteInternalServerError": ".document_attachment_deleteop", + "DocumentAttachmentDeleteInternalServerErrorData": ".document_attachment_deleteop", + "DocumentAttachmentDeleteInternalServerErrorIssue": ".document_attachment_deleteop", + "DocumentAttachmentDeleteInternalServerErrorIssueTypedDict": ".document_attachment_deleteop", + "DocumentAttachmentDeleteRequest": ".document_attachment_deleteop", + "DocumentAttachmentDeleteRequestTypedDict": ".document_attachment_deleteop", + "DocumentAttachmentDeleteResponse": ".document_attachment_deleteop", + "DocumentAttachmentDeleteResponseTypedDict": ".document_attachment_deleteop", + "DocumentAttachmentDeleteUnauthorizedError": ".document_attachment_deleteop", + "DocumentAttachmentDeleteUnauthorizedErrorData": ".document_attachment_deleteop", + "DocumentAttachmentDeleteUnauthorizedIssue": ".document_attachment_deleteop", + "DocumentAttachmentDeleteUnauthorizedIssueTypedDict": ".document_attachment_deleteop", + "DocumentAttachmentFindBadRequestError": ".document_attachment_findop", + "DocumentAttachmentFindBadRequestErrorData": ".document_attachment_findop", + "DocumentAttachmentFindBadRequestIssue": ".document_attachment_findop", + "DocumentAttachmentFindBadRequestIssueTypedDict": ".document_attachment_findop", + "DocumentAttachmentFindData": ".document_attachment_findop", + "DocumentAttachmentFindDataTypedDict": ".document_attachment_findop", + "DocumentAttachmentFindForbiddenError": ".document_attachment_findop", + "DocumentAttachmentFindForbiddenErrorData": ".document_attachment_findop", + "DocumentAttachmentFindForbiddenIssue": ".document_attachment_findop", + "DocumentAttachmentFindForbiddenIssueTypedDict": ".document_attachment_findop", + "DocumentAttachmentFindInternalServerError": ".document_attachment_findop", + "DocumentAttachmentFindInternalServerErrorData": ".document_attachment_findop", + "DocumentAttachmentFindInternalServerErrorIssue": ".document_attachment_findop", + "DocumentAttachmentFindInternalServerErrorIssueTypedDict": ".document_attachment_findop", + "DocumentAttachmentFindNotFoundError": ".document_attachment_findop", + "DocumentAttachmentFindNotFoundErrorData": ".document_attachment_findop", + "DocumentAttachmentFindNotFoundIssue": ".document_attachment_findop", + "DocumentAttachmentFindNotFoundIssueTypedDict": ".document_attachment_findop", + "DocumentAttachmentFindRequest": ".document_attachment_findop", + "DocumentAttachmentFindRequestTypedDict": ".document_attachment_findop", + "DocumentAttachmentFindResponse": ".document_attachment_findop", + "DocumentAttachmentFindResponseTypedDict": ".document_attachment_findop", + "DocumentAttachmentFindType": ".document_attachment_findop", + "DocumentAttachmentFindUnauthorizedError": ".document_attachment_findop", + "DocumentAttachmentFindUnauthorizedErrorData": ".document_attachment_findop", + "DocumentAttachmentFindUnauthorizedIssue": ".document_attachment_findop", + "DocumentAttachmentFindUnauthorizedIssueTypedDict": ".document_attachment_findop", + "DocumentAttachmentUpdateBadRequestError": ".document_attachment_updateop", + "DocumentAttachmentUpdateBadRequestErrorData": ".document_attachment_updateop", + "DocumentAttachmentUpdateBadRequestIssue": ".document_attachment_updateop", + "DocumentAttachmentUpdateBadRequestIssueTypedDict": ".document_attachment_updateop", + "DocumentAttachmentUpdateData": ".document_attachment_updateop", + "DocumentAttachmentUpdateDataTypedDict": ".document_attachment_updateop", + "DocumentAttachmentUpdateForbiddenError": ".document_attachment_updateop", + "DocumentAttachmentUpdateForbiddenErrorData": ".document_attachment_updateop", + "DocumentAttachmentUpdateForbiddenIssue": ".document_attachment_updateop", + "DocumentAttachmentUpdateForbiddenIssueTypedDict": ".document_attachment_updateop", + "DocumentAttachmentUpdateInternalServerError": ".document_attachment_updateop", + "DocumentAttachmentUpdateInternalServerErrorData": ".document_attachment_updateop", + "DocumentAttachmentUpdateInternalServerErrorIssue": ".document_attachment_updateop", + "DocumentAttachmentUpdateInternalServerErrorIssueTypedDict": ".document_attachment_updateop", + "DocumentAttachmentUpdateRequest": ".document_attachment_updateop", + "DocumentAttachmentUpdateRequestTypedDict": ".document_attachment_updateop", + "DocumentAttachmentUpdateResponse": ".document_attachment_updateop", + "DocumentAttachmentUpdateResponseTypedDict": ".document_attachment_updateop", + "DocumentAttachmentUpdateUnauthorizedError": ".document_attachment_updateop", + "DocumentAttachmentUpdateUnauthorizedErrorData": ".document_attachment_updateop", + "DocumentAttachmentUpdateUnauthorizedIssue": ".document_attachment_updateop", + "DocumentAttachmentUpdateUnauthorizedIssueTypedDict": ".document_attachment_updateop", "DocumentAccessAuth": ".document_createdocumenttemporaryop", "DocumentActionAuth": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryAccessAuthRequest": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryActionAuthRequest": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryAttachment": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryAttachmentTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryAuthOptions": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryAuthOptionsTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryBadRequestError": ".document_createdocumenttemporaryop", @@ -5211,13 +9975,16 @@ "DocumentCreateDocumentTemporaryBadRequestIssue": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryBadRequestIssueTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDateFormat": ".document_createdocumenttemporaryop", - "DocumentCreateDocumentTemporaryDistributionMethodRequest": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryDirectionCheckbox": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryDirectionRadio": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryDocument": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDocumentData": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDocumentDataTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDocumentMeta": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryDocumentMetaTypedDict": ".document_createdocumenttemporaryop", - "DocumentCreateDocumentTemporaryEmailSettingsRequest": ".document_createdocumenttemporaryop", - "DocumentCreateDocumentTemporaryEmailSettingsRequestTypedDict": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryDocumentTypedDict": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryEnvelopeItem": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryEnvelopeItemTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryFieldCheckbox": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryFieldCheckboxTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryFieldDate": ".document_createdocumenttemporaryop", @@ -5244,6 +10011,12 @@ "DocumentCreateDocumentTemporaryFieldUnionTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryFolder": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryFolderTypedDict": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryForbiddenError": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryForbiddenErrorData": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryForbiddenIssue": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryForbiddenIssueTypedDict": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryFormValuesRequest": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryFormValuesRequestTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryGlobalAccessAuthRequest": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryGlobalActionAuthRequest": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryInternalServerError": ".document_createdocumenttemporaryop", @@ -5252,6 +10025,9 @@ "DocumentCreateDocumentTemporaryInternalServerErrorIssueTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryLanguage": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryMeta": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryMetaDistributionMethod": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryMetaEmailSettings": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryMetaEmailSettingsTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryMetaTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryReadStatus": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientAuthOptions": ".document_createdocumenttemporaryop", @@ -5272,6 +10048,8 @@ "DocumentCreateDocumentTemporaryRecipientFieldMetaNumberTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientFieldMetaRadio": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientFieldMetaRadioTypedDict": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryRecipientFieldMetaSignature": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryRecipientFieldMetaSignatureTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientFieldMetaText": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientFieldMetaTextTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientRequest": ".document_createdocumenttemporaryop", @@ -5292,6 +10070,8 @@ "DocumentCreateDocumentTemporaryRecipientTypeNumber2": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientTypeRadio1": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientTypeRadio2": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryRecipientTypeSignature1": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryRecipientTypeSignature2": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientTypeText1": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRecipientTypeText2": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryRequest": ".document_createdocumenttemporaryop", @@ -5311,14 +10091,22 @@ "DocumentCreateDocumentTemporaryTextAlignNumber": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryTextAlignText": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryTypeFreeSignature": ".document_createdocumenttemporaryop", - "DocumentCreateDocumentTemporaryTypeSignature": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryTypeLink": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryUnauthorizedError": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryUnauthorizedErrorData": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryUnauthorizedIssue": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryUnauthorizedIssueTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryValueCheckbox": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryValueCheckboxTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryValueDropdown": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryValueDropdownTypedDict": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryValueRadio": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryValueRadioTypedDict": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryVerticalAlignNumber": ".document_createdocumenttemporaryop", + "DocumentCreateDocumentTemporaryVerticalAlignText": ".document_createdocumenttemporaryop", "DocumentCreateDocumentTemporaryVisibilityRequest": ".document_createdocumenttemporaryop", + "DocumentDirection1": ".document_createdocumenttemporaryop", + "DocumentDirection2": ".document_createdocumenttemporaryop", "DocumentDistributionMethod": ".document_createdocumenttemporaryop", "DocumentDocumentDataType": ".document_createdocumenttemporaryop", "DocumentEmailSettings": ".document_createdocumenttemporaryop", @@ -5352,14 +10140,16 @@ "DocumentTypeName": ".document_createdocumenttemporaryop", "DocumentTypeNumber": ".document_createdocumenttemporaryop", "DocumentTypeRadio": ".document_createdocumenttemporaryop", + "DocumentTypeSignature": ".document_createdocumenttemporaryop", "DocumentTypeText": ".document_createdocumenttemporaryop", - "DocumentTypedDict": ".document_createdocumenttemporaryop", "DocumentValue1": ".document_createdocumenttemporaryop", "DocumentValue1TypedDict": ".document_createdocumenttemporaryop", "DocumentValue2": ".document_createdocumenttemporaryop", "DocumentValue2TypedDict": ".document_createdocumenttemporaryop", "DocumentValue3": ".document_createdocumenttemporaryop", "DocumentValue3TypedDict": ".document_createdocumenttemporaryop", + "DocumentVerticalAlign1": ".document_createdocumenttemporaryop", + "DocumentVerticalAlign2": ".document_createdocumenttemporaryop", "DocumentVisibility": ".document_createdocumenttemporaryop", "FieldMetaDocumentCheckbox": ".document_createdocumenttemporaryop", "FieldMetaDocumentCheckboxTypedDict": ".document_createdocumenttemporaryop", @@ -5377,249 +10167,494 @@ "FieldMetaDocumentNumberTypedDict": ".document_createdocumenttemporaryop", "FieldMetaDocumentRadio": ".document_createdocumenttemporaryop", "FieldMetaDocumentRadioTypedDict": ".document_createdocumenttemporaryop", + "FieldMetaDocumentSignature": ".document_createdocumenttemporaryop", + "FieldMetaDocumentSignatureTypedDict": ".document_createdocumenttemporaryop", "FieldMetaDocumentText": ".document_createdocumenttemporaryop", "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", + "DocumentCreateAccessAuth": ".document_createop", + "DocumentCreateActionAuth": ".document_createop", + "DocumentCreateAttachment": ".document_createop", + "DocumentCreateAttachmentTypedDict": ".document_createop", + "DocumentCreateBadRequestError": ".document_createop", + "DocumentCreateBadRequestErrorData": ".document_createop", + "DocumentCreateBadRequestIssue": ".document_createop", + "DocumentCreateBadRequestIssueTypedDict": ".document_createop", + "DocumentCreateDateFormat": ".document_createop", + "DocumentCreateDirectionCheckbox": ".document_createop", + "DocumentCreateDirectionRadio": ".document_createop", + "DocumentCreateDistributionMethod": ".document_createop", + "DocumentCreateEmailSettings": ".document_createop", + "DocumentCreateEmailSettingsTypedDict": ".document_createop", + "DocumentCreateFieldCheckbox": ".document_createop", + "DocumentCreateFieldCheckboxTypedDict": ".document_createop", + "DocumentCreateFieldDate": ".document_createop", + "DocumentCreateFieldDateTypedDict": ".document_createop", + "DocumentCreateFieldDropdown": ".document_createop", + "DocumentCreateFieldDropdownTypedDict": ".document_createop", + "DocumentCreateFieldEmail": ".document_createop", + "DocumentCreateFieldEmailTypedDict": ".document_createop", + "DocumentCreateFieldFreeSignature": ".document_createop", + "DocumentCreateFieldFreeSignatureTypedDict": ".document_createop", + "DocumentCreateFieldInitials": ".document_createop", + "DocumentCreateFieldInitialsTypedDict": ".document_createop", + "DocumentCreateFieldMetaCheckbox": ".document_createop", + "DocumentCreateFieldMetaCheckboxTypedDict": ".document_createop", + "DocumentCreateFieldMetaDate": ".document_createop", + "DocumentCreateFieldMetaDateTypedDict": ".document_createop", + "DocumentCreateFieldMetaDropdown": ".document_createop", + "DocumentCreateFieldMetaDropdownTypedDict": ".document_createop", + "DocumentCreateFieldMetaEmail": ".document_createop", + "DocumentCreateFieldMetaEmailTypedDict": ".document_createop", + "DocumentCreateFieldMetaInitials": ".document_createop", + "DocumentCreateFieldMetaInitialsTypedDict": ".document_createop", + "DocumentCreateFieldMetaName": ".document_createop", + "DocumentCreateFieldMetaNameTypedDict": ".document_createop", + "DocumentCreateFieldMetaNumber": ".document_createop", + "DocumentCreateFieldMetaNumberTypedDict": ".document_createop", + "DocumentCreateFieldMetaRadio": ".document_createop", + "DocumentCreateFieldMetaRadioTypedDict": ".document_createop", + "DocumentCreateFieldMetaSignature": ".document_createop", + "DocumentCreateFieldMetaSignatureTypedDict": ".document_createop", + "DocumentCreateFieldMetaText": ".document_createop", + "DocumentCreateFieldMetaTextTypedDict": ".document_createop", + "DocumentCreateFieldName": ".document_createop", + "DocumentCreateFieldNameTypedDict": ".document_createop", + "DocumentCreateFieldNumber": ".document_createop", + "DocumentCreateFieldNumberTypedDict": ".document_createop", + "DocumentCreateFieldRadio": ".document_createop", + "DocumentCreateFieldRadioTypedDict": ".document_createop", + "DocumentCreateFieldSignature": ".document_createop", + "DocumentCreateFieldSignatureTypedDict": ".document_createop", + "DocumentCreateFieldText": ".document_createop", + "DocumentCreateFieldTextTypedDict": ".document_createop", + "DocumentCreateFieldUnion": ".document_createop", + "DocumentCreateFieldUnionTypedDict": ".document_createop", + "DocumentCreateFile": ".document_createop", + "DocumentCreateFileTypedDict": ".document_createop", + "DocumentCreateForbiddenError": ".document_createop", + "DocumentCreateForbiddenErrorData": ".document_createop", + "DocumentCreateForbiddenIssue": ".document_createop", + "DocumentCreateForbiddenIssueTypedDict": ".document_createop", + "DocumentCreateFormValues": ".document_createop", + "DocumentCreateFormValuesTypedDict": ".document_createop", + "DocumentCreateGlobalAccessAuth": ".document_createop", + "DocumentCreateGlobalActionAuth": ".document_createop", + "DocumentCreateInternalServerError": ".document_createop", + "DocumentCreateInternalServerErrorData": ".document_createop", + "DocumentCreateInternalServerErrorIssue": ".document_createop", + "DocumentCreateInternalServerErrorIssueTypedDict": ".document_createop", + "DocumentCreateLanguage": ".document_createop", + "DocumentCreateMeta": ".document_createop", + "DocumentCreateMetaTypedDict": ".document_createop", + "DocumentCreatePayload": ".document_createop", + "DocumentCreatePayloadTypedDict": ".document_createop", + "DocumentCreateRecipient": ".document_createop", + "DocumentCreateRecipientTypedDict": ".document_createop", + "DocumentCreateRequest": ".document_createop", + "DocumentCreateRequestTypedDict": ".document_createop", + "DocumentCreateResponse": ".document_createop", + "DocumentCreateResponseTypedDict": ".document_createop", + "DocumentCreateRole": ".document_createop", + "DocumentCreateSigningOrder": ".document_createop", + "DocumentCreateTextAlignDate": ".document_createop", + "DocumentCreateTextAlignEmail": ".document_createop", + "DocumentCreateTextAlignInitials": ".document_createop", + "DocumentCreateTextAlignName": ".document_createop", + "DocumentCreateTextAlignNumber": ".document_createop", + "DocumentCreateTextAlignText": ".document_createop", + "DocumentCreateTypeCheckbox1": ".document_createop", + "DocumentCreateTypeCheckbox2": ".document_createop", + "DocumentCreateTypeDate1": ".document_createop", + "DocumentCreateTypeDate2": ".document_createop", + "DocumentCreateTypeDropdown1": ".document_createop", + "DocumentCreateTypeDropdown2": ".document_createop", + "DocumentCreateTypeEmail1": ".document_createop", + "DocumentCreateTypeEmail2": ".document_createop", + "DocumentCreateTypeFreeSignature": ".document_createop", + "DocumentCreateTypeInitials1": ".document_createop", + "DocumentCreateTypeInitials2": ".document_createop", + "DocumentCreateTypeLink": ".document_createop", + "DocumentCreateTypeName1": ".document_createop", + "DocumentCreateTypeName2": ".document_createop", + "DocumentCreateTypeNumber1": ".document_createop", + "DocumentCreateTypeNumber2": ".document_createop", + "DocumentCreateTypeRadio1": ".document_createop", + "DocumentCreateTypeRadio2": ".document_createop", + "DocumentCreateTypeSignature1": ".document_createop", + "DocumentCreateTypeSignature2": ".document_createop", + "DocumentCreateTypeText1": ".document_createop", + "DocumentCreateTypeText2": ".document_createop", + "DocumentCreateUnauthorizedError": ".document_createop", + "DocumentCreateUnauthorizedErrorData": ".document_createop", + "DocumentCreateUnauthorizedIssue": ".document_createop", + "DocumentCreateUnauthorizedIssueTypedDict": ".document_createop", + "DocumentCreateValueCheckbox": ".document_createop", + "DocumentCreateValueCheckboxTypedDict": ".document_createop", + "DocumentCreateValueDropdown": ".document_createop", + "DocumentCreateValueDropdownTypedDict": ".document_createop", + "DocumentCreateValueRadio": ".document_createop", + "DocumentCreateValueRadioTypedDict": ".document_createop", + "DocumentCreateVerticalAlignNumber": ".document_createop", + "DocumentCreateVerticalAlignText": ".document_createop", + "DocumentCreateVisibility": ".document_createop", + "DocumentDeleteBadRequestError": ".document_deleteop", + "DocumentDeleteBadRequestErrorData": ".document_deleteop", + "DocumentDeleteBadRequestIssue": ".document_deleteop", + "DocumentDeleteBadRequestIssueTypedDict": ".document_deleteop", + "DocumentDeleteForbiddenError": ".document_deleteop", + "DocumentDeleteForbiddenErrorData": ".document_deleteop", + "DocumentDeleteForbiddenIssue": ".document_deleteop", + "DocumentDeleteForbiddenIssueTypedDict": ".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", + "DocumentDeleteUnauthorizedError": ".document_deleteop", + "DocumentDeleteUnauthorizedErrorData": ".document_deleteop", + "DocumentDeleteUnauthorizedIssue": ".document_deleteop", + "DocumentDeleteUnauthorizedIssueTypedDict": ".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", + "DocumentDistributeForbiddenError": ".document_distributeop", + "DocumentDistributeForbiddenErrorData": ".document_distributeop", + "DocumentDistributeForbiddenIssue": ".document_distributeop", + "DocumentDistributeForbiddenIssueTypedDict": ".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", + "DocumentDistributeUnauthorizedError": ".document_distributeop", + "DocumentDistributeUnauthorizedErrorData": ".document_distributeop", + "DocumentDistributeUnauthorizedIssue": ".document_distributeop", + "DocumentDistributeUnauthorizedIssueTypedDict": ".document_distributeop", + "DocumentDistributeVisibility": ".document_distributeop", + "DocumentDownloadBetaBadRequestError": ".document_downloadbetaop", + "DocumentDownloadBetaBadRequestErrorData": ".document_downloadbetaop", + "DocumentDownloadBetaBadRequestIssue": ".document_downloadbetaop", + "DocumentDownloadBetaBadRequestIssueTypedDict": ".document_downloadbetaop", + "DocumentDownloadBetaForbiddenError": ".document_downloadbetaop", + "DocumentDownloadBetaForbiddenErrorData": ".document_downloadbetaop", + "DocumentDownloadBetaForbiddenIssue": ".document_downloadbetaop", + "DocumentDownloadBetaForbiddenIssueTypedDict": ".document_downloadbetaop", + "DocumentDownloadBetaInternalServerError": ".document_downloadbetaop", + "DocumentDownloadBetaInternalServerErrorData": ".document_downloadbetaop", + "DocumentDownloadBetaInternalServerErrorIssue": ".document_downloadbetaop", + "DocumentDownloadBetaInternalServerErrorIssueTypedDict": ".document_downloadbetaop", + "DocumentDownloadBetaNotFoundError": ".document_downloadbetaop", + "DocumentDownloadBetaNotFoundErrorData": ".document_downloadbetaop", + "DocumentDownloadBetaNotFoundIssue": ".document_downloadbetaop", + "DocumentDownloadBetaNotFoundIssueTypedDict": ".document_downloadbetaop", + "DocumentDownloadBetaRequest": ".document_downloadbetaop", + "DocumentDownloadBetaRequestTypedDict": ".document_downloadbetaop", + "DocumentDownloadBetaResponse": ".document_downloadbetaop", + "DocumentDownloadBetaResponseTypedDict": ".document_downloadbetaop", + "DocumentDownloadBetaUnauthorizedError": ".document_downloadbetaop", + "DocumentDownloadBetaUnauthorizedErrorData": ".document_downloadbetaop", + "DocumentDownloadBetaUnauthorizedIssue": ".document_downloadbetaop", + "DocumentDownloadBetaUnauthorizedIssueTypedDict": ".document_downloadbetaop", + "DocumentDownloadBetaVersion": ".document_downloadbetaop", + "DocumentDownloadBadRequestError": ".document_downloadop", + "DocumentDownloadBadRequestErrorData": ".document_downloadop", + "DocumentDownloadBadRequestIssue": ".document_downloadop", + "DocumentDownloadBadRequestIssueTypedDict": ".document_downloadop", + "DocumentDownloadForbiddenError": ".document_downloadop", + "DocumentDownloadForbiddenErrorData": ".document_downloadop", + "DocumentDownloadForbiddenIssue": ".document_downloadop", + "DocumentDownloadForbiddenIssueTypedDict": ".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", + "DocumentDownloadUnauthorizedError": ".document_downloadop", + "DocumentDownloadUnauthorizedErrorData": ".document_downloadop", + "DocumentDownloadUnauthorizedIssue": ".document_downloadop", + "DocumentDownloadUnauthorizedIssueTypedDict": ".document_downloadop", + "DocumentDownloadVersion": ".document_downloadop", + "DocumentDuplicateBadRequestError": ".document_duplicateop", + "DocumentDuplicateBadRequestErrorData": ".document_duplicateop", + "DocumentDuplicateBadRequestIssue": ".document_duplicateop", + "DocumentDuplicateBadRequestIssueTypedDict": ".document_duplicateop", + "DocumentDuplicateForbiddenError": ".document_duplicateop", + "DocumentDuplicateForbiddenErrorData": ".document_duplicateop", + "DocumentDuplicateForbiddenIssue": ".document_duplicateop", + "DocumentDuplicateForbiddenIssueTypedDict": ".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", + "DocumentDuplicateUnauthorizedError": ".document_duplicateop", + "DocumentDuplicateUnauthorizedErrorData": ".document_duplicateop", + "DocumentDuplicateUnauthorizedIssue": ".document_duplicateop", + "DocumentDuplicateUnauthorizedIssueTypedDict": ".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", + "DocumentFindForbiddenError": ".document_findop", + "DocumentFindForbiddenErrorData": ".document_findop", + "DocumentFindForbiddenIssue": ".document_findop", + "DocumentFindForbiddenIssueTypedDict": ".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", + "DocumentFindUnauthorizedError": ".document_findop", + "DocumentFindUnauthorizedErrorData": ".document_findop", + "DocumentFindUnauthorizedIssue": ".document_findop", + "DocumentFindUnauthorizedIssueTypedDict": ".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", + "DocumentGetDirection1": ".document_getop", + "DocumentGetDirection2": ".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", + "DocumentGetEnvelopeItem": ".document_getop", + "DocumentGetEnvelopeItemTypedDict": ".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", + "DocumentGetFieldMetaSignature": ".document_getop", + "DocumentGetFieldMetaSignatureTypedDict": ".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", + "DocumentGetForbiddenError": ".document_getop", + "DocumentGetForbiddenErrorData": ".document_getop", + "DocumentGetForbiddenIssue": ".document_getop", + "DocumentGetForbiddenIssueTypedDict": ".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", + "DocumentGetTypeSignature": ".document_getop", + "DocumentGetTypeText": ".document_getop", + "DocumentGetUnauthorizedError": ".document_getop", + "DocumentGetUnauthorizedErrorData": ".document_getop", + "DocumentGetUnauthorizedIssue": ".document_getop", + "DocumentGetUnauthorizedIssueTypedDict": ".document_getop", + "DocumentGetValue1": ".document_getop", + "DocumentGetValue1TypedDict": ".document_getop", + "DocumentGetValue2": ".document_getop", + "DocumentGetValue2TypedDict": ".document_getop", + "DocumentGetValue3": ".document_getop", + "DocumentGetValue3TypedDict": ".document_getop", + "DocumentGetVerticalAlign1": ".document_getop", + "DocumentGetVerticalAlign2": ".document_getop", + "DocumentGetVisibility": ".document_getop", + "DocumentRedistributeBadRequestError": ".document_redistributeop", + "DocumentRedistributeBadRequestErrorData": ".document_redistributeop", + "DocumentRedistributeBadRequestIssue": ".document_redistributeop", + "DocumentRedistributeBadRequestIssueTypedDict": ".document_redistributeop", + "DocumentRedistributeForbiddenError": ".document_redistributeop", + "DocumentRedistributeForbiddenErrorData": ".document_redistributeop", + "DocumentRedistributeForbiddenIssue": ".document_redistributeop", + "DocumentRedistributeForbiddenIssueTypedDict": ".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", + "DocumentRedistributeUnauthorizedError": ".document_redistributeop", + "DocumentRedistributeUnauthorizedErrorData": ".document_redistributeop", + "DocumentRedistributeUnauthorizedIssue": ".document_redistributeop", + "DocumentRedistributeUnauthorizedIssueTypedDict": ".document_redistributeop", + "DocumentUpdateAuthOptions": ".document_updateop", + "DocumentUpdateAuthOptionsTypedDict": ".document_updateop", + "DocumentUpdateBadRequestError": ".document_updateop", + "DocumentUpdateBadRequestErrorData": ".document_updateop", + "DocumentUpdateBadRequestIssue": ".document_updateop", + "DocumentUpdateBadRequestIssueTypedDict": ".document_updateop", + "DocumentUpdateData": ".document_updateop", + "DocumentUpdateDataGlobalAccessAuth": ".document_updateop", + "DocumentUpdateDataGlobalActionAuth": ".document_updateop", + "DocumentUpdateDataTypedDict": ".document_updateop", + "DocumentUpdateDataVisibility": ".document_updateop", + "DocumentUpdateDateFormat": ".document_updateop", + "DocumentUpdateDistributionMethod": ".document_updateop", + "DocumentUpdateEmailSettings": ".document_updateop", + "DocumentUpdateEmailSettingsTypedDict": ".document_updateop", + "DocumentUpdateForbiddenError": ".document_updateop", + "DocumentUpdateForbiddenErrorData": ".document_updateop", + "DocumentUpdateForbiddenIssue": ".document_updateop", + "DocumentUpdateForbiddenIssueTypedDict": ".document_updateop", + "DocumentUpdateFormValues": ".document_updateop", + "DocumentUpdateFormValuesTypedDict": ".document_updateop", + "DocumentUpdateGlobalAccessAuthResponse": ".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", + "DocumentUpdateUnauthorizedError": ".document_updateop", + "DocumentUpdateUnauthorizedErrorData": ".document_updateop", + "DocumentUpdateUnauthorizedIssue": ".document_updateop", + "DocumentUpdateUnauthorizedIssueTypedDict": ".document_updateop", + "DocumentUpdateVisibilityResponse": ".document_updateop", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestErrorData": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssue": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssueTypedDict": ".embeddingpresign_createembeddingpresigntokenop", + "EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError": ".embeddingpresign_createembeddingpresigntokenop", + "EmbeddingPresignCreateEmbeddingPresignTokenForbiddenErrorData": ".embeddingpresign_createembeddingpresigntokenop", + "EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssue": ".embeddingpresign_createembeddingpresigntokenop", + "EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssueTypedDict": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorData": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssue": ".embeddingpresign_createembeddingpresigntokenop", @@ -5628,10 +10663,18 @@ "EmbeddingPresignCreateEmbeddingPresignTokenRequestTypedDict": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignCreateEmbeddingPresignTokenResponse": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignCreateEmbeddingPresignTokenResponseTypedDict": ".embeddingpresign_createembeddingpresigntokenop", + "EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError": ".embeddingpresign_createembeddingpresigntokenop", + "EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedErrorData": ".embeddingpresign_createembeddingpresigntokenop", + "EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssue": ".embeddingpresign_createembeddingpresigntokenop", + "EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssueTypedDict": ".embeddingpresign_createembeddingpresigntokenop", "EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError": ".embeddingpresign_verifyembeddingpresigntokenop", "EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestErrorData": ".embeddingpresign_verifyembeddingpresigntokenop", "EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssue": ".embeddingpresign_verifyembeddingpresigntokenop", "EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssueTypedDict": ".embeddingpresign_verifyembeddingpresigntokenop", + "EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError": ".embeddingpresign_verifyembeddingpresigntokenop", + "EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenErrorData": ".embeddingpresign_verifyembeddingpresigntokenop", + "EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssue": ".embeddingpresign_verifyembeddingpresigntokenop", + "EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssueTypedDict": ".embeddingpresign_verifyembeddingpresigntokenop", "EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError": ".embeddingpresign_verifyembeddingpresigntokenop", "EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorData": ".embeddingpresign_verifyembeddingpresigntokenop", "EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssue": ".embeddingpresign_verifyembeddingpresigntokenop", @@ -5640,10 +10683,1224 @@ "EmbeddingPresignVerifyEmbeddingPresignTokenRequestTypedDict": ".embeddingpresign_verifyembeddingpresigntokenop", "EmbeddingPresignVerifyEmbeddingPresignTokenResponse": ".embeddingpresign_verifyembeddingpresigntokenop", "EmbeddingPresignVerifyEmbeddingPresignTokenResponseTypedDict": ".embeddingpresign_verifyembeddingpresigntokenop", + "EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError": ".embeddingpresign_verifyembeddingpresigntokenop", + "EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedErrorData": ".embeddingpresign_verifyembeddingpresigntokenop", + "EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssue": ".embeddingpresign_verifyembeddingpresigntokenop", + "EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssueTypedDict": ".embeddingpresign_verifyembeddingpresigntokenop", + "EnvelopeAttachmentCreateBadRequestError": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateBadRequestErrorData": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateBadRequestIssue": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateBadRequestIssueTypedDict": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateData": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateDataTypedDict": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateForbiddenError": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateForbiddenErrorData": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateForbiddenIssue": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateForbiddenIssueTypedDict": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateInternalServerError": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateInternalServerErrorData": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateInternalServerErrorIssue": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateInternalServerErrorIssueTypedDict": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateRequest": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateRequestTypedDict": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateResponse": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateResponseTypedDict": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateUnauthorizedError": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateUnauthorizedErrorData": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateUnauthorizedIssue": ".envelope_attachment_createop", + "EnvelopeAttachmentCreateUnauthorizedIssueTypedDict": ".envelope_attachment_createop", + "EnvelopeAttachmentDeleteBadRequestError": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteBadRequestErrorData": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteBadRequestIssue": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteBadRequestIssueTypedDict": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteForbiddenError": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteForbiddenErrorData": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteForbiddenIssue": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteForbiddenIssueTypedDict": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteInternalServerError": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteInternalServerErrorData": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteInternalServerErrorIssue": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteInternalServerErrorIssueTypedDict": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteRequest": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteRequestTypedDict": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteResponse": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteResponseTypedDict": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteUnauthorizedError": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteUnauthorizedErrorData": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteUnauthorizedIssue": ".envelope_attachment_deleteop", + "EnvelopeAttachmentDeleteUnauthorizedIssueTypedDict": ".envelope_attachment_deleteop", + "EnvelopeAttachmentFindBadRequestError": ".envelope_attachment_findop", + "EnvelopeAttachmentFindBadRequestErrorData": ".envelope_attachment_findop", + "EnvelopeAttachmentFindBadRequestIssue": ".envelope_attachment_findop", + "EnvelopeAttachmentFindBadRequestIssueTypedDict": ".envelope_attachment_findop", + "EnvelopeAttachmentFindData": ".envelope_attachment_findop", + "EnvelopeAttachmentFindDataTypedDict": ".envelope_attachment_findop", + "EnvelopeAttachmentFindForbiddenError": ".envelope_attachment_findop", + "EnvelopeAttachmentFindForbiddenErrorData": ".envelope_attachment_findop", + "EnvelopeAttachmentFindForbiddenIssue": ".envelope_attachment_findop", + "EnvelopeAttachmentFindForbiddenIssueTypedDict": ".envelope_attachment_findop", + "EnvelopeAttachmentFindInternalServerError": ".envelope_attachment_findop", + "EnvelopeAttachmentFindInternalServerErrorData": ".envelope_attachment_findop", + "EnvelopeAttachmentFindInternalServerErrorIssue": ".envelope_attachment_findop", + "EnvelopeAttachmentFindInternalServerErrorIssueTypedDict": ".envelope_attachment_findop", + "EnvelopeAttachmentFindNotFoundError": ".envelope_attachment_findop", + "EnvelopeAttachmentFindNotFoundErrorData": ".envelope_attachment_findop", + "EnvelopeAttachmentFindNotFoundIssue": ".envelope_attachment_findop", + "EnvelopeAttachmentFindNotFoundIssueTypedDict": ".envelope_attachment_findop", + "EnvelopeAttachmentFindRequest": ".envelope_attachment_findop", + "EnvelopeAttachmentFindRequestTypedDict": ".envelope_attachment_findop", + "EnvelopeAttachmentFindResponse": ".envelope_attachment_findop", + "EnvelopeAttachmentFindResponseTypedDict": ".envelope_attachment_findop", + "EnvelopeAttachmentFindType": ".envelope_attachment_findop", + "EnvelopeAttachmentFindUnauthorizedError": ".envelope_attachment_findop", + "EnvelopeAttachmentFindUnauthorizedErrorData": ".envelope_attachment_findop", + "EnvelopeAttachmentFindUnauthorizedIssue": ".envelope_attachment_findop", + "EnvelopeAttachmentFindUnauthorizedIssueTypedDict": ".envelope_attachment_findop", + "EnvelopeAttachmentUpdateBadRequestError": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateBadRequestErrorData": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateBadRequestIssue": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateBadRequestIssueTypedDict": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateData": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateDataTypedDict": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateForbiddenError": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateForbiddenErrorData": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateForbiddenIssue": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateForbiddenIssueTypedDict": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateInternalServerError": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateInternalServerErrorData": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateInternalServerErrorIssue": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateInternalServerErrorIssueTypedDict": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateRequest": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateRequestTypedDict": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateResponse": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateResponseTypedDict": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateUnauthorizedError": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateUnauthorizedErrorData": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateUnauthorizedIssue": ".envelope_attachment_updateop", + "EnvelopeAttachmentUpdateUnauthorizedIssueTypedDict": ".envelope_attachment_updateop", + "EnvelopeCreateAccessAuth": ".envelope_createop", + "EnvelopeCreateActionAuth": ".envelope_createop", + "EnvelopeCreateAttachment": ".envelope_createop", + "EnvelopeCreateAttachmentTypedDict": ".envelope_createop", + "EnvelopeCreateBadRequestError": ".envelope_createop", + "EnvelopeCreateBadRequestErrorData": ".envelope_createop", + "EnvelopeCreateBadRequestIssue": ".envelope_createop", + "EnvelopeCreateBadRequestIssueTypedDict": ".envelope_createop", + "EnvelopeCreateDateFormat": ".envelope_createop", + "EnvelopeCreateDirectionCheckbox": ".envelope_createop", + "EnvelopeCreateDirectionRadio": ".envelope_createop", + "EnvelopeCreateDistributionMethod": ".envelope_createop", + "EnvelopeCreateEmailSettings": ".envelope_createop", + "EnvelopeCreateEmailSettingsTypedDict": ".envelope_createop", + "EnvelopeCreateFieldCheckbox": ".envelope_createop", + "EnvelopeCreateFieldCheckboxTypedDict": ".envelope_createop", + "EnvelopeCreateFieldDate": ".envelope_createop", + "EnvelopeCreateFieldDateTypedDict": ".envelope_createop", + "EnvelopeCreateFieldDropdown": ".envelope_createop", + "EnvelopeCreateFieldDropdownTypedDict": ".envelope_createop", + "EnvelopeCreateFieldEmail": ".envelope_createop", + "EnvelopeCreateFieldEmailTypedDict": ".envelope_createop", + "EnvelopeCreateFieldFreeSignature": ".envelope_createop", + "EnvelopeCreateFieldFreeSignatureTypedDict": ".envelope_createop", + "EnvelopeCreateFieldInitials": ".envelope_createop", + "EnvelopeCreateFieldInitialsTypedDict": ".envelope_createop", + "EnvelopeCreateFieldMetaCheckbox": ".envelope_createop", + "EnvelopeCreateFieldMetaCheckboxTypedDict": ".envelope_createop", + "EnvelopeCreateFieldMetaDate": ".envelope_createop", + "EnvelopeCreateFieldMetaDateTypedDict": ".envelope_createop", + "EnvelopeCreateFieldMetaDropdown": ".envelope_createop", + "EnvelopeCreateFieldMetaDropdownTypedDict": ".envelope_createop", + "EnvelopeCreateFieldMetaEmail": ".envelope_createop", + "EnvelopeCreateFieldMetaEmailTypedDict": ".envelope_createop", + "EnvelopeCreateFieldMetaInitials": ".envelope_createop", + "EnvelopeCreateFieldMetaInitialsTypedDict": ".envelope_createop", + "EnvelopeCreateFieldMetaName": ".envelope_createop", + "EnvelopeCreateFieldMetaNameTypedDict": ".envelope_createop", + "EnvelopeCreateFieldMetaNumber": ".envelope_createop", + "EnvelopeCreateFieldMetaNumberTypedDict": ".envelope_createop", + "EnvelopeCreateFieldMetaRadio": ".envelope_createop", + "EnvelopeCreateFieldMetaRadioTypedDict": ".envelope_createop", + "EnvelopeCreateFieldMetaSignature": ".envelope_createop", + "EnvelopeCreateFieldMetaSignatureTypedDict": ".envelope_createop", + "EnvelopeCreateFieldMetaText": ".envelope_createop", + "EnvelopeCreateFieldMetaTextTypedDict": ".envelope_createop", + "EnvelopeCreateFieldName": ".envelope_createop", + "EnvelopeCreateFieldNameTypedDict": ".envelope_createop", + "EnvelopeCreateFieldNumber": ".envelope_createop", + "EnvelopeCreateFieldNumberTypedDict": ".envelope_createop", + "EnvelopeCreateFieldRadio": ".envelope_createop", + "EnvelopeCreateFieldRadioTypedDict": ".envelope_createop", + "EnvelopeCreateFieldSignature": ".envelope_createop", + "EnvelopeCreateFieldSignatureTypedDict": ".envelope_createop", + "EnvelopeCreateFieldText": ".envelope_createop", + "EnvelopeCreateFieldTextTypedDict": ".envelope_createop", + "EnvelopeCreateFieldUnion": ".envelope_createop", + "EnvelopeCreateFieldUnionTypedDict": ".envelope_createop", + "EnvelopeCreateFile": ".envelope_createop", + "EnvelopeCreateFileTypedDict": ".envelope_createop", + "EnvelopeCreateForbiddenError": ".envelope_createop", + "EnvelopeCreateForbiddenErrorData": ".envelope_createop", + "EnvelopeCreateForbiddenIssue": ".envelope_createop", + "EnvelopeCreateForbiddenIssueTypedDict": ".envelope_createop", + "EnvelopeCreateFormValues": ".envelope_createop", + "EnvelopeCreateFormValuesTypedDict": ".envelope_createop", + "EnvelopeCreateGlobalAccessAuth": ".envelope_createop", + "EnvelopeCreateGlobalActionAuth": ".envelope_createop", + "EnvelopeCreateIdentifier1": ".envelope_createop", + "EnvelopeCreateIdentifier10": ".envelope_createop", + "EnvelopeCreateIdentifier10TypedDict": ".envelope_createop", + "EnvelopeCreateIdentifier11": ".envelope_createop", + "EnvelopeCreateIdentifier11TypedDict": ".envelope_createop", + "EnvelopeCreateIdentifier1TypedDict": ".envelope_createop", + "EnvelopeCreateIdentifier2": ".envelope_createop", + "EnvelopeCreateIdentifier2TypedDict": ".envelope_createop", + "EnvelopeCreateIdentifier3": ".envelope_createop", + "EnvelopeCreateIdentifier3TypedDict": ".envelope_createop", + "EnvelopeCreateIdentifier4": ".envelope_createop", + "EnvelopeCreateIdentifier4TypedDict": ".envelope_createop", + "EnvelopeCreateIdentifier5": ".envelope_createop", + "EnvelopeCreateIdentifier5TypedDict": ".envelope_createop", + "EnvelopeCreateIdentifier6": ".envelope_createop", + "EnvelopeCreateIdentifier6TypedDict": ".envelope_createop", + "EnvelopeCreateIdentifier7": ".envelope_createop", + "EnvelopeCreateIdentifier7TypedDict": ".envelope_createop", + "EnvelopeCreateIdentifier8": ".envelope_createop", + "EnvelopeCreateIdentifier8TypedDict": ".envelope_createop", + "EnvelopeCreateIdentifier9": ".envelope_createop", + "EnvelopeCreateIdentifier9TypedDict": ".envelope_createop", + "EnvelopeCreateInternalServerError": ".envelope_createop", + "EnvelopeCreateInternalServerErrorData": ".envelope_createop", + "EnvelopeCreateInternalServerErrorIssue": ".envelope_createop", + "EnvelopeCreateInternalServerErrorIssueTypedDict": ".envelope_createop", + "EnvelopeCreateLanguage": ".envelope_createop", + "EnvelopeCreateMeta": ".envelope_createop", + "EnvelopeCreateMetaTypedDict": ".envelope_createop", + "EnvelopeCreatePayload": ".envelope_createop", + "EnvelopeCreatePayloadTypedDict": ".envelope_createop", + "EnvelopeCreateRecipient": ".envelope_createop", + "EnvelopeCreateRecipientTypedDict": ".envelope_createop", + "EnvelopeCreateRequest": ".envelope_createop", + "EnvelopeCreateRequestTypedDict": ".envelope_createop", + "EnvelopeCreateResponse": ".envelope_createop", + "EnvelopeCreateResponseTypedDict": ".envelope_createop", + "EnvelopeCreateRole": ".envelope_createop", + "EnvelopeCreateSigningOrder": ".envelope_createop", + "EnvelopeCreateTextAlignDate": ".envelope_createop", + "EnvelopeCreateTextAlignEmail": ".envelope_createop", + "EnvelopeCreateTextAlignInitials": ".envelope_createop", + "EnvelopeCreateTextAlignName": ".envelope_createop", + "EnvelopeCreateTextAlignNumber": ".envelope_createop", + "EnvelopeCreateTextAlignText": ".envelope_createop", + "EnvelopeCreateType": ".envelope_createop", + "EnvelopeCreateTypeCheckbox1": ".envelope_createop", + "EnvelopeCreateTypeCheckbox2": ".envelope_createop", + "EnvelopeCreateTypeDate1": ".envelope_createop", + "EnvelopeCreateTypeDate2": ".envelope_createop", + "EnvelopeCreateTypeDropdown1": ".envelope_createop", + "EnvelopeCreateTypeDropdown2": ".envelope_createop", + "EnvelopeCreateTypeEmail1": ".envelope_createop", + "EnvelopeCreateTypeEmail2": ".envelope_createop", + "EnvelopeCreateTypeFreeSignature": ".envelope_createop", + "EnvelopeCreateTypeInitials1": ".envelope_createop", + "EnvelopeCreateTypeInitials2": ".envelope_createop", + "EnvelopeCreateTypeLink": ".envelope_createop", + "EnvelopeCreateTypeName1": ".envelope_createop", + "EnvelopeCreateTypeName2": ".envelope_createop", + "EnvelopeCreateTypeNumber1": ".envelope_createop", + "EnvelopeCreateTypeNumber2": ".envelope_createop", + "EnvelopeCreateTypeRadio1": ".envelope_createop", + "EnvelopeCreateTypeRadio2": ".envelope_createop", + "EnvelopeCreateTypeSignature1": ".envelope_createop", + "EnvelopeCreateTypeSignature2": ".envelope_createop", + "EnvelopeCreateTypeText1": ".envelope_createop", + "EnvelopeCreateTypeText2": ".envelope_createop", + "EnvelopeCreateUnauthorizedError": ".envelope_createop", + "EnvelopeCreateUnauthorizedErrorData": ".envelope_createop", + "EnvelopeCreateUnauthorizedIssue": ".envelope_createop", + "EnvelopeCreateUnauthorizedIssueTypedDict": ".envelope_createop", + "EnvelopeCreateValueCheckbox": ".envelope_createop", + "EnvelopeCreateValueCheckboxTypedDict": ".envelope_createop", + "EnvelopeCreateValueDropdown": ".envelope_createop", + "EnvelopeCreateValueDropdownTypedDict": ".envelope_createop", + "EnvelopeCreateValueRadio": ".envelope_createop", + "EnvelopeCreateValueRadioTypedDict": ".envelope_createop", + "EnvelopeCreateVerticalAlignNumber": ".envelope_createop", + "EnvelopeCreateVerticalAlignText": ".envelope_createop", + "EnvelopeCreateVisibility": ".envelope_createop", + "EnvelopeDeleteBadRequestError": ".envelope_deleteop", + "EnvelopeDeleteBadRequestErrorData": ".envelope_deleteop", + "EnvelopeDeleteBadRequestIssue": ".envelope_deleteop", + "EnvelopeDeleteBadRequestIssueTypedDict": ".envelope_deleteop", + "EnvelopeDeleteForbiddenError": ".envelope_deleteop", + "EnvelopeDeleteForbiddenErrorData": ".envelope_deleteop", + "EnvelopeDeleteForbiddenIssue": ".envelope_deleteop", + "EnvelopeDeleteForbiddenIssueTypedDict": ".envelope_deleteop", + "EnvelopeDeleteInternalServerError": ".envelope_deleteop", + "EnvelopeDeleteInternalServerErrorData": ".envelope_deleteop", + "EnvelopeDeleteInternalServerErrorIssue": ".envelope_deleteop", + "EnvelopeDeleteInternalServerErrorIssueTypedDict": ".envelope_deleteop", + "EnvelopeDeleteRequest": ".envelope_deleteop", + "EnvelopeDeleteRequestTypedDict": ".envelope_deleteop", + "EnvelopeDeleteResponse": ".envelope_deleteop", + "EnvelopeDeleteResponseTypedDict": ".envelope_deleteop", + "EnvelopeDeleteUnauthorizedError": ".envelope_deleteop", + "EnvelopeDeleteUnauthorizedErrorData": ".envelope_deleteop", + "EnvelopeDeleteUnauthorizedIssue": ".envelope_deleteop", + "EnvelopeDeleteUnauthorizedIssueTypedDict": ".envelope_deleteop", + "EnvelopeDistributeBadRequestError": ".envelope_distributeop", + "EnvelopeDistributeBadRequestErrorData": ".envelope_distributeop", + "EnvelopeDistributeBadRequestIssue": ".envelope_distributeop", + "EnvelopeDistributeBadRequestIssueTypedDict": ".envelope_distributeop", + "EnvelopeDistributeDateFormat": ".envelope_distributeop", + "EnvelopeDistributeDistributionMethod": ".envelope_distributeop", + "EnvelopeDistributeEmailSettings": ".envelope_distributeop", + "EnvelopeDistributeEmailSettingsTypedDict": ".envelope_distributeop", + "EnvelopeDistributeForbiddenError": ".envelope_distributeop", + "EnvelopeDistributeForbiddenErrorData": ".envelope_distributeop", + "EnvelopeDistributeForbiddenIssue": ".envelope_distributeop", + "EnvelopeDistributeForbiddenIssueTypedDict": ".envelope_distributeop", + "EnvelopeDistributeInternalServerError": ".envelope_distributeop", + "EnvelopeDistributeInternalServerErrorData": ".envelope_distributeop", + "EnvelopeDistributeInternalServerErrorIssue": ".envelope_distributeop", + "EnvelopeDistributeInternalServerErrorIssueTypedDict": ".envelope_distributeop", + "EnvelopeDistributeLanguage": ".envelope_distributeop", + "EnvelopeDistributeMeta": ".envelope_distributeop", + "EnvelopeDistributeMetaTypedDict": ".envelope_distributeop", + "EnvelopeDistributeRequest": ".envelope_distributeop", + "EnvelopeDistributeRequestTypedDict": ".envelope_distributeop", + "EnvelopeDistributeResponse": ".envelope_distributeop", + "EnvelopeDistributeResponseTypedDict": ".envelope_distributeop", + "EnvelopeDistributeUnauthorizedError": ".envelope_distributeop", + "EnvelopeDistributeUnauthorizedErrorData": ".envelope_distributeop", + "EnvelopeDistributeUnauthorizedIssue": ".envelope_distributeop", + "EnvelopeDistributeUnauthorizedIssueTypedDict": ".envelope_distributeop", + "EnvelopeDuplicateBadRequestError": ".envelope_duplicateop", + "EnvelopeDuplicateBadRequestErrorData": ".envelope_duplicateop", + "EnvelopeDuplicateBadRequestIssue": ".envelope_duplicateop", + "EnvelopeDuplicateBadRequestIssueTypedDict": ".envelope_duplicateop", + "EnvelopeDuplicateForbiddenError": ".envelope_duplicateop", + "EnvelopeDuplicateForbiddenErrorData": ".envelope_duplicateop", + "EnvelopeDuplicateForbiddenIssue": ".envelope_duplicateop", + "EnvelopeDuplicateForbiddenIssueTypedDict": ".envelope_duplicateop", + "EnvelopeDuplicateInternalServerError": ".envelope_duplicateop", + "EnvelopeDuplicateInternalServerErrorData": ".envelope_duplicateop", + "EnvelopeDuplicateInternalServerErrorIssue": ".envelope_duplicateop", + "EnvelopeDuplicateInternalServerErrorIssueTypedDict": ".envelope_duplicateop", + "EnvelopeDuplicateRequest": ".envelope_duplicateop", + "EnvelopeDuplicateRequestTypedDict": ".envelope_duplicateop", + "EnvelopeDuplicateResponse": ".envelope_duplicateop", + "EnvelopeDuplicateResponseTypedDict": ".envelope_duplicateop", + "EnvelopeDuplicateUnauthorizedError": ".envelope_duplicateop", + "EnvelopeDuplicateUnauthorizedErrorData": ".envelope_duplicateop", + "EnvelopeDuplicateUnauthorizedIssue": ".envelope_duplicateop", + "EnvelopeDuplicateUnauthorizedIssueTypedDict": ".envelope_duplicateop", + "EnvelopeFieldCreateManyBadRequestError": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyBadRequestErrorData": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyBadRequestIssue": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyBadRequestIssueTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataCheckbox": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataCheckboxTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataDate": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataDateTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataDropdown": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataDropdownTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataEmail": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataEmailTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataFreeSignature": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataFreeSignatureTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataInitials": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataInitialsTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataName": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataNameTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataNumber": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataNumberTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataRadio": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataRadioTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataSignature": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataSignatureTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataText": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataTextTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataUnion": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDataUnionTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDirectionCheckbox": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDirectionRadio": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDirectionResponse1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyDirectionResponse2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaCheckboxRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaCheckboxRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaCheckboxResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaCheckboxResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaDateRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaDateRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaDateResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaDateResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaDropdownRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaDropdownRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaDropdownResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaDropdownResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaEmailRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaEmailRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaEmailResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaEmailResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaInitialsRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaInitialsRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaInitialsResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaInitialsResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaNameRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaNameRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaNameResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaNameResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaNumberRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaNumberRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaNumberResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaNumberResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaRadioRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaRadioRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaRadioResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaRadioResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaSignatureRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaSignatureRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaSignatureResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaSignatureResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTextRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTextRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTextResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTextResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTypeCheckbox": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTypeDate": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTypeDropdown": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTypeEmail": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTypeInitials": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTypeName": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTypeNumber": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTypeRadio": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTypeSignature": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaTypeText": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaUnion": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyFieldMetaUnionTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyForbiddenError": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyForbiddenErrorData": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyForbiddenIssue": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyForbiddenIssueTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyInternalServerError": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyInternalServerErrorData": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyInternalServerErrorIssue": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyInternalServerErrorIssueTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyRequest": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyRequestTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyResponseTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignDate": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignEmail": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignInitials": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignName": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignNumber": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignResponse1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignResponse2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignResponse3": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignResponse4": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignResponse5": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignResponse6": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTextAlignText": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeCheckboxRequest1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeCheckboxRequest2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeDateRequest1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeDateRequest2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeDropdownRequest1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeDropdownRequest2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeEmailRequest1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeEmailRequest2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeFreeSignature": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeInitialsRequest1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeInitialsRequest2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeNameRequest1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeNameRequest2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeNumberRequest1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeNumberRequest2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeRadioRequest1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeRadioRequest2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeResponse": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeSignatureRequest1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeSignatureRequest2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeTextRequest1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyTypeTextRequest2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyUnauthorizedError": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyUnauthorizedErrorData": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyUnauthorizedIssue": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyUnauthorizedIssueTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueCheckbox": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueCheckboxTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueDropdown": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueDropdownTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueRadio": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueRadioTypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueResponse1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueResponse1TypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueResponse2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueResponse2TypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueResponse3": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyValueResponse3TypedDict": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyVerticalAlignNumber": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyVerticalAlignResponse1": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyVerticalAlignResponse2": ".envelope_field_createmanyop", + "EnvelopeFieldCreateManyVerticalAlignText": ".envelope_field_createmanyop", + "EnvelopeFieldDeleteBadRequestError": ".envelope_field_deleteop", + "EnvelopeFieldDeleteBadRequestErrorData": ".envelope_field_deleteop", + "EnvelopeFieldDeleteBadRequestIssue": ".envelope_field_deleteop", + "EnvelopeFieldDeleteBadRequestIssueTypedDict": ".envelope_field_deleteop", + "EnvelopeFieldDeleteForbiddenError": ".envelope_field_deleteop", + "EnvelopeFieldDeleteForbiddenErrorData": ".envelope_field_deleteop", + "EnvelopeFieldDeleteForbiddenIssue": ".envelope_field_deleteop", + "EnvelopeFieldDeleteForbiddenIssueTypedDict": ".envelope_field_deleteop", + "EnvelopeFieldDeleteInternalServerError": ".envelope_field_deleteop", + "EnvelopeFieldDeleteInternalServerErrorData": ".envelope_field_deleteop", + "EnvelopeFieldDeleteInternalServerErrorIssue": ".envelope_field_deleteop", + "EnvelopeFieldDeleteInternalServerErrorIssueTypedDict": ".envelope_field_deleteop", + "EnvelopeFieldDeleteRequest": ".envelope_field_deleteop", + "EnvelopeFieldDeleteRequestTypedDict": ".envelope_field_deleteop", + "EnvelopeFieldDeleteResponse": ".envelope_field_deleteop", + "EnvelopeFieldDeleteResponseTypedDict": ".envelope_field_deleteop", + "EnvelopeFieldDeleteUnauthorizedError": ".envelope_field_deleteop", + "EnvelopeFieldDeleteUnauthorizedErrorData": ".envelope_field_deleteop", + "EnvelopeFieldDeleteUnauthorizedIssue": ".envelope_field_deleteop", + "EnvelopeFieldDeleteUnauthorizedIssueTypedDict": ".envelope_field_deleteop", + "EnvelopeFieldGetBadRequestError": ".envelope_field_getop", + "EnvelopeFieldGetBadRequestErrorData": ".envelope_field_getop", + "EnvelopeFieldGetBadRequestIssue": ".envelope_field_getop", + "EnvelopeFieldGetBadRequestIssueTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetDirection1": ".envelope_field_getop", + "EnvelopeFieldGetDirection2": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaCheckbox": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaCheckboxTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaDate": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaDateTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaDropdown": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaDropdownTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaEmail": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaEmailTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaInitials": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaInitialsTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaName": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaNameTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaNumber": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaNumberTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaRadio": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaRadioTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaSignature": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaSignatureTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaText": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaTextTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaUnion": ".envelope_field_getop", + "EnvelopeFieldGetFieldMetaUnionTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetForbiddenError": ".envelope_field_getop", + "EnvelopeFieldGetForbiddenErrorData": ".envelope_field_getop", + "EnvelopeFieldGetForbiddenIssue": ".envelope_field_getop", + "EnvelopeFieldGetForbiddenIssueTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetInternalServerError": ".envelope_field_getop", + "EnvelopeFieldGetInternalServerErrorData": ".envelope_field_getop", + "EnvelopeFieldGetInternalServerErrorIssue": ".envelope_field_getop", + "EnvelopeFieldGetInternalServerErrorIssueTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetNotFoundError": ".envelope_field_getop", + "EnvelopeFieldGetNotFoundErrorData": ".envelope_field_getop", + "EnvelopeFieldGetNotFoundIssue": ".envelope_field_getop", + "EnvelopeFieldGetNotFoundIssueTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetRequest": ".envelope_field_getop", + "EnvelopeFieldGetRequestTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetResponse": ".envelope_field_getop", + "EnvelopeFieldGetResponseTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetTextAlign1": ".envelope_field_getop", + "EnvelopeFieldGetTextAlign2": ".envelope_field_getop", + "EnvelopeFieldGetTextAlign3": ".envelope_field_getop", + "EnvelopeFieldGetTextAlign4": ".envelope_field_getop", + "EnvelopeFieldGetTextAlign5": ".envelope_field_getop", + "EnvelopeFieldGetTextAlign6": ".envelope_field_getop", + "EnvelopeFieldGetType": ".envelope_field_getop", + "EnvelopeFieldGetTypeCheckbox": ".envelope_field_getop", + "EnvelopeFieldGetTypeDate": ".envelope_field_getop", + "EnvelopeFieldGetTypeDropdown": ".envelope_field_getop", + "EnvelopeFieldGetTypeEmail": ".envelope_field_getop", + "EnvelopeFieldGetTypeInitials": ".envelope_field_getop", + "EnvelopeFieldGetTypeName": ".envelope_field_getop", + "EnvelopeFieldGetTypeNumber": ".envelope_field_getop", + "EnvelopeFieldGetTypeRadio": ".envelope_field_getop", + "EnvelopeFieldGetTypeSignature": ".envelope_field_getop", + "EnvelopeFieldGetTypeText": ".envelope_field_getop", + "EnvelopeFieldGetUnauthorizedError": ".envelope_field_getop", + "EnvelopeFieldGetUnauthorizedErrorData": ".envelope_field_getop", + "EnvelopeFieldGetUnauthorizedIssue": ".envelope_field_getop", + "EnvelopeFieldGetUnauthorizedIssueTypedDict": ".envelope_field_getop", + "EnvelopeFieldGetValue1": ".envelope_field_getop", + "EnvelopeFieldGetValue1TypedDict": ".envelope_field_getop", + "EnvelopeFieldGetValue2": ".envelope_field_getop", + "EnvelopeFieldGetValue2TypedDict": ".envelope_field_getop", + "EnvelopeFieldGetValue3": ".envelope_field_getop", + "EnvelopeFieldGetValue3TypedDict": ".envelope_field_getop", + "EnvelopeFieldGetVerticalAlign1": ".envelope_field_getop", + "EnvelopeFieldGetVerticalAlign2": ".envelope_field_getop", + "EnvelopeFieldUpdateManyBadRequestError": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyBadRequestErrorData": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyBadRequestIssue": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyBadRequestIssueTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataCheckbox": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataCheckboxTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataDate": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataDateTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataDropdown": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataDropdownTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataEmail": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataEmailTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataFreeSignature": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataFreeSignatureTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataInitials": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataInitialsTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataName": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataNameTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataNumber": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataNumberTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataRadio": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataRadioTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataSignature": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataSignatureTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataText": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataTextTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataUnion": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDataUnionTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDirectionCheckbox": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDirectionRadio": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDirectionResponse1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyDirectionResponse2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaCheckboxRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaCheckboxRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaCheckboxResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaCheckboxResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaDateRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaDateRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaDateResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaDateResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaDropdownRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaDropdownRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaDropdownResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaDropdownResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaEmailRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaEmailRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaEmailResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaEmailResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaInitialsRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaInitialsRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaInitialsResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaInitialsResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaNameRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaNameRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaNameResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaNameResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaNumberRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaNumberRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaNumberResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaNumberResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaRadioRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaRadioRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaRadioResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaRadioResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaSignatureRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaSignatureRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaSignatureResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaSignatureResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTextRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTextRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTextResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTextResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTypeCheckbox": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTypeDate": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTypeDropdown": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTypeEmail": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTypeInitials": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTypeName": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTypeNumber": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTypeRadio": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTypeSignature": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaTypeText": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaUnion": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyFieldMetaUnionTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyForbiddenError": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyForbiddenErrorData": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyForbiddenIssue": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyForbiddenIssueTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyInternalServerError": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyInternalServerErrorData": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyInternalServerErrorIssue": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyInternalServerErrorIssueTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyRequest": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyRequestTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyResponseTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignDate": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignEmail": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignInitials": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignName": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignNumber": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignResponse1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignResponse2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignResponse3": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignResponse4": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignResponse5": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignResponse6": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTextAlignText": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeCheckboxRequest1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeCheckboxRequest2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeDateRequest1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeDateRequest2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeDropdownRequest1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeDropdownRequest2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeEmailRequest1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeEmailRequest2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeFreeSignature": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeInitialsRequest1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeInitialsRequest2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeNameRequest1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeNameRequest2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeNumberRequest1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeNumberRequest2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeRadioRequest1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeRadioRequest2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeResponse": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeSignatureRequest1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeSignatureRequest2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeTextRequest1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyTypeTextRequest2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyUnauthorizedError": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyUnauthorizedErrorData": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyUnauthorizedIssue": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyUnauthorizedIssueTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueCheckbox": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueCheckboxTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueDropdown": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueDropdownTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueRadio": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueRadioTypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueResponse1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueResponse1TypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueResponse2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueResponse2TypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueResponse3": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyValueResponse3TypedDict": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyVerticalAlignNumber": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyVerticalAlignResponse1": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyVerticalAlignResponse2": ".envelope_field_updatemanyop", + "EnvelopeFieldUpdateManyVerticalAlignText": ".envelope_field_updatemanyop", + "EnvelopeGetAccessAuth": ".envelope_getop", + "EnvelopeGetActionAuth": ".envelope_getop", + "EnvelopeGetAuthOptions": ".envelope_getop", + "EnvelopeGetAuthOptionsTypedDict": ".envelope_getop", + "EnvelopeGetBadRequestError": ".envelope_getop", + "EnvelopeGetBadRequestErrorData": ".envelope_getop", + "EnvelopeGetBadRequestIssue": ".envelope_getop", + "EnvelopeGetBadRequestIssueTypedDict": ".envelope_getop", + "EnvelopeGetDirectLink": ".envelope_getop", + "EnvelopeGetDirectLinkTypedDict": ".envelope_getop", + "EnvelopeGetDirection1": ".envelope_getop", + "EnvelopeGetDirection2": ".envelope_getop", + "EnvelopeGetDistributionMethod": ".envelope_getop", + "EnvelopeGetDocumentMeta": ".envelope_getop", + "EnvelopeGetDocumentMetaTypedDict": ".envelope_getop", + "EnvelopeGetEmailSettings": ".envelope_getop", + "EnvelopeGetEmailSettingsTypedDict": ".envelope_getop", + "EnvelopeGetEnvelopeItem": ".envelope_getop", + "EnvelopeGetEnvelopeItemTypedDict": ".envelope_getop", + "EnvelopeGetField": ".envelope_getop", + "EnvelopeGetFieldMetaCheckbox": ".envelope_getop", + "EnvelopeGetFieldMetaCheckboxTypedDict": ".envelope_getop", + "EnvelopeGetFieldMetaDate": ".envelope_getop", + "EnvelopeGetFieldMetaDateTypedDict": ".envelope_getop", + "EnvelopeGetFieldMetaDropdown": ".envelope_getop", + "EnvelopeGetFieldMetaDropdownTypedDict": ".envelope_getop", + "EnvelopeGetFieldMetaEmail": ".envelope_getop", + "EnvelopeGetFieldMetaEmailTypedDict": ".envelope_getop", + "EnvelopeGetFieldMetaInitials": ".envelope_getop", + "EnvelopeGetFieldMetaInitialsTypedDict": ".envelope_getop", + "EnvelopeGetFieldMetaName": ".envelope_getop", + "EnvelopeGetFieldMetaNameTypedDict": ".envelope_getop", + "EnvelopeGetFieldMetaNumber": ".envelope_getop", + "EnvelopeGetFieldMetaNumberTypedDict": ".envelope_getop", + "EnvelopeGetFieldMetaRadio": ".envelope_getop", + "EnvelopeGetFieldMetaRadioTypedDict": ".envelope_getop", + "EnvelopeGetFieldMetaSignature": ".envelope_getop", + "EnvelopeGetFieldMetaSignatureTypedDict": ".envelope_getop", + "EnvelopeGetFieldMetaText": ".envelope_getop", + "EnvelopeGetFieldMetaTextTypedDict": ".envelope_getop", + "EnvelopeGetFieldMetaUnion": ".envelope_getop", + "EnvelopeGetFieldMetaUnionTypedDict": ".envelope_getop", + "EnvelopeGetFieldType": ".envelope_getop", + "EnvelopeGetFieldTypedDict": ".envelope_getop", + "EnvelopeGetForbiddenError": ".envelope_getop", + "EnvelopeGetForbiddenErrorData": ".envelope_getop", + "EnvelopeGetForbiddenIssue": ".envelope_getop", + "EnvelopeGetForbiddenIssueTypedDict": ".envelope_getop", + "EnvelopeGetFormValues": ".envelope_getop", + "EnvelopeGetFormValuesTypedDict": ".envelope_getop", + "EnvelopeGetGlobalAccessAuth": ".envelope_getop", + "EnvelopeGetGlobalActionAuth": ".envelope_getop", + "EnvelopeGetInternalServerError": ".envelope_getop", + "EnvelopeGetInternalServerErrorData": ".envelope_getop", + "EnvelopeGetInternalServerErrorIssue": ".envelope_getop", + "EnvelopeGetInternalServerErrorIssueTypedDict": ".envelope_getop", + "EnvelopeGetNotFoundError": ".envelope_getop", + "EnvelopeGetNotFoundErrorData": ".envelope_getop", + "EnvelopeGetNotFoundIssue": ".envelope_getop", + "EnvelopeGetNotFoundIssueTypedDict": ".envelope_getop", + "EnvelopeGetReadStatus": ".envelope_getop", + "EnvelopeGetRecipient": ".envelope_getop", + "EnvelopeGetRecipientAuthOptions": ".envelope_getop", + "EnvelopeGetRecipientAuthOptionsTypedDict": ".envelope_getop", + "EnvelopeGetRecipientTypedDict": ".envelope_getop", + "EnvelopeGetRequest": ".envelope_getop", + "EnvelopeGetRequestTypedDict": ".envelope_getop", + "EnvelopeGetResponse": ".envelope_getop", + "EnvelopeGetResponseTypedDict": ".envelope_getop", + "EnvelopeGetRole": ".envelope_getop", + "EnvelopeGetSendStatus": ".envelope_getop", + "EnvelopeGetSigningOrder": ".envelope_getop", + "EnvelopeGetSigningStatus": ".envelope_getop", + "EnvelopeGetSource": ".envelope_getop", + "EnvelopeGetStatus": ".envelope_getop", + "EnvelopeGetTeam": ".envelope_getop", + "EnvelopeGetTeamTypedDict": ".envelope_getop", + "EnvelopeGetTemplateType": ".envelope_getop", + "EnvelopeGetTextAlign1": ".envelope_getop", + "EnvelopeGetTextAlign2": ".envelope_getop", + "EnvelopeGetTextAlign3": ".envelope_getop", + "EnvelopeGetTextAlign4": ".envelope_getop", + "EnvelopeGetTextAlign5": ".envelope_getop", + "EnvelopeGetTextAlign6": ".envelope_getop", + "EnvelopeGetType": ".envelope_getop", + "EnvelopeGetTypeCheckbox": ".envelope_getop", + "EnvelopeGetTypeDate": ".envelope_getop", + "EnvelopeGetTypeDropdown": ".envelope_getop", + "EnvelopeGetTypeEmail": ".envelope_getop", + "EnvelopeGetTypeInitials": ".envelope_getop", + "EnvelopeGetTypeName": ".envelope_getop", + "EnvelopeGetTypeNumber": ".envelope_getop", + "EnvelopeGetTypeRadio": ".envelope_getop", + "EnvelopeGetTypeSignature": ".envelope_getop", + "EnvelopeGetTypeText": ".envelope_getop", + "EnvelopeGetUnauthorizedError": ".envelope_getop", + "EnvelopeGetUnauthorizedErrorData": ".envelope_getop", + "EnvelopeGetUnauthorizedIssue": ".envelope_getop", + "EnvelopeGetUnauthorizedIssueTypedDict": ".envelope_getop", + "EnvelopeGetUser": ".envelope_getop", + "EnvelopeGetUserTypedDict": ".envelope_getop", + "EnvelopeGetValue1": ".envelope_getop", + "EnvelopeGetValue1TypedDict": ".envelope_getop", + "EnvelopeGetValue2": ".envelope_getop", + "EnvelopeGetValue2TypedDict": ".envelope_getop", + "EnvelopeGetValue3": ".envelope_getop", + "EnvelopeGetValue3TypedDict": ".envelope_getop", + "EnvelopeGetVerticalAlign1": ".envelope_getop", + "EnvelopeGetVerticalAlign2": ".envelope_getop", + "EnvelopeGetVisibility": ".envelope_getop", + "EnvelopeItemCreateManyBadRequestError": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyBadRequestErrorData": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyBadRequestIssue": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyBadRequestIssueTypedDict": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyData": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyDataTypedDict": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyFile": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyFileTypedDict": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyForbiddenError": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyForbiddenErrorData": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyForbiddenIssue": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyForbiddenIssueTypedDict": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyInternalServerError": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyInternalServerErrorData": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyInternalServerErrorIssue": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyInternalServerErrorIssueTypedDict": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyPayload": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyPayloadTypedDict": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyRequest": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyRequestTypedDict": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyResponse": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyResponseTypedDict": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyUnauthorizedError": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyUnauthorizedErrorData": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyUnauthorizedIssue": ".envelope_item_createmanyop", + "EnvelopeItemCreateManyUnauthorizedIssueTypedDict": ".envelope_item_createmanyop", + "EnvelopeItemDeleteBadRequestError": ".envelope_item_deleteop", + "EnvelopeItemDeleteBadRequestErrorData": ".envelope_item_deleteop", + "EnvelopeItemDeleteBadRequestIssue": ".envelope_item_deleteop", + "EnvelopeItemDeleteBadRequestIssueTypedDict": ".envelope_item_deleteop", + "EnvelopeItemDeleteForbiddenError": ".envelope_item_deleteop", + "EnvelopeItemDeleteForbiddenErrorData": ".envelope_item_deleteop", + "EnvelopeItemDeleteForbiddenIssue": ".envelope_item_deleteop", + "EnvelopeItemDeleteForbiddenIssueTypedDict": ".envelope_item_deleteop", + "EnvelopeItemDeleteInternalServerError": ".envelope_item_deleteop", + "EnvelopeItemDeleteInternalServerErrorData": ".envelope_item_deleteop", + "EnvelopeItemDeleteInternalServerErrorIssue": ".envelope_item_deleteop", + "EnvelopeItemDeleteInternalServerErrorIssueTypedDict": ".envelope_item_deleteop", + "EnvelopeItemDeleteRequest": ".envelope_item_deleteop", + "EnvelopeItemDeleteRequestTypedDict": ".envelope_item_deleteop", + "EnvelopeItemDeleteResponse": ".envelope_item_deleteop", + "EnvelopeItemDeleteResponseTypedDict": ".envelope_item_deleteop", + "EnvelopeItemDeleteUnauthorizedError": ".envelope_item_deleteop", + "EnvelopeItemDeleteUnauthorizedErrorData": ".envelope_item_deleteop", + "EnvelopeItemDeleteUnauthorizedIssue": ".envelope_item_deleteop", + "EnvelopeItemDeleteUnauthorizedIssueTypedDict": ".envelope_item_deleteop", + "EnvelopeItemDownloadBadRequestError": ".envelope_item_downloadop", + "EnvelopeItemDownloadBadRequestErrorData": ".envelope_item_downloadop", + "EnvelopeItemDownloadBadRequestIssue": ".envelope_item_downloadop", + "EnvelopeItemDownloadBadRequestIssueTypedDict": ".envelope_item_downloadop", + "EnvelopeItemDownloadForbiddenError": ".envelope_item_downloadop", + "EnvelopeItemDownloadForbiddenErrorData": ".envelope_item_downloadop", + "EnvelopeItemDownloadForbiddenIssue": ".envelope_item_downloadop", + "EnvelopeItemDownloadForbiddenIssueTypedDict": ".envelope_item_downloadop", + "EnvelopeItemDownloadInternalServerError": ".envelope_item_downloadop", + "EnvelopeItemDownloadInternalServerErrorData": ".envelope_item_downloadop", + "EnvelopeItemDownloadInternalServerErrorIssue": ".envelope_item_downloadop", + "EnvelopeItemDownloadInternalServerErrorIssueTypedDict": ".envelope_item_downloadop", + "EnvelopeItemDownloadNotFoundError": ".envelope_item_downloadop", + "EnvelopeItemDownloadNotFoundErrorData": ".envelope_item_downloadop", + "EnvelopeItemDownloadNotFoundIssue": ".envelope_item_downloadop", + "EnvelopeItemDownloadNotFoundIssueTypedDict": ".envelope_item_downloadop", + "EnvelopeItemDownloadRequest": ".envelope_item_downloadop", + "EnvelopeItemDownloadRequestTypedDict": ".envelope_item_downloadop", + "EnvelopeItemDownloadResponse": ".envelope_item_downloadop", + "EnvelopeItemDownloadResponseTypedDict": ".envelope_item_downloadop", + "EnvelopeItemDownloadUnauthorizedError": ".envelope_item_downloadop", + "EnvelopeItemDownloadUnauthorizedErrorData": ".envelope_item_downloadop", + "EnvelopeItemDownloadUnauthorizedIssue": ".envelope_item_downloadop", + "EnvelopeItemDownloadUnauthorizedIssueTypedDict": ".envelope_item_downloadop", + "EnvelopeItemDownloadVersion": ".envelope_item_downloadop", + "EnvelopeItemUpdateManyBadRequestError": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyBadRequestErrorData": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyBadRequestIssue": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyBadRequestIssueTypedDict": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyDataRequest": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyDataRequestTypedDict": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyDataResponse": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyDataResponseTypedDict": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyForbiddenError": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyForbiddenErrorData": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyForbiddenIssue": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyForbiddenIssueTypedDict": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyInternalServerError": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyInternalServerErrorData": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyInternalServerErrorIssue": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyInternalServerErrorIssueTypedDict": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyRequest": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyRequestTypedDict": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyResponse": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyResponseTypedDict": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyUnauthorizedError": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyUnauthorizedErrorData": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyUnauthorizedIssue": ".envelope_item_updatemanyop", + "EnvelopeItemUpdateManyUnauthorizedIssueTypedDict": ".envelope_item_updatemanyop", + "EnvelopeRecipientCreateManyAccessAuthRequest": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyAccessAuthResponse": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyActionAuthRequest": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyActionAuthResponse": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyAuthOptions": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyAuthOptionsTypedDict": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyBadRequestError": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyBadRequestErrorData": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyBadRequestIssue": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyBadRequestIssueTypedDict": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyDataRequest": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyDataRequestTypedDict": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyDataResponse": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyDataResponseTypedDict": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyForbiddenError": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyForbiddenErrorData": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyForbiddenIssue": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyForbiddenIssueTypedDict": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyInternalServerError": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyInternalServerErrorData": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyInternalServerErrorIssue": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyInternalServerErrorIssueTypedDict": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyReadStatus": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyRequest": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyRequestTypedDict": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyResponse": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyResponseTypedDict": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyRoleRequest": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyRoleResponse": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManySendStatus": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManySigningStatus": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyUnauthorizedError": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyUnauthorizedErrorData": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyUnauthorizedIssue": ".envelope_recipient_createmanyop", + "EnvelopeRecipientCreateManyUnauthorizedIssueTypedDict": ".envelope_recipient_createmanyop", + "EnvelopeRecipientDeleteBadRequestError": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteBadRequestErrorData": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteBadRequestIssue": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteBadRequestIssueTypedDict": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteForbiddenError": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteForbiddenErrorData": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteForbiddenIssue": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteForbiddenIssueTypedDict": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteInternalServerError": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteInternalServerErrorData": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteInternalServerErrorIssue": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteInternalServerErrorIssueTypedDict": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteRequest": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteRequestTypedDict": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteResponse": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteResponseTypedDict": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteUnauthorizedError": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteUnauthorizedErrorData": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteUnauthorizedIssue": ".envelope_recipient_deleteop", + "EnvelopeRecipientDeleteUnauthorizedIssueTypedDict": ".envelope_recipient_deleteop", + "EnvelopeRecipientGetAccessAuth": ".envelope_recipient_getop", + "EnvelopeRecipientGetActionAuth": ".envelope_recipient_getop", + "EnvelopeRecipientGetAuthOptions": ".envelope_recipient_getop", + "EnvelopeRecipientGetAuthOptionsTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetBadRequestError": ".envelope_recipient_getop", + "EnvelopeRecipientGetBadRequestErrorData": ".envelope_recipient_getop", + "EnvelopeRecipientGetBadRequestIssue": ".envelope_recipient_getop", + "EnvelopeRecipientGetBadRequestIssueTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetDirection1": ".envelope_recipient_getop", + "EnvelopeRecipientGetDirection2": ".envelope_recipient_getop", + "EnvelopeRecipientGetField": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaCheckbox": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaCheckboxTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaDate": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaDateTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaDropdown": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaDropdownTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaEmail": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaEmailTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaInitials": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaInitialsTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaName": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaNameTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaNumber": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaNumberTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaRadio": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaRadioTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaSignature": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaSignatureTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaText": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaTextTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaUnion": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldMetaUnionTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetFieldTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetForbiddenError": ".envelope_recipient_getop", + "EnvelopeRecipientGetForbiddenErrorData": ".envelope_recipient_getop", + "EnvelopeRecipientGetForbiddenIssue": ".envelope_recipient_getop", + "EnvelopeRecipientGetForbiddenIssueTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetInternalServerError": ".envelope_recipient_getop", + "EnvelopeRecipientGetInternalServerErrorData": ".envelope_recipient_getop", + "EnvelopeRecipientGetInternalServerErrorIssue": ".envelope_recipient_getop", + "EnvelopeRecipientGetInternalServerErrorIssueTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetNotFoundError": ".envelope_recipient_getop", + "EnvelopeRecipientGetNotFoundErrorData": ".envelope_recipient_getop", + "EnvelopeRecipientGetNotFoundIssue": ".envelope_recipient_getop", + "EnvelopeRecipientGetNotFoundIssueTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetReadStatus": ".envelope_recipient_getop", + "EnvelopeRecipientGetRequest": ".envelope_recipient_getop", + "EnvelopeRecipientGetRequestTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetResponse": ".envelope_recipient_getop", + "EnvelopeRecipientGetResponseTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetRole": ".envelope_recipient_getop", + "EnvelopeRecipientGetSendStatus": ".envelope_recipient_getop", + "EnvelopeRecipientGetSigningStatus": ".envelope_recipient_getop", + "EnvelopeRecipientGetTextAlign1": ".envelope_recipient_getop", + "EnvelopeRecipientGetTextAlign2": ".envelope_recipient_getop", + "EnvelopeRecipientGetTextAlign3": ".envelope_recipient_getop", + "EnvelopeRecipientGetTextAlign4": ".envelope_recipient_getop", + "EnvelopeRecipientGetTextAlign5": ".envelope_recipient_getop", + "EnvelopeRecipientGetTextAlign6": ".envelope_recipient_getop", + "EnvelopeRecipientGetType": ".envelope_recipient_getop", + "EnvelopeRecipientGetTypeCheckbox": ".envelope_recipient_getop", + "EnvelopeRecipientGetTypeDate": ".envelope_recipient_getop", + "EnvelopeRecipientGetTypeDropdown": ".envelope_recipient_getop", + "EnvelopeRecipientGetTypeEmail": ".envelope_recipient_getop", + "EnvelopeRecipientGetTypeInitials": ".envelope_recipient_getop", + "EnvelopeRecipientGetTypeName": ".envelope_recipient_getop", + "EnvelopeRecipientGetTypeNumber": ".envelope_recipient_getop", + "EnvelopeRecipientGetTypeRadio": ".envelope_recipient_getop", + "EnvelopeRecipientGetTypeSignature": ".envelope_recipient_getop", + "EnvelopeRecipientGetTypeText": ".envelope_recipient_getop", + "EnvelopeRecipientGetUnauthorizedError": ".envelope_recipient_getop", + "EnvelopeRecipientGetUnauthorizedErrorData": ".envelope_recipient_getop", + "EnvelopeRecipientGetUnauthorizedIssue": ".envelope_recipient_getop", + "EnvelopeRecipientGetUnauthorizedIssueTypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetValue1": ".envelope_recipient_getop", + "EnvelopeRecipientGetValue1TypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetValue2": ".envelope_recipient_getop", + "EnvelopeRecipientGetValue2TypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetValue3": ".envelope_recipient_getop", + "EnvelopeRecipientGetValue3TypedDict": ".envelope_recipient_getop", + "EnvelopeRecipientGetVerticalAlign1": ".envelope_recipient_getop", + "EnvelopeRecipientGetVerticalAlign2": ".envelope_recipient_getop", + "EnvelopeRecipientUpdateManyAccessAuthRequest": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyAccessAuthResponse": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyActionAuthRequest": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyActionAuthResponse": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyAuthOptions": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyAuthOptionsTypedDict": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyBadRequestError": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyBadRequestErrorData": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyBadRequestIssue": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyBadRequestIssueTypedDict": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyDataRequest": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyDataRequestTypedDict": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyDataResponse": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyDataResponseTypedDict": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyForbiddenError": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyForbiddenErrorData": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyForbiddenIssue": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyForbiddenIssueTypedDict": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyInternalServerError": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyInternalServerErrorData": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyInternalServerErrorIssue": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyInternalServerErrorIssueTypedDict": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyReadStatus": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyRequest": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyRequestTypedDict": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyResponse": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyResponseTypedDict": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyRoleRequest": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyRoleResponse": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManySendStatus": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManySigningStatus": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyUnauthorizedError": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyUnauthorizedErrorData": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyUnauthorizedIssue": ".envelope_recipient_updatemanyop", + "EnvelopeRecipientUpdateManyUnauthorizedIssueTypedDict": ".envelope_recipient_updatemanyop", + "EnvelopeRedistributeBadRequestError": ".envelope_redistributeop", + "EnvelopeRedistributeBadRequestErrorData": ".envelope_redistributeop", + "EnvelopeRedistributeBadRequestIssue": ".envelope_redistributeop", + "EnvelopeRedistributeBadRequestIssueTypedDict": ".envelope_redistributeop", + "EnvelopeRedistributeForbiddenError": ".envelope_redistributeop", + "EnvelopeRedistributeForbiddenErrorData": ".envelope_redistributeop", + "EnvelopeRedistributeForbiddenIssue": ".envelope_redistributeop", + "EnvelopeRedistributeForbiddenIssueTypedDict": ".envelope_redistributeop", + "EnvelopeRedistributeInternalServerError": ".envelope_redistributeop", + "EnvelopeRedistributeInternalServerErrorData": ".envelope_redistributeop", + "EnvelopeRedistributeInternalServerErrorIssue": ".envelope_redistributeop", + "EnvelopeRedistributeInternalServerErrorIssueTypedDict": ".envelope_redistributeop", + "EnvelopeRedistributeRequest": ".envelope_redistributeop", + "EnvelopeRedistributeRequestTypedDict": ".envelope_redistributeop", + "EnvelopeRedistributeResponse": ".envelope_redistributeop", + "EnvelopeRedistributeResponseTypedDict": ".envelope_redistributeop", + "EnvelopeRedistributeUnauthorizedError": ".envelope_redistributeop", + "EnvelopeRedistributeUnauthorizedErrorData": ".envelope_redistributeop", + "EnvelopeRedistributeUnauthorizedIssue": ".envelope_redistributeop", + "EnvelopeRedistributeUnauthorizedIssueTypedDict": ".envelope_redistributeop", + "EnvelopeUpdateAuthOptions": ".envelope_updateop", + "EnvelopeUpdateAuthOptionsTypedDict": ".envelope_updateop", + "EnvelopeUpdateBadRequestError": ".envelope_updateop", + "EnvelopeUpdateBadRequestErrorData": ".envelope_updateop", + "EnvelopeUpdateBadRequestIssue": ".envelope_updateop", + "EnvelopeUpdateBadRequestIssueTypedDict": ".envelope_updateop", + "EnvelopeUpdateData": ".envelope_updateop", + "EnvelopeUpdateDataGlobalAccessAuth": ".envelope_updateop", + "EnvelopeUpdateDataGlobalActionAuth": ".envelope_updateop", + "EnvelopeUpdateDataTypedDict": ".envelope_updateop", + "EnvelopeUpdateDataVisibility": ".envelope_updateop", + "EnvelopeUpdateDateFormat": ".envelope_updateop", + "EnvelopeUpdateDistributionMethod": ".envelope_updateop", + "EnvelopeUpdateEmailSettings": ".envelope_updateop", + "EnvelopeUpdateEmailSettingsTypedDict": ".envelope_updateop", + "EnvelopeUpdateForbiddenError": ".envelope_updateop", + "EnvelopeUpdateForbiddenErrorData": ".envelope_updateop", + "EnvelopeUpdateForbiddenIssue": ".envelope_updateop", + "EnvelopeUpdateForbiddenIssueTypedDict": ".envelope_updateop", + "EnvelopeUpdateFormValues": ".envelope_updateop", + "EnvelopeUpdateFormValuesTypedDict": ".envelope_updateop", + "EnvelopeUpdateGlobalAccessAuthResponse": ".envelope_updateop", + "EnvelopeUpdateGlobalActionAuthResponse": ".envelope_updateop", + "EnvelopeUpdateInternalServerError": ".envelope_updateop", + "EnvelopeUpdateInternalServerErrorData": ".envelope_updateop", + "EnvelopeUpdateInternalServerErrorIssue": ".envelope_updateop", + "EnvelopeUpdateInternalServerErrorIssueTypedDict": ".envelope_updateop", + "EnvelopeUpdateLanguage": ".envelope_updateop", + "EnvelopeUpdateMeta": ".envelope_updateop", + "EnvelopeUpdateMetaTypedDict": ".envelope_updateop", + "EnvelopeUpdateRequest": ".envelope_updateop", + "EnvelopeUpdateRequestTypedDict": ".envelope_updateop", + "EnvelopeUpdateResponse": ".envelope_updateop", + "EnvelopeUpdateResponseTypedDict": ".envelope_updateop", + "EnvelopeUpdateSigningOrder": ".envelope_updateop", + "EnvelopeUpdateSource": ".envelope_updateop", + "EnvelopeUpdateStatus": ".envelope_updateop", + "EnvelopeUpdateTemplateType": ".envelope_updateop", + "EnvelopeUpdateType": ".envelope_updateop", + "EnvelopeUpdateUnauthorizedError": ".envelope_updateop", + "EnvelopeUpdateUnauthorizedErrorData": ".envelope_updateop", + "EnvelopeUpdateUnauthorizedIssue": ".envelope_updateop", + "EnvelopeUpdateUnauthorizedIssueTypedDict": ".envelope_updateop", + "EnvelopeUpdateVisibilityResponse": ".envelope_updateop", + "EnvelopeUseAttachment": ".envelope_useop", + "EnvelopeUseAttachmentTypedDict": ".envelope_useop", + "EnvelopeUseBadRequestError": ".envelope_useop", + "EnvelopeUseBadRequestErrorData": ".envelope_useop", + "EnvelopeUseBadRequestIssue": ".envelope_useop", + "EnvelopeUseBadRequestIssueTypedDict": ".envelope_useop", + "EnvelopeUseCustomDocumentDatum": ".envelope_useop", + "EnvelopeUseCustomDocumentDatumTypedDict": ".envelope_useop", + "EnvelopeUseDateFormat": ".envelope_useop", + "EnvelopeUseDistributionMethod": ".envelope_useop", + "EnvelopeUseEmailSettings": ".envelope_useop", + "EnvelopeUseEmailSettingsTypedDict": ".envelope_useop", + "EnvelopeUseFile": ".envelope_useop", + "EnvelopeUseFileTypedDict": ".envelope_useop", + "EnvelopeUseForbiddenError": ".envelope_useop", + "EnvelopeUseForbiddenErrorData": ".envelope_useop", + "EnvelopeUseForbiddenIssue": ".envelope_useop", + "EnvelopeUseForbiddenIssueTypedDict": ".envelope_useop", + "EnvelopeUseIdentifier": ".envelope_useop", + "EnvelopeUseIdentifierTypedDict": ".envelope_useop", + "EnvelopeUseInternalServerError": ".envelope_useop", + "EnvelopeUseInternalServerErrorData": ".envelope_useop", + "EnvelopeUseInternalServerErrorIssue": ".envelope_useop", + "EnvelopeUseInternalServerErrorIssueTypedDict": ".envelope_useop", + "EnvelopeUseLanguage": ".envelope_useop", + "EnvelopeUsePayload": ".envelope_useop", + "EnvelopeUsePayloadTypedDict": ".envelope_useop", + "EnvelopeUsePrefillFieldCheckbox": ".envelope_useop", + "EnvelopeUsePrefillFieldCheckboxTypedDict": ".envelope_useop", + "EnvelopeUsePrefillFieldDate": ".envelope_useop", + "EnvelopeUsePrefillFieldDateTypedDict": ".envelope_useop", + "EnvelopeUsePrefillFieldDropdown": ".envelope_useop", + "EnvelopeUsePrefillFieldDropdownTypedDict": ".envelope_useop", + "EnvelopeUsePrefillFieldNumber": ".envelope_useop", + "EnvelopeUsePrefillFieldNumberTypedDict": ".envelope_useop", + "EnvelopeUsePrefillFieldRadio": ".envelope_useop", + "EnvelopeUsePrefillFieldRadioTypedDict": ".envelope_useop", + "EnvelopeUsePrefillFieldText": ".envelope_useop", + "EnvelopeUsePrefillFieldTextTypedDict": ".envelope_useop", + "EnvelopeUsePrefillFieldUnion": ".envelope_useop", + "EnvelopeUsePrefillFieldUnionTypedDict": ".envelope_useop", + "EnvelopeUseRecipient": ".envelope_useop", + "EnvelopeUseRecipientTypedDict": ".envelope_useop", + "EnvelopeUseRequest": ".envelope_useop", + "EnvelopeUseRequestTypedDict": ".envelope_useop", + "EnvelopeUseResponse": ".envelope_useop", + "EnvelopeUseResponseTypedDict": ".envelope_useop", + "EnvelopeUseTypeCheckbox": ".envelope_useop", + "EnvelopeUseTypeDate": ".envelope_useop", + "EnvelopeUseTypeDropdown": ".envelope_useop", + "EnvelopeUseTypeLink": ".envelope_useop", + "EnvelopeUseTypeNumber": ".envelope_useop", + "EnvelopeUseTypeRadio": ".envelope_useop", + "EnvelopeUseTypeText": ".envelope_useop", + "EnvelopeUseUnauthorizedError": ".envelope_useop", + "EnvelopeUseUnauthorizedErrorData": ".envelope_useop", + "EnvelopeUseUnauthorizedIssue": ".envelope_useop", + "EnvelopeUseUnauthorizedIssueTypedDict": ".envelope_useop", + "Override": ".envelope_useop", + "OverrideTypedDict": ".envelope_useop", "FieldCreateDocumentFieldBadRequestError": ".field_createdocumentfieldop", "FieldCreateDocumentFieldBadRequestErrorData": ".field_createdocumentfieldop", "FieldCreateDocumentFieldBadRequestIssue": ".field_createdocumentfieldop", "FieldCreateDocumentFieldBadRequestIssueTypedDict": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldDirectionCheckbox": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldDirectionRadio": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldDirectionResponse1": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldDirectionResponse2": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldCheckbox": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldCheckboxTypedDict": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldDate": ".field_createdocumentfieldop", @@ -5688,6 +11945,10 @@ "FieldCreateDocumentFieldFieldMetaRadioRequestTypedDict": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldMetaRadioResponse": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldMetaRadioResponseTypedDict": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldFieldMetaSignatureRequest": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldFieldMetaSignatureRequestTypedDict": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldFieldMetaSignatureResponse": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldFieldMetaSignatureResponseTypedDict": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldMetaTextRequest": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldMetaTextRequestTypedDict": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldMetaTextResponse": ".field_createdocumentfieldop", @@ -5700,6 +11961,7 @@ "FieldCreateDocumentFieldFieldMetaTypeName": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldMetaTypeNumber": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldMetaTypeRadio": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldFieldMetaTypeSignature": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldMetaTypeText": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldMetaUnion": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldMetaUnionTypedDict": ".field_createdocumentfieldop", @@ -5715,6 +11977,10 @@ "FieldCreateDocumentFieldFieldTextTypedDict": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldUnion": ".field_createdocumentfieldop", "FieldCreateDocumentFieldFieldUnionTypedDict": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldForbiddenError": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldForbiddenErrorData": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldForbiddenIssue": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldForbiddenIssueTypedDict": ".field_createdocumentfieldop", "FieldCreateDocumentFieldInternalServerError": ".field_createdocumentfieldop", "FieldCreateDocumentFieldInternalServerErrorData": ".field_createdocumentfieldop", "FieldCreateDocumentFieldInternalServerErrorIssue": ".field_createdocumentfieldop", @@ -5753,9 +12019,14 @@ "FieldCreateDocumentFieldTypeRadioRequest1": ".field_createdocumentfieldop", "FieldCreateDocumentFieldTypeRadioRequest2": ".field_createdocumentfieldop", "FieldCreateDocumentFieldTypeResponse": ".field_createdocumentfieldop", - "FieldCreateDocumentFieldTypeSignature": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldTypeSignatureRequest1": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldTypeSignatureRequest2": ".field_createdocumentfieldop", "FieldCreateDocumentFieldTypeTextRequest1": ".field_createdocumentfieldop", "FieldCreateDocumentFieldTypeTextRequest2": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldUnauthorizedError": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldUnauthorizedErrorData": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldUnauthorizedIssue": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldUnauthorizedIssueTypedDict": ".field_createdocumentfieldop", "FieldCreateDocumentFieldValueCheckbox": ".field_createdocumentfieldop", "FieldCreateDocumentFieldValueCheckboxTypedDict": ".field_createdocumentfieldop", "FieldCreateDocumentFieldValueDropdown": ".field_createdocumentfieldop", @@ -5768,10 +12039,18 @@ "FieldCreateDocumentFieldValueResponse2TypedDict": ".field_createdocumentfieldop", "FieldCreateDocumentFieldValueResponse3": ".field_createdocumentfieldop", "FieldCreateDocumentFieldValueResponse3TypedDict": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldVerticalAlignNumber": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldVerticalAlignResponse1": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldVerticalAlignResponse2": ".field_createdocumentfieldop", + "FieldCreateDocumentFieldVerticalAlignText": ".field_createdocumentfieldop", "FieldCreateDocumentFieldsBadRequestError": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsBadRequestErrorData": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsBadRequestIssue": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsBadRequestIssueTypedDict": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsDirectionCheckbox": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsDirectionRadio": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsDirectionResponse1": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsDirectionResponse2": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldCheckbox": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldCheckboxTypedDict": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldDate": ".field_createdocumentfieldsop", @@ -5816,6 +12095,10 @@ "FieldCreateDocumentFieldsFieldMetaRadioRequestTypedDict": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldMetaRadioResponse": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldMetaRadioResponseTypedDict": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsFieldMetaSignatureRequest": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsFieldMetaSignatureRequestTypedDict": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsFieldMetaSignatureResponse": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsFieldMetaSignatureResponseTypedDict": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldMetaTextRequest": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldMetaTextRequestTypedDict": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldMetaTextResponse": ".field_createdocumentfieldsop", @@ -5828,6 +12111,7 @@ "FieldCreateDocumentFieldsFieldMetaTypeName": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldMetaTypeNumber": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldMetaTypeRadio": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsFieldMetaTypeSignature": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldMetaTypeText": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldMetaUnion": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldMetaUnionTypedDict": ".field_createdocumentfieldsop", @@ -5845,6 +12129,10 @@ "FieldCreateDocumentFieldsFieldTextTypedDict": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldUnion": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsFieldUnionTypedDict": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsForbiddenError": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsForbiddenErrorData": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsForbiddenIssue": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsForbiddenIssueTypedDict": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsInternalServerError": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsInternalServerErrorData": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsInternalServerErrorIssue": ".field_createdocumentfieldsop", @@ -5883,9 +12171,14 @@ "FieldCreateDocumentFieldsTypeRadioRequest1": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsTypeRadioRequest2": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsTypeResponse": ".field_createdocumentfieldsop", - "FieldCreateDocumentFieldsTypeSignature": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsTypeSignatureRequest1": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsTypeSignatureRequest2": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsTypeTextRequest1": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsTypeTextRequest2": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsUnauthorizedError": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsUnauthorizedErrorData": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsUnauthorizedIssue": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsUnauthorizedIssueTypedDict": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsValueCheckbox": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsValueCheckboxTypedDict": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsValueDropdown": ".field_createdocumentfieldsop", @@ -5898,10 +12191,18 @@ "FieldCreateDocumentFieldsValueResponse2TypedDict": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsValueResponse3": ".field_createdocumentfieldsop", "FieldCreateDocumentFieldsValueResponse3TypedDict": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsVerticalAlignNumber": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsVerticalAlignResponse1": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsVerticalAlignResponse2": ".field_createdocumentfieldsop", + "FieldCreateDocumentFieldsVerticalAlignText": ".field_createdocumentfieldsop", "FieldCreateTemplateFieldBadRequestError": ".field_createtemplatefieldop", "FieldCreateTemplateFieldBadRequestErrorData": ".field_createtemplatefieldop", "FieldCreateTemplateFieldBadRequestIssue": ".field_createtemplatefieldop", "FieldCreateTemplateFieldBadRequestIssueTypedDict": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldDirectionCheckbox": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldDirectionRadio": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldDirectionResponse1": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldDirectionResponse2": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldCheckbox": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldCheckboxTypedDict": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldDate": ".field_createtemplatefieldop", @@ -5946,6 +12247,10 @@ "FieldCreateTemplateFieldFieldMetaRadioRequestTypedDict": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldMetaRadioResponse": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldMetaRadioResponseTypedDict": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldFieldMetaSignatureRequest": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldFieldMetaSignatureRequestTypedDict": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldFieldMetaSignatureResponse": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldFieldMetaSignatureResponseTypedDict": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldMetaTextRequest": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldMetaTextRequestTypedDict": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldMetaTextResponse": ".field_createtemplatefieldop", @@ -5958,6 +12263,7 @@ "FieldCreateTemplateFieldFieldMetaTypeName": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldMetaTypeNumber": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldMetaTypeRadio": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldFieldMetaTypeSignature": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldMetaTypeText": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldMetaUnion": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldMetaUnionTypedDict": ".field_createtemplatefieldop", @@ -5973,6 +12279,10 @@ "FieldCreateTemplateFieldFieldTextTypedDict": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldUnion": ".field_createtemplatefieldop", "FieldCreateTemplateFieldFieldUnionTypedDict": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldForbiddenError": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldForbiddenErrorData": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldForbiddenIssue": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldForbiddenIssueTypedDict": ".field_createtemplatefieldop", "FieldCreateTemplateFieldInternalServerError": ".field_createtemplatefieldop", "FieldCreateTemplateFieldInternalServerErrorData": ".field_createtemplatefieldop", "FieldCreateTemplateFieldInternalServerErrorIssue": ".field_createtemplatefieldop", @@ -6011,9 +12321,14 @@ "FieldCreateTemplateFieldTypeRadioRequest1": ".field_createtemplatefieldop", "FieldCreateTemplateFieldTypeRadioRequest2": ".field_createtemplatefieldop", "FieldCreateTemplateFieldTypeResponse": ".field_createtemplatefieldop", - "FieldCreateTemplateFieldTypeSignature": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldTypeSignatureRequest1": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldTypeSignatureRequest2": ".field_createtemplatefieldop", "FieldCreateTemplateFieldTypeTextRequest1": ".field_createtemplatefieldop", "FieldCreateTemplateFieldTypeTextRequest2": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldUnauthorizedError": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldUnauthorizedErrorData": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldUnauthorizedIssue": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldUnauthorizedIssueTypedDict": ".field_createtemplatefieldop", "FieldCreateTemplateFieldValueCheckbox": ".field_createtemplatefieldop", "FieldCreateTemplateFieldValueCheckboxTypedDict": ".field_createtemplatefieldop", "FieldCreateTemplateFieldValueDropdown": ".field_createtemplatefieldop", @@ -6026,10 +12341,18 @@ "FieldCreateTemplateFieldValueResponse2TypedDict": ".field_createtemplatefieldop", "FieldCreateTemplateFieldValueResponse3": ".field_createtemplatefieldop", "FieldCreateTemplateFieldValueResponse3TypedDict": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldVerticalAlignNumber": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldVerticalAlignResponse1": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldVerticalAlignResponse2": ".field_createtemplatefieldop", + "FieldCreateTemplateFieldVerticalAlignText": ".field_createtemplatefieldop", "FieldCreateTemplateFieldsBadRequestError": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsBadRequestErrorData": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsBadRequestIssue": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsBadRequestIssueTypedDict": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsDirectionCheckbox": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsDirectionRadio": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsDirectionResponse1": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsDirectionResponse2": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldCheckbox": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldCheckboxTypedDict": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldDate": ".field_createtemplatefieldsop", @@ -6074,6 +12397,10 @@ "FieldCreateTemplateFieldsFieldMetaRadioRequestTypedDict": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldMetaRadioResponse": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldMetaRadioResponseTypedDict": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsFieldMetaSignatureRequest": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsFieldMetaSignatureRequestTypedDict": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsFieldMetaSignatureResponse": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsFieldMetaSignatureResponseTypedDict": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldMetaTextRequest": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldMetaTextRequestTypedDict": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldMetaTextResponse": ".field_createtemplatefieldsop", @@ -6086,6 +12413,7 @@ "FieldCreateTemplateFieldsFieldMetaTypeName": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldMetaTypeNumber": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldMetaTypeRadio": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsFieldMetaTypeSignature": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldMetaTypeText": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldMetaUnion": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldMetaUnionTypedDict": ".field_createtemplatefieldsop", @@ -6103,6 +12431,10 @@ "FieldCreateTemplateFieldsFieldTextTypedDict": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldUnion": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsFieldUnionTypedDict": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsForbiddenError": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsForbiddenErrorData": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsForbiddenIssue": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsForbiddenIssueTypedDict": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsInternalServerError": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsInternalServerErrorData": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsInternalServerErrorIssue": ".field_createtemplatefieldsop", @@ -6141,9 +12473,14 @@ "FieldCreateTemplateFieldsTypeRadioRequest1": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsTypeRadioRequest2": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsTypeResponse": ".field_createtemplatefieldsop", - "FieldCreateTemplateFieldsTypeSignature": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsTypeSignatureRequest1": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsTypeSignatureRequest2": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsTypeTextRequest1": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsTypeTextRequest2": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsUnauthorizedError": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsUnauthorizedErrorData": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsUnauthorizedIssue": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsUnauthorizedIssueTypedDict": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsValueCheckbox": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsValueCheckboxTypedDict": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsValueDropdown": ".field_createtemplatefieldsop", @@ -6156,10 +12493,18 @@ "FieldCreateTemplateFieldsValueResponse2TypedDict": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsValueResponse3": ".field_createtemplatefieldsop", "FieldCreateTemplateFieldsValueResponse3TypedDict": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsVerticalAlignNumber": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsVerticalAlignResponse1": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsVerticalAlignResponse2": ".field_createtemplatefieldsop", + "FieldCreateTemplateFieldsVerticalAlignText": ".field_createtemplatefieldsop", "FieldDeleteDocumentFieldBadRequestError": ".field_deletedocumentfieldop", "FieldDeleteDocumentFieldBadRequestErrorData": ".field_deletedocumentfieldop", "FieldDeleteDocumentFieldBadRequestIssue": ".field_deletedocumentfieldop", "FieldDeleteDocumentFieldBadRequestIssueTypedDict": ".field_deletedocumentfieldop", + "FieldDeleteDocumentFieldForbiddenError": ".field_deletedocumentfieldop", + "FieldDeleteDocumentFieldForbiddenErrorData": ".field_deletedocumentfieldop", + "FieldDeleteDocumentFieldForbiddenIssue": ".field_deletedocumentfieldop", + "FieldDeleteDocumentFieldForbiddenIssueTypedDict": ".field_deletedocumentfieldop", "FieldDeleteDocumentFieldInternalServerError": ".field_deletedocumentfieldop", "FieldDeleteDocumentFieldInternalServerErrorData": ".field_deletedocumentfieldop", "FieldDeleteDocumentFieldInternalServerErrorIssue": ".field_deletedocumentfieldop", @@ -6168,10 +12513,18 @@ "FieldDeleteDocumentFieldRequestTypedDict": ".field_deletedocumentfieldop", "FieldDeleteDocumentFieldResponse": ".field_deletedocumentfieldop", "FieldDeleteDocumentFieldResponseTypedDict": ".field_deletedocumentfieldop", + "FieldDeleteDocumentFieldUnauthorizedError": ".field_deletedocumentfieldop", + "FieldDeleteDocumentFieldUnauthorizedErrorData": ".field_deletedocumentfieldop", + "FieldDeleteDocumentFieldUnauthorizedIssue": ".field_deletedocumentfieldop", + "FieldDeleteDocumentFieldUnauthorizedIssueTypedDict": ".field_deletedocumentfieldop", "FieldDeleteTemplateFieldBadRequestError": ".field_deletetemplatefieldop", "FieldDeleteTemplateFieldBadRequestErrorData": ".field_deletetemplatefieldop", "FieldDeleteTemplateFieldBadRequestIssue": ".field_deletetemplatefieldop", "FieldDeleteTemplateFieldBadRequestIssueTypedDict": ".field_deletetemplatefieldop", + "FieldDeleteTemplateFieldForbiddenError": ".field_deletetemplatefieldop", + "FieldDeleteTemplateFieldForbiddenErrorData": ".field_deletetemplatefieldop", + "FieldDeleteTemplateFieldForbiddenIssue": ".field_deletetemplatefieldop", + "FieldDeleteTemplateFieldForbiddenIssueTypedDict": ".field_deletetemplatefieldop", "FieldDeleteTemplateFieldInternalServerError": ".field_deletetemplatefieldop", "FieldDeleteTemplateFieldInternalServerErrorData": ".field_deletetemplatefieldop", "FieldDeleteTemplateFieldInternalServerErrorIssue": ".field_deletetemplatefieldop", @@ -6180,10 +12533,16 @@ "FieldDeleteTemplateFieldRequestTypedDict": ".field_deletetemplatefieldop", "FieldDeleteTemplateFieldResponse": ".field_deletetemplatefieldop", "FieldDeleteTemplateFieldResponseTypedDict": ".field_deletetemplatefieldop", + "FieldDeleteTemplateFieldUnauthorizedError": ".field_deletetemplatefieldop", + "FieldDeleteTemplateFieldUnauthorizedErrorData": ".field_deletetemplatefieldop", + "FieldDeleteTemplateFieldUnauthorizedIssue": ".field_deletetemplatefieldop", + "FieldDeleteTemplateFieldUnauthorizedIssueTypedDict": ".field_deletetemplatefieldop", "FieldGetDocumentFieldBadRequestError": ".field_getdocumentfieldop", "FieldGetDocumentFieldBadRequestErrorData": ".field_getdocumentfieldop", "FieldGetDocumentFieldBadRequestIssue": ".field_getdocumentfieldop", "FieldGetDocumentFieldBadRequestIssueTypedDict": ".field_getdocumentfieldop", + "FieldGetDocumentFieldDirection1": ".field_getdocumentfieldop", + "FieldGetDocumentFieldDirection2": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaCheckbox": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaCheckboxTypedDict": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaDate": ".field_getdocumentfieldop", @@ -6200,10 +12559,16 @@ "FieldGetDocumentFieldFieldMetaNumberTypedDict": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaRadio": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaRadioTypedDict": ".field_getdocumentfieldop", + "FieldGetDocumentFieldFieldMetaSignature": ".field_getdocumentfieldop", + "FieldGetDocumentFieldFieldMetaSignatureTypedDict": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaText": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaTextTypedDict": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaUnion": ".field_getdocumentfieldop", "FieldGetDocumentFieldFieldMetaUnionTypedDict": ".field_getdocumentfieldop", + "FieldGetDocumentFieldForbiddenError": ".field_getdocumentfieldop", + "FieldGetDocumentFieldForbiddenErrorData": ".field_getdocumentfieldop", + "FieldGetDocumentFieldForbiddenIssue": ".field_getdocumentfieldop", + "FieldGetDocumentFieldForbiddenIssueTypedDict": ".field_getdocumentfieldop", "FieldGetDocumentFieldInternalServerError": ".field_getdocumentfieldop", "FieldGetDocumentFieldInternalServerErrorData": ".field_getdocumentfieldop", "FieldGetDocumentFieldInternalServerErrorIssue": ".field_getdocumentfieldop", @@ -6231,17 +12596,26 @@ "FieldGetDocumentFieldTypeName": ".field_getdocumentfieldop", "FieldGetDocumentFieldTypeNumber": ".field_getdocumentfieldop", "FieldGetDocumentFieldTypeRadio": ".field_getdocumentfieldop", + "FieldGetDocumentFieldTypeSignature": ".field_getdocumentfieldop", "FieldGetDocumentFieldTypeText": ".field_getdocumentfieldop", + "FieldGetDocumentFieldUnauthorizedError": ".field_getdocumentfieldop", + "FieldGetDocumentFieldUnauthorizedErrorData": ".field_getdocumentfieldop", + "FieldGetDocumentFieldUnauthorizedIssue": ".field_getdocumentfieldop", + "FieldGetDocumentFieldUnauthorizedIssueTypedDict": ".field_getdocumentfieldop", "FieldGetDocumentFieldValue1": ".field_getdocumentfieldop", "FieldGetDocumentFieldValue1TypedDict": ".field_getdocumentfieldop", "FieldGetDocumentFieldValue2": ".field_getdocumentfieldop", "FieldGetDocumentFieldValue2TypedDict": ".field_getdocumentfieldop", "FieldGetDocumentFieldValue3": ".field_getdocumentfieldop", "FieldGetDocumentFieldValue3TypedDict": ".field_getdocumentfieldop", + "FieldGetDocumentFieldVerticalAlign1": ".field_getdocumentfieldop", + "FieldGetDocumentFieldVerticalAlign2": ".field_getdocumentfieldop", "FieldGetTemplateFieldBadRequestError": ".field_gettemplatefieldop", "FieldGetTemplateFieldBadRequestErrorData": ".field_gettemplatefieldop", "FieldGetTemplateFieldBadRequestIssue": ".field_gettemplatefieldop", "FieldGetTemplateFieldBadRequestIssueTypedDict": ".field_gettemplatefieldop", + "FieldGetTemplateFieldDirection1": ".field_gettemplatefieldop", + "FieldGetTemplateFieldDirection2": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaCheckbox": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaCheckboxTypedDict": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaDate": ".field_gettemplatefieldop", @@ -6258,10 +12632,16 @@ "FieldGetTemplateFieldFieldMetaNumberTypedDict": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaRadio": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaRadioTypedDict": ".field_gettemplatefieldop", + "FieldGetTemplateFieldFieldMetaSignature": ".field_gettemplatefieldop", + "FieldGetTemplateFieldFieldMetaSignatureTypedDict": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaText": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaTextTypedDict": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaUnion": ".field_gettemplatefieldop", "FieldGetTemplateFieldFieldMetaUnionTypedDict": ".field_gettemplatefieldop", + "FieldGetTemplateFieldForbiddenError": ".field_gettemplatefieldop", + "FieldGetTemplateFieldForbiddenErrorData": ".field_gettemplatefieldop", + "FieldGetTemplateFieldForbiddenIssue": ".field_gettemplatefieldop", + "FieldGetTemplateFieldForbiddenIssueTypedDict": ".field_gettemplatefieldop", "FieldGetTemplateFieldInternalServerError": ".field_gettemplatefieldop", "FieldGetTemplateFieldInternalServerErrorData": ".field_gettemplatefieldop", "FieldGetTemplateFieldInternalServerErrorIssue": ".field_gettemplatefieldop", @@ -6289,17 +12669,28 @@ "FieldGetTemplateFieldTypeName": ".field_gettemplatefieldop", "FieldGetTemplateFieldTypeNumber": ".field_gettemplatefieldop", "FieldGetTemplateFieldTypeRadio": ".field_gettemplatefieldop", + "FieldGetTemplateFieldTypeSignature": ".field_gettemplatefieldop", "FieldGetTemplateFieldTypeText": ".field_gettemplatefieldop", + "FieldGetTemplateFieldUnauthorizedError": ".field_gettemplatefieldop", + "FieldGetTemplateFieldUnauthorizedErrorData": ".field_gettemplatefieldop", + "FieldGetTemplateFieldUnauthorizedIssue": ".field_gettemplatefieldop", + "FieldGetTemplateFieldUnauthorizedIssueTypedDict": ".field_gettemplatefieldop", "FieldGetTemplateFieldValue1": ".field_gettemplatefieldop", "FieldGetTemplateFieldValue1TypedDict": ".field_gettemplatefieldop", "FieldGetTemplateFieldValue2": ".field_gettemplatefieldop", "FieldGetTemplateFieldValue2TypedDict": ".field_gettemplatefieldop", "FieldGetTemplateFieldValue3": ".field_gettemplatefieldop", "FieldGetTemplateFieldValue3TypedDict": ".field_gettemplatefieldop", + "FieldGetTemplateFieldVerticalAlign1": ".field_gettemplatefieldop", + "FieldGetTemplateFieldVerticalAlign2": ".field_gettemplatefieldop", "FieldUpdateDocumentFieldBadRequestError": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldBadRequestErrorData": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldBadRequestIssue": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldBadRequestIssueTypedDict": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldDirectionCheckbox": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldDirectionRadio": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldDirectionResponse1": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldDirectionResponse2": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldCheckbox": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldCheckboxTypedDict": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldDate": ".field_updatedocumentfieldop", @@ -6344,6 +12735,10 @@ "FieldUpdateDocumentFieldFieldMetaRadioRequestTypedDict": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldMetaRadioResponse": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldMetaRadioResponseTypedDict": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldFieldMetaSignatureRequest": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldFieldMetaSignatureRequestTypedDict": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldFieldMetaSignatureResponse": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldFieldMetaSignatureResponseTypedDict": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldMetaTextRequest": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldMetaTextRequestTypedDict": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldMetaTextResponse": ".field_updatedocumentfieldop", @@ -6356,6 +12751,7 @@ "FieldUpdateDocumentFieldFieldMetaTypeName": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldMetaTypeNumber": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldMetaTypeRadio": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldFieldMetaTypeSignature": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldMetaTypeText": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldMetaUnion": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldMetaUnionTypedDict": ".field_updatedocumentfieldop", @@ -6371,6 +12767,10 @@ "FieldUpdateDocumentFieldFieldTextTypedDict": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldUnion": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldFieldUnionTypedDict": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldForbiddenError": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldForbiddenErrorData": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldForbiddenIssue": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldForbiddenIssueTypedDict": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldInternalServerError": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldInternalServerErrorData": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldInternalServerErrorIssue": ".field_updatedocumentfieldop", @@ -6409,9 +12809,14 @@ "FieldUpdateDocumentFieldTypeRadioRequest1": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldTypeRadioRequest2": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldTypeResponse": ".field_updatedocumentfieldop", - "FieldUpdateDocumentFieldTypeSignature": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldTypeSignatureRequest1": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldTypeSignatureRequest2": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldTypeTextRequest1": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldTypeTextRequest2": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldUnauthorizedError": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldUnauthorizedErrorData": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldUnauthorizedIssue": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldUnauthorizedIssueTypedDict": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldValueCheckbox": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldValueCheckboxTypedDict": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldValueDropdown": ".field_updatedocumentfieldop", @@ -6424,10 +12829,18 @@ "FieldUpdateDocumentFieldValueResponse2TypedDict": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldValueResponse3": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldValueResponse3TypedDict": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldVerticalAlignNumber": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldVerticalAlignResponse1": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldVerticalAlignResponse2": ".field_updatedocumentfieldop", + "FieldUpdateDocumentFieldVerticalAlignText": ".field_updatedocumentfieldop", "FieldUpdateDocumentFieldsBadRequestError": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsBadRequestErrorData": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsBadRequestIssue": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsBadRequestIssueTypedDict": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsDirectionCheckbox": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsDirectionRadio": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsDirectionResponse1": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsDirectionResponse2": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldCheckbox": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldCheckboxTypedDict": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldDate": ".field_updatedocumentfieldsop", @@ -6472,6 +12885,10 @@ "FieldUpdateDocumentFieldsFieldMetaRadioRequestTypedDict": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldMetaRadioResponse": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldMetaRadioResponseTypedDict": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsFieldMetaSignatureRequest": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsFieldMetaSignatureRequestTypedDict": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsFieldMetaSignatureResponse": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsFieldMetaSignatureResponseTypedDict": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldMetaTextRequest": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldMetaTextRequestTypedDict": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldMetaTextResponse": ".field_updatedocumentfieldsop", @@ -6484,6 +12901,7 @@ "FieldUpdateDocumentFieldsFieldMetaTypeName": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldMetaTypeNumber": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldMetaTypeRadio": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsFieldMetaTypeSignature": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldMetaTypeText": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldMetaUnion": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldMetaUnionTypedDict": ".field_updatedocumentfieldsop", @@ -6501,6 +12919,10 @@ "FieldUpdateDocumentFieldsFieldTextTypedDict": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldUnion": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsFieldUnionTypedDict": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsForbiddenError": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsForbiddenErrorData": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsForbiddenIssue": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsForbiddenIssueTypedDict": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsInternalServerError": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsInternalServerErrorData": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsInternalServerErrorIssue": ".field_updatedocumentfieldsop", @@ -6539,9 +12961,14 @@ "FieldUpdateDocumentFieldsTypeRadioRequest1": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsTypeRadioRequest2": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsTypeResponse": ".field_updatedocumentfieldsop", - "FieldUpdateDocumentFieldsTypeSignature": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsTypeSignatureRequest1": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsTypeSignatureRequest2": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsTypeTextRequest1": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsTypeTextRequest2": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsUnauthorizedError": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsUnauthorizedErrorData": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsUnauthorizedIssue": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsUnauthorizedIssueTypedDict": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsValueCheckbox": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsValueCheckboxTypedDict": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsValueDropdown": ".field_updatedocumentfieldsop", @@ -6554,10 +12981,18 @@ "FieldUpdateDocumentFieldsValueResponse2TypedDict": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsValueResponse3": ".field_updatedocumentfieldsop", "FieldUpdateDocumentFieldsValueResponse3TypedDict": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsVerticalAlignNumber": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsVerticalAlignResponse1": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsVerticalAlignResponse2": ".field_updatedocumentfieldsop", + "FieldUpdateDocumentFieldsVerticalAlignText": ".field_updatedocumentfieldsop", "FieldUpdateTemplateFieldBadRequestError": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldBadRequestErrorData": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldBadRequestIssue": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldBadRequestIssueTypedDict": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldDirectionCheckbox": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldDirectionRadio": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldDirectionResponse1": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldDirectionResponse2": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldCheckbox": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldCheckboxTypedDict": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldDate": ".field_updatetemplatefieldop", @@ -6602,6 +13037,10 @@ "FieldUpdateTemplateFieldFieldMetaRadioRequestTypedDict": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldMetaRadioResponse": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldMetaRadioResponseTypedDict": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldFieldMetaSignatureRequest": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldFieldMetaSignatureRequestTypedDict": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldFieldMetaSignatureResponse": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldFieldMetaSignatureResponseTypedDict": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldMetaTextRequest": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldMetaTextRequestTypedDict": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldMetaTextResponse": ".field_updatetemplatefieldop", @@ -6614,6 +13053,7 @@ "FieldUpdateTemplateFieldFieldMetaTypeName": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldMetaTypeNumber": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldMetaTypeRadio": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldFieldMetaTypeSignature": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldMetaTypeText": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldMetaUnion": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldMetaUnionTypedDict": ".field_updatetemplatefieldop", @@ -6629,6 +13069,10 @@ "FieldUpdateTemplateFieldFieldTextTypedDict": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldUnion": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldFieldUnionTypedDict": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldForbiddenError": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldForbiddenErrorData": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldForbiddenIssue": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldForbiddenIssueTypedDict": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldInternalServerError": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldInternalServerErrorData": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldInternalServerErrorIssue": ".field_updatetemplatefieldop", @@ -6667,9 +13111,14 @@ "FieldUpdateTemplateFieldTypeRadioRequest1": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldTypeRadioRequest2": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldTypeResponse": ".field_updatetemplatefieldop", - "FieldUpdateTemplateFieldTypeSignature": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldTypeSignatureRequest1": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldTypeSignatureRequest2": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldTypeTextRequest1": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldTypeTextRequest2": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldUnauthorizedError": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldUnauthorizedErrorData": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldUnauthorizedIssue": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldUnauthorizedIssueTypedDict": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldValueCheckbox": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldValueCheckboxTypedDict": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldValueDropdown": ".field_updatetemplatefieldop", @@ -6682,10 +13131,18 @@ "FieldUpdateTemplateFieldValueResponse2TypedDict": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldValueResponse3": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldValueResponse3TypedDict": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldVerticalAlignNumber": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldVerticalAlignResponse1": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldVerticalAlignResponse2": ".field_updatetemplatefieldop", + "FieldUpdateTemplateFieldVerticalAlignText": ".field_updatetemplatefieldop", "FieldUpdateTemplateFieldsBadRequestError": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsBadRequestErrorData": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsBadRequestIssue": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsBadRequestIssueTypedDict": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsDirectionCheckbox": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsDirectionRadio": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsDirectionResponse1": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsDirectionResponse2": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldCheckbox": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldCheckboxTypedDict": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldDate": ".field_updatetemplatefieldsop", @@ -6730,6 +13187,10 @@ "FieldUpdateTemplateFieldsFieldMetaRadioRequestTypedDict": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldMetaRadioResponse": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldMetaRadioResponseTypedDict": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsFieldMetaSignatureRequest": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsFieldMetaSignatureRequestTypedDict": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsFieldMetaSignatureResponse": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsFieldMetaSignatureResponseTypedDict": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldMetaTextRequest": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldMetaTextRequestTypedDict": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldMetaTextResponse": ".field_updatetemplatefieldsop", @@ -6742,6 +13203,7 @@ "FieldUpdateTemplateFieldsFieldMetaTypeName": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldMetaTypeNumber": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldMetaTypeRadio": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsFieldMetaTypeSignature": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldMetaTypeText": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldMetaUnion": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldMetaUnionTypedDict": ".field_updatetemplatefieldsop", @@ -6759,6 +13221,10 @@ "FieldUpdateTemplateFieldsFieldTextTypedDict": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldUnion": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsFieldUnionTypedDict": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsForbiddenError": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsForbiddenErrorData": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsForbiddenIssue": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsForbiddenIssueTypedDict": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsInternalServerError": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsInternalServerErrorData": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsInternalServerErrorIssue": ".field_updatetemplatefieldsop", @@ -6797,9 +13263,14 @@ "FieldUpdateTemplateFieldsTypeRadioRequest1": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsTypeRadioRequest2": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsTypeResponse": ".field_updatetemplatefieldsop", - "FieldUpdateTemplateFieldsTypeSignature": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsTypeSignatureRequest1": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsTypeSignatureRequest2": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsTypeTextRequest1": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsTypeTextRequest2": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsUnauthorizedError": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsUnauthorizedErrorData": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsUnauthorizedIssue": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsUnauthorizedIssueTypedDict": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsValueCheckbox": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsValueCheckboxTypedDict": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsValueDropdown": ".field_updatetemplatefieldsop", @@ -6812,6 +13283,107 @@ "FieldUpdateTemplateFieldsValueResponse2TypedDict": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsValueResponse3": ".field_updatetemplatefieldsop", "FieldUpdateTemplateFieldsValueResponse3TypedDict": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsVerticalAlignNumber": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsVerticalAlignResponse1": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsVerticalAlignResponse2": ".field_updatetemplatefieldsop", + "FieldUpdateTemplateFieldsVerticalAlignText": ".field_updatetemplatefieldsop", + "FolderCreateFolderBadRequestError": ".folder_createfolderop", + "FolderCreateFolderBadRequestErrorData": ".folder_createfolderop", + "FolderCreateFolderBadRequestIssue": ".folder_createfolderop", + "FolderCreateFolderBadRequestIssueTypedDict": ".folder_createfolderop", + "FolderCreateFolderForbiddenError": ".folder_createfolderop", + "FolderCreateFolderForbiddenErrorData": ".folder_createfolderop", + "FolderCreateFolderForbiddenIssue": ".folder_createfolderop", + "FolderCreateFolderForbiddenIssueTypedDict": ".folder_createfolderop", + "FolderCreateFolderInternalServerError": ".folder_createfolderop", + "FolderCreateFolderInternalServerErrorData": ".folder_createfolderop", + "FolderCreateFolderInternalServerErrorIssue": ".folder_createfolderop", + "FolderCreateFolderInternalServerErrorIssueTypedDict": ".folder_createfolderop", + "FolderCreateFolderRequest": ".folder_createfolderop", + "FolderCreateFolderRequestTypedDict": ".folder_createfolderop", + "FolderCreateFolderResponse": ".folder_createfolderop", + "FolderCreateFolderResponseTypedDict": ".folder_createfolderop", + "FolderCreateFolderTypeRequest": ".folder_createfolderop", + "FolderCreateFolderTypeResponse": ".folder_createfolderop", + "FolderCreateFolderUnauthorizedError": ".folder_createfolderop", + "FolderCreateFolderUnauthorizedErrorData": ".folder_createfolderop", + "FolderCreateFolderUnauthorizedIssue": ".folder_createfolderop", + "FolderCreateFolderUnauthorizedIssueTypedDict": ".folder_createfolderop", + "FolderCreateFolderVisibility": ".folder_createfolderop", + "FolderDeleteFolderBadRequestError": ".folder_deletefolderop", + "FolderDeleteFolderBadRequestErrorData": ".folder_deletefolderop", + "FolderDeleteFolderBadRequestIssue": ".folder_deletefolderop", + "FolderDeleteFolderBadRequestIssueTypedDict": ".folder_deletefolderop", + "FolderDeleteFolderForbiddenError": ".folder_deletefolderop", + "FolderDeleteFolderForbiddenErrorData": ".folder_deletefolderop", + "FolderDeleteFolderForbiddenIssue": ".folder_deletefolderop", + "FolderDeleteFolderForbiddenIssueTypedDict": ".folder_deletefolderop", + "FolderDeleteFolderInternalServerError": ".folder_deletefolderop", + "FolderDeleteFolderInternalServerErrorData": ".folder_deletefolderop", + "FolderDeleteFolderInternalServerErrorIssue": ".folder_deletefolderop", + "FolderDeleteFolderInternalServerErrorIssueTypedDict": ".folder_deletefolderop", + "FolderDeleteFolderRequest": ".folder_deletefolderop", + "FolderDeleteFolderRequestTypedDict": ".folder_deletefolderop", + "FolderDeleteFolderResponse": ".folder_deletefolderop", + "FolderDeleteFolderResponseTypedDict": ".folder_deletefolderop", + "FolderDeleteFolderUnauthorizedError": ".folder_deletefolderop", + "FolderDeleteFolderUnauthorizedErrorData": ".folder_deletefolderop", + "FolderDeleteFolderUnauthorizedIssue": ".folder_deletefolderop", + "FolderDeleteFolderUnauthorizedIssueTypedDict": ".folder_deletefolderop", + "FolderFindFoldersBadRequestError": ".folder_findfoldersop", + "FolderFindFoldersBadRequestErrorData": ".folder_findfoldersop", + "FolderFindFoldersBadRequestIssue": ".folder_findfoldersop", + "FolderFindFoldersBadRequestIssueTypedDict": ".folder_findfoldersop", + "FolderFindFoldersData": ".folder_findfoldersop", + "FolderFindFoldersDataType": ".folder_findfoldersop", + "FolderFindFoldersDataTypedDict": ".folder_findfoldersop", + "FolderFindFoldersForbiddenError": ".folder_findfoldersop", + "FolderFindFoldersForbiddenErrorData": ".folder_findfoldersop", + "FolderFindFoldersForbiddenIssue": ".folder_findfoldersop", + "FolderFindFoldersForbiddenIssueTypedDict": ".folder_findfoldersop", + "FolderFindFoldersInternalServerError": ".folder_findfoldersop", + "FolderFindFoldersInternalServerErrorData": ".folder_findfoldersop", + "FolderFindFoldersInternalServerErrorIssue": ".folder_findfoldersop", + "FolderFindFoldersInternalServerErrorIssueTypedDict": ".folder_findfoldersop", + "FolderFindFoldersNotFoundError": ".folder_findfoldersop", + "FolderFindFoldersNotFoundErrorData": ".folder_findfoldersop", + "FolderFindFoldersNotFoundIssue": ".folder_findfoldersop", + "FolderFindFoldersNotFoundIssueTypedDict": ".folder_findfoldersop", + "FolderFindFoldersQueryParamType": ".folder_findfoldersop", + "FolderFindFoldersRequest": ".folder_findfoldersop", + "FolderFindFoldersRequestTypedDict": ".folder_findfoldersop", + "FolderFindFoldersResponse": ".folder_findfoldersop", + "FolderFindFoldersResponseTypedDict": ".folder_findfoldersop", + "FolderFindFoldersUnauthorizedError": ".folder_findfoldersop", + "FolderFindFoldersUnauthorizedErrorData": ".folder_findfoldersop", + "FolderFindFoldersUnauthorizedIssue": ".folder_findfoldersop", + "FolderFindFoldersUnauthorizedIssueTypedDict": ".folder_findfoldersop", + "FolderFindFoldersVisibility": ".folder_findfoldersop", + "FolderUpdateFolderBadRequestError": ".folder_updatefolderop", + "FolderUpdateFolderBadRequestErrorData": ".folder_updatefolderop", + "FolderUpdateFolderBadRequestIssue": ".folder_updatefolderop", + "FolderUpdateFolderBadRequestIssueTypedDict": ".folder_updatefolderop", + "FolderUpdateFolderData": ".folder_updatefolderop", + "FolderUpdateFolderDataTypedDict": ".folder_updatefolderop", + "FolderUpdateFolderDataVisibility": ".folder_updatefolderop", + "FolderUpdateFolderForbiddenError": ".folder_updatefolderop", + "FolderUpdateFolderForbiddenErrorData": ".folder_updatefolderop", + "FolderUpdateFolderForbiddenIssue": ".folder_updatefolderop", + "FolderUpdateFolderForbiddenIssueTypedDict": ".folder_updatefolderop", + "FolderUpdateFolderInternalServerError": ".folder_updatefolderop", + "FolderUpdateFolderInternalServerErrorData": ".folder_updatefolderop", + "FolderUpdateFolderInternalServerErrorIssue": ".folder_updatefolderop", + "FolderUpdateFolderInternalServerErrorIssueTypedDict": ".folder_updatefolderop", + "FolderUpdateFolderRequest": ".folder_updatefolderop", + "FolderUpdateFolderRequestTypedDict": ".folder_updatefolderop", + "FolderUpdateFolderResponse": ".folder_updatefolderop", + "FolderUpdateFolderResponseTypedDict": ".folder_updatefolderop", + "FolderUpdateFolderType": ".folder_updatefolderop", + "FolderUpdateFolderUnauthorizedError": ".folder_updatefolderop", + "FolderUpdateFolderUnauthorizedErrorData": ".folder_updatefolderop", + "FolderUpdateFolderUnauthorizedIssue": ".folder_updatefolderop", + "FolderUpdateFolderUnauthorizedIssueTypedDict": ".folder_updatefolderop", + "FolderUpdateFolderVisibilityResponse": ".folder_updatefolderop", "NoResponseError": ".no_response_error", "RecipientCreateDocumentRecipientAccessAuthRequest": ".recipient_createdocumentrecipientop", "RecipientCreateDocumentRecipientAccessAuthResponse": ".recipient_createdocumentrecipientop", @@ -6823,6 +13395,10 @@ "RecipientCreateDocumentRecipientBadRequestErrorData": ".recipient_createdocumentrecipientop", "RecipientCreateDocumentRecipientBadRequestIssue": ".recipient_createdocumentrecipientop", "RecipientCreateDocumentRecipientBadRequestIssueTypedDict": ".recipient_createdocumentrecipientop", + "RecipientCreateDocumentRecipientForbiddenError": ".recipient_createdocumentrecipientop", + "RecipientCreateDocumentRecipientForbiddenErrorData": ".recipient_createdocumentrecipientop", + "RecipientCreateDocumentRecipientForbiddenIssue": ".recipient_createdocumentrecipientop", + "RecipientCreateDocumentRecipientForbiddenIssueTypedDict": ".recipient_createdocumentrecipientop", "RecipientCreateDocumentRecipientInternalServerError": ".recipient_createdocumentrecipientop", "RecipientCreateDocumentRecipientInternalServerErrorData": ".recipient_createdocumentrecipientop", "RecipientCreateDocumentRecipientInternalServerErrorIssue": ".recipient_createdocumentrecipientop", @@ -6838,6 +13414,10 @@ "RecipientCreateDocumentRecipientRoleResponse": ".recipient_createdocumentrecipientop", "RecipientCreateDocumentRecipientSendStatus": ".recipient_createdocumentrecipientop", "RecipientCreateDocumentRecipientSigningStatus": ".recipient_createdocumentrecipientop", + "RecipientCreateDocumentRecipientUnauthorizedError": ".recipient_createdocumentrecipientop", + "RecipientCreateDocumentRecipientUnauthorizedErrorData": ".recipient_createdocumentrecipientop", + "RecipientCreateDocumentRecipientUnauthorizedIssue": ".recipient_createdocumentrecipientop", + "RecipientCreateDocumentRecipientUnauthorizedIssueTypedDict": ".recipient_createdocumentrecipientop", "RecipientCreateDocumentRecipientsAccessAuthRequest": ".recipient_createdocumentrecipientsop", "RecipientCreateDocumentRecipientsAccessAuthResponse": ".recipient_createdocumentrecipientsop", "RecipientCreateDocumentRecipientsActionAuthRequest": ".recipient_createdocumentrecipientsop", @@ -6848,6 +13428,10 @@ "RecipientCreateDocumentRecipientsBadRequestErrorData": ".recipient_createdocumentrecipientsop", "RecipientCreateDocumentRecipientsBadRequestIssue": ".recipient_createdocumentrecipientsop", "RecipientCreateDocumentRecipientsBadRequestIssueTypedDict": ".recipient_createdocumentrecipientsop", + "RecipientCreateDocumentRecipientsForbiddenError": ".recipient_createdocumentrecipientsop", + "RecipientCreateDocumentRecipientsForbiddenErrorData": ".recipient_createdocumentrecipientsop", + "RecipientCreateDocumentRecipientsForbiddenIssue": ".recipient_createdocumentrecipientsop", + "RecipientCreateDocumentRecipientsForbiddenIssueTypedDict": ".recipient_createdocumentrecipientsop", "RecipientCreateDocumentRecipientsInternalServerError": ".recipient_createdocumentrecipientsop", "RecipientCreateDocumentRecipientsInternalServerErrorData": ".recipient_createdocumentrecipientsop", "RecipientCreateDocumentRecipientsInternalServerErrorIssue": ".recipient_createdocumentrecipientsop", @@ -6865,6 +13449,10 @@ "RecipientCreateDocumentRecipientsRoleResponse": ".recipient_createdocumentrecipientsop", "RecipientCreateDocumentRecipientsSendStatus": ".recipient_createdocumentrecipientsop", "RecipientCreateDocumentRecipientsSigningStatus": ".recipient_createdocumentrecipientsop", + "RecipientCreateDocumentRecipientsUnauthorizedError": ".recipient_createdocumentrecipientsop", + "RecipientCreateDocumentRecipientsUnauthorizedErrorData": ".recipient_createdocumentrecipientsop", + "RecipientCreateDocumentRecipientsUnauthorizedIssue": ".recipient_createdocumentrecipientsop", + "RecipientCreateDocumentRecipientsUnauthorizedIssueTypedDict": ".recipient_createdocumentrecipientsop", "RecipientCreateTemplateRecipientAccessAuthRequest": ".recipient_createtemplaterecipientop", "RecipientCreateTemplateRecipientAccessAuthResponse": ".recipient_createtemplaterecipientop", "RecipientCreateTemplateRecipientActionAuthRequest": ".recipient_createtemplaterecipientop", @@ -6875,6 +13463,10 @@ "RecipientCreateTemplateRecipientBadRequestErrorData": ".recipient_createtemplaterecipientop", "RecipientCreateTemplateRecipientBadRequestIssue": ".recipient_createtemplaterecipientop", "RecipientCreateTemplateRecipientBadRequestIssueTypedDict": ".recipient_createtemplaterecipientop", + "RecipientCreateTemplateRecipientForbiddenError": ".recipient_createtemplaterecipientop", + "RecipientCreateTemplateRecipientForbiddenErrorData": ".recipient_createtemplaterecipientop", + "RecipientCreateTemplateRecipientForbiddenIssue": ".recipient_createtemplaterecipientop", + "RecipientCreateTemplateRecipientForbiddenIssueTypedDict": ".recipient_createtemplaterecipientop", "RecipientCreateTemplateRecipientInternalServerError": ".recipient_createtemplaterecipientop", "RecipientCreateTemplateRecipientInternalServerErrorData": ".recipient_createtemplaterecipientop", "RecipientCreateTemplateRecipientInternalServerErrorIssue": ".recipient_createtemplaterecipientop", @@ -6890,6 +13482,10 @@ "RecipientCreateTemplateRecipientRoleResponse": ".recipient_createtemplaterecipientop", "RecipientCreateTemplateRecipientSendStatus": ".recipient_createtemplaterecipientop", "RecipientCreateTemplateRecipientSigningStatus": ".recipient_createtemplaterecipientop", + "RecipientCreateTemplateRecipientUnauthorizedError": ".recipient_createtemplaterecipientop", + "RecipientCreateTemplateRecipientUnauthorizedErrorData": ".recipient_createtemplaterecipientop", + "RecipientCreateTemplateRecipientUnauthorizedIssue": ".recipient_createtemplaterecipientop", + "RecipientCreateTemplateRecipientUnauthorizedIssueTypedDict": ".recipient_createtemplaterecipientop", "RecipientCreateTemplateRecipientsAccessAuthRequest": ".recipient_createtemplaterecipientsop", "RecipientCreateTemplateRecipientsAccessAuthResponse": ".recipient_createtemplaterecipientsop", "RecipientCreateTemplateRecipientsActionAuthRequest": ".recipient_createtemplaterecipientsop", @@ -6900,6 +13496,10 @@ "RecipientCreateTemplateRecipientsBadRequestErrorData": ".recipient_createtemplaterecipientsop", "RecipientCreateTemplateRecipientsBadRequestIssue": ".recipient_createtemplaterecipientsop", "RecipientCreateTemplateRecipientsBadRequestIssueTypedDict": ".recipient_createtemplaterecipientsop", + "RecipientCreateTemplateRecipientsForbiddenError": ".recipient_createtemplaterecipientsop", + "RecipientCreateTemplateRecipientsForbiddenErrorData": ".recipient_createtemplaterecipientsop", + "RecipientCreateTemplateRecipientsForbiddenIssue": ".recipient_createtemplaterecipientsop", + "RecipientCreateTemplateRecipientsForbiddenIssueTypedDict": ".recipient_createtemplaterecipientsop", "RecipientCreateTemplateRecipientsInternalServerError": ".recipient_createtemplaterecipientsop", "RecipientCreateTemplateRecipientsInternalServerErrorData": ".recipient_createtemplaterecipientsop", "RecipientCreateTemplateRecipientsInternalServerErrorIssue": ".recipient_createtemplaterecipientsop", @@ -6917,10 +13517,18 @@ "RecipientCreateTemplateRecipientsRoleResponse": ".recipient_createtemplaterecipientsop", "RecipientCreateTemplateRecipientsSendStatus": ".recipient_createtemplaterecipientsop", "RecipientCreateTemplateRecipientsSigningStatus": ".recipient_createtemplaterecipientsop", + "RecipientCreateTemplateRecipientsUnauthorizedError": ".recipient_createtemplaterecipientsop", + "RecipientCreateTemplateRecipientsUnauthorizedErrorData": ".recipient_createtemplaterecipientsop", + "RecipientCreateTemplateRecipientsUnauthorizedIssue": ".recipient_createtemplaterecipientsop", + "RecipientCreateTemplateRecipientsUnauthorizedIssueTypedDict": ".recipient_createtemplaterecipientsop", "RecipientDeleteDocumentRecipientBadRequestError": ".recipient_deletedocumentrecipientop", "RecipientDeleteDocumentRecipientBadRequestErrorData": ".recipient_deletedocumentrecipientop", "RecipientDeleteDocumentRecipientBadRequestIssue": ".recipient_deletedocumentrecipientop", "RecipientDeleteDocumentRecipientBadRequestIssueTypedDict": ".recipient_deletedocumentrecipientop", + "RecipientDeleteDocumentRecipientForbiddenError": ".recipient_deletedocumentrecipientop", + "RecipientDeleteDocumentRecipientForbiddenErrorData": ".recipient_deletedocumentrecipientop", + "RecipientDeleteDocumentRecipientForbiddenIssue": ".recipient_deletedocumentrecipientop", + "RecipientDeleteDocumentRecipientForbiddenIssueTypedDict": ".recipient_deletedocumentrecipientop", "RecipientDeleteDocumentRecipientInternalServerError": ".recipient_deletedocumentrecipientop", "RecipientDeleteDocumentRecipientInternalServerErrorData": ".recipient_deletedocumentrecipientop", "RecipientDeleteDocumentRecipientInternalServerErrorIssue": ".recipient_deletedocumentrecipientop", @@ -6929,10 +13537,18 @@ "RecipientDeleteDocumentRecipientRequestTypedDict": ".recipient_deletedocumentrecipientop", "RecipientDeleteDocumentRecipientResponse": ".recipient_deletedocumentrecipientop", "RecipientDeleteDocumentRecipientResponseTypedDict": ".recipient_deletedocumentrecipientop", + "RecipientDeleteDocumentRecipientUnauthorizedError": ".recipient_deletedocumentrecipientop", + "RecipientDeleteDocumentRecipientUnauthorizedErrorData": ".recipient_deletedocumentrecipientop", + "RecipientDeleteDocumentRecipientUnauthorizedIssue": ".recipient_deletedocumentrecipientop", + "RecipientDeleteDocumentRecipientUnauthorizedIssueTypedDict": ".recipient_deletedocumentrecipientop", "RecipientDeleteTemplateRecipientBadRequestError": ".recipient_deletetemplaterecipientop", "RecipientDeleteTemplateRecipientBadRequestErrorData": ".recipient_deletetemplaterecipientop", "RecipientDeleteTemplateRecipientBadRequestIssue": ".recipient_deletetemplaterecipientop", "RecipientDeleteTemplateRecipientBadRequestIssueTypedDict": ".recipient_deletetemplaterecipientop", + "RecipientDeleteTemplateRecipientForbiddenError": ".recipient_deletetemplaterecipientop", + "RecipientDeleteTemplateRecipientForbiddenErrorData": ".recipient_deletetemplaterecipientop", + "RecipientDeleteTemplateRecipientForbiddenIssue": ".recipient_deletetemplaterecipientop", + "RecipientDeleteTemplateRecipientForbiddenIssueTypedDict": ".recipient_deletetemplaterecipientop", "RecipientDeleteTemplateRecipientInternalServerError": ".recipient_deletetemplaterecipientop", "RecipientDeleteTemplateRecipientInternalServerErrorData": ".recipient_deletetemplaterecipientop", "RecipientDeleteTemplateRecipientInternalServerErrorIssue": ".recipient_deletetemplaterecipientop", @@ -6941,6 +13557,10 @@ "RecipientDeleteTemplateRecipientRequestTypedDict": ".recipient_deletetemplaterecipientop", "RecipientDeleteTemplateRecipientResponse": ".recipient_deletetemplaterecipientop", "RecipientDeleteTemplateRecipientResponseTypedDict": ".recipient_deletetemplaterecipientop", + "RecipientDeleteTemplateRecipientUnauthorizedError": ".recipient_deletetemplaterecipientop", + "RecipientDeleteTemplateRecipientUnauthorizedErrorData": ".recipient_deletetemplaterecipientop", + "RecipientDeleteTemplateRecipientUnauthorizedIssue": ".recipient_deletetemplaterecipientop", + "RecipientDeleteTemplateRecipientUnauthorizedIssueTypedDict": ".recipient_deletetemplaterecipientop", "RecipientGetDocumentRecipientAccessAuth": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientActionAuth": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientAuthOptions": ".recipient_getdocumentrecipientop", @@ -6949,6 +13569,8 @@ "RecipientGetDocumentRecipientBadRequestErrorData": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientBadRequestIssue": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientBadRequestIssueTypedDict": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientDirection1": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientDirection2": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientField": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldMetaCheckbox": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict": ".recipient_getdocumentrecipientop", @@ -6966,11 +13588,17 @@ "RecipientGetDocumentRecipientFieldMetaNumberTypedDict": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldMetaRadio": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldMetaRadioTypedDict": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientFieldMetaSignature": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientFieldMetaSignatureTypedDict": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldMetaText": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldMetaTextTypedDict": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldMetaUnion": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldMetaUnionTypedDict": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientFieldTypedDict": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientForbiddenError": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientForbiddenErrorData": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientForbiddenIssue": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientForbiddenIssueTypedDict": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientInternalServerError": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientInternalServerErrorData": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientInternalServerErrorIssue": ".recipient_getdocumentrecipientop", @@ -7002,13 +13630,20 @@ "RecipientGetDocumentRecipientTypeName": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientTypeNumber": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientTypeRadio": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientTypeSignature": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientTypeText": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientUnauthorizedError": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientUnauthorizedErrorData": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientUnauthorizedIssue": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientUnauthorizedIssueTypedDict": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientValue1": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientValue1TypedDict": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientValue2": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientValue2TypedDict": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientValue3": ".recipient_getdocumentrecipientop", "RecipientGetDocumentRecipientValue3TypedDict": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientVerticalAlign1": ".recipient_getdocumentrecipientop", + "RecipientGetDocumentRecipientVerticalAlign2": ".recipient_getdocumentrecipientop", "RecipientGetTemplateRecipientAccessAuth": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientActionAuth": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientAuthOptions": ".recipient_gettemplaterecipientop", @@ -7017,6 +13652,8 @@ "RecipientGetTemplateRecipientBadRequestErrorData": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientBadRequestIssue": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientBadRequestIssueTypedDict": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientDirection1": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientDirection2": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientField": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldMetaCheckbox": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict": ".recipient_gettemplaterecipientop", @@ -7034,11 +13671,17 @@ "RecipientGetTemplateRecipientFieldMetaNumberTypedDict": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldMetaRadio": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldMetaRadioTypedDict": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientFieldMetaSignature": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientFieldMetaSignatureTypedDict": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldMetaText": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldMetaTextTypedDict": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldMetaUnion": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldMetaUnionTypedDict": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientFieldTypedDict": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientForbiddenError": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientForbiddenErrorData": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientForbiddenIssue": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientForbiddenIssueTypedDict": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientInternalServerError": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientInternalServerErrorData": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientInternalServerErrorIssue": ".recipient_gettemplaterecipientop", @@ -7070,13 +13713,20 @@ "RecipientGetTemplateRecipientTypeName": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientTypeNumber": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientTypeRadio": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientTypeSignature": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientTypeText": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientUnauthorizedError": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientUnauthorizedErrorData": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientUnauthorizedIssue": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientUnauthorizedIssueTypedDict": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientValue1": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientValue1TypedDict": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientValue2": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientValue2TypedDict": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientValue3": ".recipient_gettemplaterecipientop", "RecipientGetTemplateRecipientValue3TypedDict": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientVerticalAlign1": ".recipient_gettemplaterecipientop", + "RecipientGetTemplateRecipientVerticalAlign2": ".recipient_gettemplaterecipientop", "RecipientUpdateDocumentRecipientAccessAuthRequest": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientAccessAuthResponse": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientActionAuthRequest": ".recipient_updatedocumentrecipientop", @@ -7087,6 +13737,8 @@ "RecipientUpdateDocumentRecipientBadRequestErrorData": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientBadRequestIssue": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientBadRequestIssueTypedDict": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientDirection1": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientDirection2": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientField": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldMetaCheckbox": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict": ".recipient_updatedocumentrecipientop", @@ -7104,11 +13756,17 @@ "RecipientUpdateDocumentRecipientFieldMetaNumberTypedDict": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldMetaRadio": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldMetaRadioTypedDict": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientFieldMetaSignature": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientFieldMetaSignatureTypedDict": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldMetaText": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldMetaTextTypedDict": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldMetaUnion": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldMetaUnionTypedDict": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientFieldTypedDict": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientForbiddenError": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientForbiddenErrorData": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientForbiddenIssue": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientForbiddenIssueTypedDict": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientInternalServerError": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientInternalServerErrorData": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientInternalServerErrorIssue": ".recipient_updatedocumentrecipientop", @@ -7139,13 +13797,20 @@ "RecipientUpdateDocumentRecipientTypeName": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientTypeNumber": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientTypeRadio": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientTypeSignature": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientTypeText": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientUnauthorizedError": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientUnauthorizedErrorData": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientUnauthorizedIssue": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientUnauthorizedIssueTypedDict": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientValue1": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientValue1TypedDict": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientValue2": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientValue2TypedDict": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientValue3": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientValue3TypedDict": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientVerticalAlign1": ".recipient_updatedocumentrecipientop", + "RecipientUpdateDocumentRecipientVerticalAlign2": ".recipient_updatedocumentrecipientop", "RecipientUpdateDocumentRecipientsAccessAuthRequest": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsAccessAuthResponse": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsActionAuthRequest": ".recipient_updatedocumentrecipientsop", @@ -7156,6 +13821,8 @@ "RecipientUpdateDocumentRecipientsBadRequestErrorData": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsBadRequestIssue": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsBadRequestIssueTypedDict": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsDirection1": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsDirection2": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsField": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldMetaCheckbox": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict": ".recipient_updatedocumentrecipientsop", @@ -7173,11 +13840,17 @@ "RecipientUpdateDocumentRecipientsFieldMetaNumberTypedDict": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldMetaRadio": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldMetaRadioTypedDict": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsFieldMetaSignature": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsFieldMetaSignatureTypedDict": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldMetaText": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldMetaTextTypedDict": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldMetaUnion": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldMetaUnionTypedDict": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsFieldTypedDict": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsForbiddenError": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsForbiddenErrorData": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsForbiddenIssue": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsForbiddenIssueTypedDict": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsInternalServerError": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsInternalServerErrorData": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsInternalServerErrorIssue": ".recipient_updatedocumentrecipientsop", @@ -7210,13 +13883,20 @@ "RecipientUpdateDocumentRecipientsTypeName": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsTypeNumber": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsTypeRadio": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsTypeSignature": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsTypeText": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsUnauthorizedError": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsUnauthorizedErrorData": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsUnauthorizedIssue": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsUnauthorizedIssueTypedDict": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsValue1": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsValue1TypedDict": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsValue2": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsValue2TypedDict": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsValue3": ".recipient_updatedocumentrecipientsop", "RecipientUpdateDocumentRecipientsValue3TypedDict": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsVerticalAlign1": ".recipient_updatedocumentrecipientsop", + "RecipientUpdateDocumentRecipientsVerticalAlign2": ".recipient_updatedocumentrecipientsop", "RecipientUpdateTemplateRecipientAccessAuthRequest": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientAccessAuthResponse": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientActionAuthRequest": ".recipient_updatetemplaterecipientop", @@ -7227,6 +13907,8 @@ "RecipientUpdateTemplateRecipientBadRequestErrorData": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientBadRequestIssue": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientBadRequestIssueTypedDict": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientDirection1": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientDirection2": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientField": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldMetaCheckbox": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict": ".recipient_updatetemplaterecipientop", @@ -7244,11 +13926,17 @@ "RecipientUpdateTemplateRecipientFieldMetaNumberTypedDict": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldMetaRadio": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldMetaRadioTypedDict": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientFieldMetaSignature": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientFieldMetaSignatureTypedDict": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldMetaText": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldMetaTextTypedDict": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldMetaUnion": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldMetaUnionTypedDict": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientFieldTypedDict": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientForbiddenError": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientForbiddenErrorData": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientForbiddenIssue": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientForbiddenIssueTypedDict": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientInternalServerError": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientInternalServerErrorData": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientInternalServerErrorIssue": ".recipient_updatetemplaterecipientop", @@ -7279,13 +13967,20 @@ "RecipientUpdateTemplateRecipientTypeName": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientTypeNumber": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientTypeRadio": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientTypeSignature": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientTypeText": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientUnauthorizedError": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientUnauthorizedErrorData": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientUnauthorizedIssue": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientUnauthorizedIssueTypedDict": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientValue1": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientValue1TypedDict": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientValue2": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientValue2TypedDict": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientValue3": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientValue3TypedDict": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientVerticalAlign1": ".recipient_updatetemplaterecipientop", + "RecipientUpdateTemplateRecipientVerticalAlign2": ".recipient_updatetemplaterecipientop", "RecipientUpdateTemplateRecipientsAccessAuthRequest": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsAccessAuthResponse": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsActionAuthRequest": ".recipient_updatetemplaterecipientsop", @@ -7296,6 +13991,8 @@ "RecipientUpdateTemplateRecipientsBadRequestErrorData": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsBadRequestIssue": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsBadRequestIssueTypedDict": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsDirection1": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsDirection2": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsField": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldMetaCheckbox": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict": ".recipient_updatetemplaterecipientsop", @@ -7313,11 +14010,17 @@ "RecipientUpdateTemplateRecipientsFieldMetaNumberTypedDict": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldMetaRadio": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldMetaRadioTypedDict": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsFieldMetaSignature": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsFieldMetaSignatureTypedDict": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldMetaText": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldMetaTextTypedDict": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldMetaUnion": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldMetaUnionTypedDict": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsFieldTypedDict": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsForbiddenError": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsForbiddenErrorData": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsForbiddenIssue": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsForbiddenIssueTypedDict": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsInternalServerError": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsInternalServerErrorData": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsInternalServerErrorIssue": ".recipient_updatetemplaterecipientsop", @@ -7350,36 +14053,23 @@ "RecipientUpdateTemplateRecipientsTypeName": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsTypeNumber": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsTypeRadio": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsTypeSignature": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsTypeText": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsUnauthorizedError": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsUnauthorizedErrorData": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsUnauthorizedIssue": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsUnauthorizedIssueTypedDict": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsValue1": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsValue1TypedDict": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsValue2": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsValue2TypedDict": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsValue3": ".recipient_updatetemplaterecipientsop", "RecipientUpdateTemplateRecipientsValue3TypedDict": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsVerticalAlign1": ".recipient_updatetemplaterecipientsop", + "RecipientUpdateTemplateRecipientsVerticalAlign2": ".recipient_updatetemplaterecipientsop", "ResponseValidationError": ".responsevalidationerror", "Security": ".security", "SecurityTypedDict": ".security", - "PrefillField": ".template_createdocumentfromtemplateop", - "PrefillFieldCheckbox": ".template_createdocumentfromtemplateop", - "PrefillFieldCheckboxTypedDict": ".template_createdocumentfromtemplateop", - "PrefillFieldDate": ".template_createdocumentfromtemplateop", - "PrefillFieldDateTypedDict": ".template_createdocumentfromtemplateop", - "PrefillFieldDropdown": ".template_createdocumentfromtemplateop", - "PrefillFieldDropdownTypedDict": ".template_createdocumentfromtemplateop", - "PrefillFieldNumber": ".template_createdocumentfromtemplateop", - "PrefillFieldNumberTypedDict": ".template_createdocumentfromtemplateop", - "PrefillFieldRadio": ".template_createdocumentfromtemplateop", - "PrefillFieldRadioTypedDict": ".template_createdocumentfromtemplateop", - "PrefillFieldText": ".template_createdocumentfromtemplateop", - "PrefillFieldTextTypedDict": ".template_createdocumentfromtemplateop", - "PrefillFieldTypeCheckbox": ".template_createdocumentfromtemplateop", - "PrefillFieldTypeDate": ".template_createdocumentfromtemplateop", - "PrefillFieldTypeDropdown": ".template_createdocumentfromtemplateop", - "PrefillFieldTypeNumber": ".template_createdocumentfromtemplateop", - "PrefillFieldTypeRadio": ".template_createdocumentfromtemplateop", - "PrefillFieldTypeText": ".template_createdocumentfromtemplateop", - "PrefillFieldTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateAccessAuth": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateActionAuth": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateAuthOptions": ".template_createdocumentfromtemplateop", @@ -7388,6 +14078,10 @@ "TemplateCreateDocumentFromTemplateBadRequestErrorData": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateBadRequestIssue": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateBadRequestIssueTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateCustomDocumentDatum": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateCustomDocumentDatumTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateDirection1": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateDirection2": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateDistributionMethod": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateDocumentData": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateDocumentDataType": ".template_createdocumentfromtemplateop", @@ -7396,6 +14090,8 @@ "TemplateCreateDocumentFromTemplateDocumentMetaTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateEmailSettings": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateEmailSettingsTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateEnvelopeItem": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateEnvelopeItemTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateField": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFieldMetaCheckbox": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFieldMetaCheckboxTypedDict": ".template_createdocumentfromtemplateop", @@ -7413,6 +14109,8 @@ "TemplateCreateDocumentFromTemplateFieldMetaNumberTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFieldMetaRadio": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFieldMetaRadioTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateFieldMetaSignature": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateFieldMetaSignatureTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFieldMetaText": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFieldMetaTextTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFieldMetaTypeCheckbox": ".template_createdocumentfromtemplateop", @@ -7429,6 +14127,10 @@ "TemplateCreateDocumentFromTemplateFolderType": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFolderTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFolderVisibility": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateForbiddenError": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateForbiddenErrorData": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateForbiddenIssue": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateForbiddenIssueTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFormValues": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateFormValuesTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateGlobalAccessAuth": ".template_createdocumentfromtemplateop", @@ -7437,6 +14139,26 @@ "TemplateCreateDocumentFromTemplateInternalServerErrorData": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateInternalServerErrorIssue": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateInternalServerErrorIssueTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldCheckbox": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldCheckboxTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldDate": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldDateTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldDropdown": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldDropdownTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldNumber": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldNumberTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldRadio": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldRadioTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldText": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldTextTypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeCheckbox": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeDate": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeDropdown": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeNumber": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeRadio": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldTypeText": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldUnion": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplatePrefillFieldUnionTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateReadStatus": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateRecipientAuthOptions": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateRecipientAuthOptionsTypedDict": ".template_createdocumentfromtemplateop", @@ -7463,17 +14185,28 @@ "TemplateCreateDocumentFromTemplateTypeEmail": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateTypeInitials": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateTypeName": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateTypeSignature": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateUnauthorizedError": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateUnauthorizedErrorData": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateUnauthorizedIssue": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateUnauthorizedIssueTypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateValue1": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateValue1TypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateValue2": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateValue2TypedDict": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateValue3": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateValue3TypedDict": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateVerticalAlign1": ".template_createdocumentfromtemplateop", + "TemplateCreateDocumentFromTemplateVerticalAlign2": ".template_createdocumentfromtemplateop", "TemplateCreateDocumentFromTemplateVisibility": ".template_createdocumentfromtemplateop", "TemplateCreateTemplateDirectLinkBadRequestError": ".template_createtemplatedirectlinkop", "TemplateCreateTemplateDirectLinkBadRequestErrorData": ".template_createtemplatedirectlinkop", "TemplateCreateTemplateDirectLinkBadRequestIssue": ".template_createtemplatedirectlinkop", "TemplateCreateTemplateDirectLinkBadRequestIssueTypedDict": ".template_createtemplatedirectlinkop", + "TemplateCreateTemplateDirectLinkForbiddenError": ".template_createtemplatedirectlinkop", + "TemplateCreateTemplateDirectLinkForbiddenErrorData": ".template_createtemplatedirectlinkop", + "TemplateCreateTemplateDirectLinkForbiddenIssue": ".template_createtemplatedirectlinkop", + "TemplateCreateTemplateDirectLinkForbiddenIssueTypedDict": ".template_createtemplatedirectlinkop", "TemplateCreateTemplateDirectLinkInternalServerError": ".template_createtemplatedirectlinkop", "TemplateCreateTemplateDirectLinkInternalServerErrorData": ".template_createtemplatedirectlinkop", "TemplateCreateTemplateDirectLinkInternalServerErrorIssue": ".template_createtemplatedirectlinkop", @@ -7482,10 +14215,180 @@ "TemplateCreateTemplateDirectLinkRequestTypedDict": ".template_createtemplatedirectlinkop", "TemplateCreateTemplateDirectLinkResponse": ".template_createtemplatedirectlinkop", "TemplateCreateTemplateDirectLinkResponseTypedDict": ".template_createtemplatedirectlinkop", + "TemplateCreateTemplateDirectLinkUnauthorizedError": ".template_createtemplatedirectlinkop", + "TemplateCreateTemplateDirectLinkUnauthorizedErrorData": ".template_createtemplatedirectlinkop", + "TemplateCreateTemplateDirectLinkUnauthorizedIssue": ".template_createtemplatedirectlinkop", + "TemplateCreateTemplateDirectLinkUnauthorizedIssueTypedDict": ".template_createtemplatedirectlinkop", + "TemplateCreateTemplateAttachment": ".template_createtemplateop", + "TemplateCreateTemplateAttachmentTypedDict": ".template_createtemplateop", + "TemplateCreateTemplateBadRequestError": ".template_createtemplateop", + "TemplateCreateTemplateBadRequestErrorData": ".template_createtemplateop", + "TemplateCreateTemplateBadRequestIssue": ".template_createtemplateop", + "TemplateCreateTemplateBadRequestIssueTypedDict": ".template_createtemplateop", + "TemplateCreateTemplateDateFormat": ".template_createtemplateop", + "TemplateCreateTemplateDistributionMethod": ".template_createtemplateop", + "TemplateCreateTemplateEmailSettings": ".template_createtemplateop", + "TemplateCreateTemplateEmailSettingsTypedDict": ".template_createtemplateop", + "TemplateCreateTemplateFile": ".template_createtemplateop", + "TemplateCreateTemplateFileTypedDict": ".template_createtemplateop", + "TemplateCreateTemplateForbiddenError": ".template_createtemplateop", + "TemplateCreateTemplateForbiddenErrorData": ".template_createtemplateop", + "TemplateCreateTemplateForbiddenIssue": ".template_createtemplateop", + "TemplateCreateTemplateForbiddenIssueTypedDict": ".template_createtemplateop", + "TemplateCreateTemplateGlobalAccessAuth": ".template_createtemplateop", + "TemplateCreateTemplateGlobalActionAuth": ".template_createtemplateop", + "TemplateCreateTemplateInternalServerError": ".template_createtemplateop", + "TemplateCreateTemplateInternalServerErrorData": ".template_createtemplateop", + "TemplateCreateTemplateInternalServerErrorIssue": ".template_createtemplateop", + "TemplateCreateTemplateInternalServerErrorIssueTypedDict": ".template_createtemplateop", + "TemplateCreateTemplateLanguage": ".template_createtemplateop", + "TemplateCreateTemplateMeta": ".template_createtemplateop", + "TemplateCreateTemplateMetaTypedDict": ".template_createtemplateop", + "TemplateCreateTemplatePayload": ".template_createtemplateop", + "TemplateCreateTemplatePayloadTypedDict": ".template_createtemplateop", + "TemplateCreateTemplateRequest": ".template_createtemplateop", + "TemplateCreateTemplateRequestTypedDict": ".template_createtemplateop", + "TemplateCreateTemplateResponse": ".template_createtemplateop", + "TemplateCreateTemplateResponseTypedDict": ".template_createtemplateop", + "TemplateCreateTemplateSigningOrder": ".template_createtemplateop", + "TemplateCreateTemplateType": ".template_createtemplateop", + "TemplateCreateTemplateTypeLink": ".template_createtemplateop", + "TemplateCreateTemplateUnauthorizedError": ".template_createtemplateop", + "TemplateCreateTemplateUnauthorizedErrorData": ".template_createtemplateop", + "TemplateCreateTemplateUnauthorizedIssue": ".template_createtemplateop", + "TemplateCreateTemplateUnauthorizedIssueTypedDict": ".template_createtemplateop", + "TemplateCreateTemplateVisibility": ".template_createtemplateop", + "TemplateCreateTemplateTemporaryAccessAuth": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryActionAuth": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryAttachment": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryAttachmentTypedDict": ".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", + "TemplateCreateTemplateTemporaryDirection1": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryDirection2": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryEnvelopeItem": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryEnvelopeItemTypedDict": ".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", + "TemplateCreateTemplateTemporaryFieldMetaSignature": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryFieldMetaSignatureTypedDict": ".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", + "TemplateCreateTemplateTemporaryForbiddenError": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryForbiddenErrorData": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryForbiddenIssue": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryForbiddenIssueTypedDict": ".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", + "TemplateCreateTemplateTemporaryMetaDistributionMethod": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryMetaEmailSettings": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryMetaEmailSettingsTypedDict": ".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", + "TemplateCreateTemplateTemporaryTypeLink": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeName": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeNumber": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeRadio": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeRequest": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeResponse": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeSignature": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryTypeText": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryUnauthorizedError": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryUnauthorizedErrorData": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryUnauthorizedIssue": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryUnauthorizedIssueTypedDict": ".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", + "TemplateCreateTemplateTemporaryVerticalAlign1": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryVerticalAlign2": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryVisibilityRequest": ".template_createtemplatetemporaryop", + "TemplateCreateTemplateTemporaryVisibilityResponse": ".template_createtemplatetemporaryop", "TemplateDeleteTemplateDirectLinkBadRequestError": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateDirectLinkBadRequestErrorData": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateDirectLinkBadRequestIssue": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateDirectLinkBadRequestIssueTypedDict": ".template_deletetemplatedirectlinkop", + "TemplateDeleteTemplateDirectLinkForbiddenError": ".template_deletetemplatedirectlinkop", + "TemplateDeleteTemplateDirectLinkForbiddenErrorData": ".template_deletetemplatedirectlinkop", + "TemplateDeleteTemplateDirectLinkForbiddenIssue": ".template_deletetemplatedirectlinkop", + "TemplateDeleteTemplateDirectLinkForbiddenIssueTypedDict": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateDirectLinkInternalServerError": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateDirectLinkInternalServerErrorData": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateDirectLinkInternalServerErrorIssue": ".template_deletetemplatedirectlinkop", @@ -7494,10 +14397,18 @@ "TemplateDeleteTemplateDirectLinkRequestTypedDict": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateDirectLinkResponse": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateDirectLinkResponseTypedDict": ".template_deletetemplatedirectlinkop", + "TemplateDeleteTemplateDirectLinkUnauthorizedError": ".template_deletetemplatedirectlinkop", + "TemplateDeleteTemplateDirectLinkUnauthorizedErrorData": ".template_deletetemplatedirectlinkop", + "TemplateDeleteTemplateDirectLinkUnauthorizedIssue": ".template_deletetemplatedirectlinkop", + "TemplateDeleteTemplateDirectLinkUnauthorizedIssueTypedDict": ".template_deletetemplatedirectlinkop", "TemplateDeleteTemplateBadRequestError": ".template_deletetemplateop", "TemplateDeleteTemplateBadRequestErrorData": ".template_deletetemplateop", "TemplateDeleteTemplateBadRequestIssue": ".template_deletetemplateop", "TemplateDeleteTemplateBadRequestIssueTypedDict": ".template_deletetemplateop", + "TemplateDeleteTemplateForbiddenError": ".template_deletetemplateop", + "TemplateDeleteTemplateForbiddenErrorData": ".template_deletetemplateop", + "TemplateDeleteTemplateForbiddenIssue": ".template_deletetemplateop", + "TemplateDeleteTemplateForbiddenIssueTypedDict": ".template_deletetemplateop", "TemplateDeleteTemplateInternalServerError": ".template_deletetemplateop", "TemplateDeleteTemplateInternalServerErrorData": ".template_deletetemplateop", "TemplateDeleteTemplateInternalServerErrorIssue": ".template_deletetemplateop", @@ -7506,12 +14417,20 @@ "TemplateDeleteTemplateRequestTypedDict": ".template_deletetemplateop", "TemplateDeleteTemplateResponse": ".template_deletetemplateop", "TemplateDeleteTemplateResponseTypedDict": ".template_deletetemplateop", + "TemplateDeleteTemplateUnauthorizedError": ".template_deletetemplateop", + "TemplateDeleteTemplateUnauthorizedErrorData": ".template_deletetemplateop", + "TemplateDeleteTemplateUnauthorizedIssue": ".template_deletetemplateop", + "TemplateDeleteTemplateUnauthorizedIssueTypedDict": ".template_deletetemplateop", "TemplateDuplicateTemplateAuthOptions": ".template_duplicatetemplateop", "TemplateDuplicateTemplateAuthOptionsTypedDict": ".template_duplicatetemplateop", "TemplateDuplicateTemplateBadRequestError": ".template_duplicatetemplateop", "TemplateDuplicateTemplateBadRequestErrorData": ".template_duplicatetemplateop", "TemplateDuplicateTemplateBadRequestIssue": ".template_duplicatetemplateop", "TemplateDuplicateTemplateBadRequestIssueTypedDict": ".template_duplicatetemplateop", + "TemplateDuplicateTemplateForbiddenError": ".template_duplicatetemplateop", + "TemplateDuplicateTemplateForbiddenErrorData": ".template_duplicatetemplateop", + "TemplateDuplicateTemplateForbiddenIssue": ".template_duplicatetemplateop", + "TemplateDuplicateTemplateForbiddenIssueTypedDict": ".template_duplicatetemplateop", "TemplateDuplicateTemplateGlobalAccessAuth": ".template_duplicatetemplateop", "TemplateDuplicateTemplateGlobalActionAuth": ".template_duplicatetemplateop", "TemplateDuplicateTemplateInternalServerError": ".template_duplicatetemplateop", @@ -7523,8 +14442,11 @@ "TemplateDuplicateTemplateResponse": ".template_duplicatetemplateop", "TemplateDuplicateTemplateResponseTypedDict": ".template_duplicatetemplateop", "TemplateDuplicateTemplateType": ".template_duplicatetemplateop", + "TemplateDuplicateTemplateUnauthorizedError": ".template_duplicatetemplateop", + "TemplateDuplicateTemplateUnauthorizedErrorData": ".template_duplicatetemplateop", + "TemplateDuplicateTemplateUnauthorizedIssue": ".template_duplicatetemplateop", + "TemplateDuplicateTemplateUnauthorizedIssueTypedDict": ".template_duplicatetemplateop", "TemplateDuplicateTemplateVisibility": ".template_duplicatetemplateop", - "QueryParamType": ".template_findtemplatesop", "TemplateFindTemplatesAccessAuth": ".template_findtemplatesop", "TemplateFindTemplatesActionAuth": ".template_findtemplatesop", "TemplateFindTemplatesAuthOptions": ".template_findtemplatesop", @@ -7538,6 +14460,8 @@ "TemplateFindTemplatesDataTypedDict": ".template_findtemplatesop", "TemplateFindTemplatesDirectLink": ".template_findtemplatesop", "TemplateFindTemplatesDirectLinkTypedDict": ".template_findtemplatesop", + "TemplateFindTemplatesDirection1": ".template_findtemplatesop", + "TemplateFindTemplatesDirection2": ".template_findtemplatesop", "TemplateFindTemplatesDistributionMethod": ".template_findtemplatesop", "TemplateFindTemplatesField": ".template_findtemplatesop", "TemplateFindTemplatesFieldMetaCheckbox": ".template_findtemplatesop", @@ -7556,12 +14480,18 @@ "TemplateFindTemplatesFieldMetaNumberTypedDict": ".template_findtemplatesop", "TemplateFindTemplatesFieldMetaRadio": ".template_findtemplatesop", "TemplateFindTemplatesFieldMetaRadioTypedDict": ".template_findtemplatesop", + "TemplateFindTemplatesFieldMetaSignature": ".template_findtemplatesop", + "TemplateFindTemplatesFieldMetaSignatureTypedDict": ".template_findtemplatesop", "TemplateFindTemplatesFieldMetaText": ".template_findtemplatesop", "TemplateFindTemplatesFieldMetaTextTypedDict": ".template_findtemplatesop", "TemplateFindTemplatesFieldMetaUnion": ".template_findtemplatesop", "TemplateFindTemplatesFieldMetaUnionTypedDict": ".template_findtemplatesop", "TemplateFindTemplatesFieldType": ".template_findtemplatesop", "TemplateFindTemplatesFieldTypedDict": ".template_findtemplatesop", + "TemplateFindTemplatesForbiddenError": ".template_findtemplatesop", + "TemplateFindTemplatesForbiddenErrorData": ".template_findtemplatesop", + "TemplateFindTemplatesForbiddenIssue": ".template_findtemplatesop", + "TemplateFindTemplatesForbiddenIssueTypedDict": ".template_findtemplatesop", "TemplateFindTemplatesGlobalAccessAuth": ".template_findtemplatesop", "TemplateFindTemplatesGlobalActionAuth": ".template_findtemplatesop", "TemplateFindTemplatesInternalServerError": ".template_findtemplatesop", @@ -7572,6 +14502,7 @@ "TemplateFindTemplatesNotFoundErrorData": ".template_findtemplatesop", "TemplateFindTemplatesNotFoundIssue": ".template_findtemplatesop", "TemplateFindTemplatesNotFoundIssueTypedDict": ".template_findtemplatesop", + "TemplateFindTemplatesQueryParamType": ".template_findtemplatesop", "TemplateFindTemplatesReadStatus": ".template_findtemplatesop", "TemplateFindTemplatesRecipient": ".template_findtemplatesop", "TemplateFindTemplatesRecipientAuthOptions": ".template_findtemplatesop", @@ -7603,17 +14534,21 @@ "TemplateFindTemplatesTypeName": ".template_findtemplatesop", "TemplateFindTemplatesTypeNumber": ".template_findtemplatesop", "TemplateFindTemplatesTypeRadio": ".template_findtemplatesop", + "TemplateFindTemplatesTypeSignature": ".template_findtemplatesop", "TemplateFindTemplatesTypeText": ".template_findtemplatesop", + "TemplateFindTemplatesUnauthorizedError": ".template_findtemplatesop", + "TemplateFindTemplatesUnauthorizedErrorData": ".template_findtemplatesop", + "TemplateFindTemplatesUnauthorizedIssue": ".template_findtemplatesop", + "TemplateFindTemplatesUnauthorizedIssueTypedDict": ".template_findtemplatesop", "TemplateFindTemplatesValue1": ".template_findtemplatesop", "TemplateFindTemplatesValue1TypedDict": ".template_findtemplatesop", "TemplateFindTemplatesValue2": ".template_findtemplatesop", "TemplateFindTemplatesValue2TypedDict": ".template_findtemplatesop", "TemplateFindTemplatesValue3": ".template_findtemplatesop", "TemplateFindTemplatesValue3TypedDict": ".template_findtemplatesop", + "TemplateFindTemplatesVerticalAlign1": ".template_findtemplatesop", + "TemplateFindTemplatesVerticalAlign2": ".template_findtemplatesop", "TemplateFindTemplatesVisibility": ".template_findtemplatesop", - "TemplateDocumentData": ".template_gettemplatebyidop", - "TemplateDocumentDataType": ".template_gettemplatebyidop", - "TemplateDocumentDataTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDAccessAuth": ".template_gettemplatebyidop", "TemplateGetTemplateByIDActionAuth": ".template_gettemplatebyidop", "TemplateGetTemplateByIDAuthOptions": ".template_gettemplatebyidop", @@ -7624,9 +14559,13 @@ "TemplateGetTemplateByIDBadRequestIssueTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDDirectLink": ".template_gettemplatebyidop", "TemplateGetTemplateByIDDirectLinkTypedDict": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDDirection1": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDDirection2": ".template_gettemplatebyidop", "TemplateGetTemplateByIDDistributionMethod": ".template_gettemplatebyidop", "TemplateGetTemplateByIDEmailSettings": ".template_gettemplatebyidop", "TemplateGetTemplateByIDEmailSettingsTypedDict": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDEnvelopeItem": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDEnvelopeItemTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDField": ".template_gettemplatebyidop", "TemplateGetTemplateByIDFieldMetaCheckbox": ".template_gettemplatebyidop", "TemplateGetTemplateByIDFieldMetaCheckboxTypedDict": ".template_gettemplatebyidop", @@ -7644,6 +14583,8 @@ "TemplateGetTemplateByIDFieldMetaNumberTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDFieldMetaRadio": ".template_gettemplatebyidop", "TemplateGetTemplateByIDFieldMetaRadioTypedDict": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDFieldMetaSignature": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDFieldMetaSignatureTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDFieldMetaText": ".template_gettemplatebyidop", "TemplateGetTemplateByIDFieldMetaTextTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDFieldMetaUnion": ".template_gettemplatebyidop", @@ -7654,6 +14595,10 @@ "TemplateGetTemplateByIDFolderType": ".template_gettemplatebyidop", "TemplateGetTemplateByIDFolderTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDFolderVisibility": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDForbiddenError": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDForbiddenErrorData": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDForbiddenIssue": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDForbiddenIssueTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDGlobalAccessAuth": ".template_gettemplatebyidop", "TemplateGetTemplateByIDGlobalActionAuth": ".template_gettemplatebyidop", "TemplateGetTemplateByIDInternalServerError": ".template_gettemplatebyidop", @@ -7677,6 +14622,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", @@ -7694,7 +14642,12 @@ "TemplateGetTemplateByIDTypeName": ".template_gettemplatebyidop", "TemplateGetTemplateByIDTypeNumber": ".template_gettemplatebyidop", "TemplateGetTemplateByIDTypeRadio": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDTypeSignature": ".template_gettemplatebyidop", "TemplateGetTemplateByIDTypeText": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDUnauthorizedError": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDUnauthorizedErrorData": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDUnauthorizedIssue": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDUnauthorizedIssueTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDUser": ".template_gettemplatebyidop", "TemplateGetTemplateByIDUserTypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDValue1": ".template_gettemplatebyidop", @@ -7703,11 +14656,17 @@ "TemplateGetTemplateByIDValue2TypedDict": ".template_gettemplatebyidop", "TemplateGetTemplateByIDValue3": ".template_gettemplatebyidop", "TemplateGetTemplateByIDValue3TypedDict": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDVerticalAlign1": ".template_gettemplatebyidop", + "TemplateGetTemplateByIDVerticalAlign2": ".template_gettemplatebyidop", "TemplateGetTemplateByIDVisibility": ".template_gettemplatebyidop", "TemplateToggleTemplateDirectLinkBadRequestError": ".template_toggletemplatedirectlinkop", "TemplateToggleTemplateDirectLinkBadRequestErrorData": ".template_toggletemplatedirectlinkop", "TemplateToggleTemplateDirectLinkBadRequestIssue": ".template_toggletemplatedirectlinkop", "TemplateToggleTemplateDirectLinkBadRequestIssueTypedDict": ".template_toggletemplatedirectlinkop", + "TemplateToggleTemplateDirectLinkForbiddenError": ".template_toggletemplatedirectlinkop", + "TemplateToggleTemplateDirectLinkForbiddenErrorData": ".template_toggletemplatedirectlinkop", + "TemplateToggleTemplateDirectLinkForbiddenIssue": ".template_toggletemplatedirectlinkop", + "TemplateToggleTemplateDirectLinkForbiddenIssueTypedDict": ".template_toggletemplatedirectlinkop", "TemplateToggleTemplateDirectLinkInternalServerError": ".template_toggletemplatedirectlinkop", "TemplateToggleTemplateDirectLinkInternalServerErrorData": ".template_toggletemplatedirectlinkop", "TemplateToggleTemplateDirectLinkInternalServerErrorIssue": ".template_toggletemplatedirectlinkop", @@ -7716,6 +14675,10 @@ "TemplateToggleTemplateDirectLinkRequestTypedDict": ".template_toggletemplatedirectlinkop", "TemplateToggleTemplateDirectLinkResponse": ".template_toggletemplatedirectlinkop", "TemplateToggleTemplateDirectLinkResponseTypedDict": ".template_toggletemplatedirectlinkop", + "TemplateToggleTemplateDirectLinkUnauthorizedError": ".template_toggletemplatedirectlinkop", + "TemplateToggleTemplateDirectLinkUnauthorizedErrorData": ".template_toggletemplatedirectlinkop", + "TemplateToggleTemplateDirectLinkUnauthorizedIssue": ".template_toggletemplatedirectlinkop", + "TemplateToggleTemplateDirectLinkUnauthorizedIssueTypedDict": ".template_toggletemplatedirectlinkop", "TemplateUpdateTemplateAuthOptions": ".template_updatetemplateop", "TemplateUpdateTemplateAuthOptionsTypedDict": ".template_updatetemplateop", "TemplateUpdateTemplateBadRequestError": ".template_updatetemplateop", @@ -7723,15 +14686,20 @@ "TemplateUpdateTemplateBadRequestIssue": ".template_updatetemplateop", "TemplateUpdateTemplateBadRequestIssueTypedDict": ".template_updatetemplateop", "TemplateUpdateTemplateData": ".template_updatetemplateop", + "TemplateUpdateTemplateDataGlobalAccessAuth": ".template_updatetemplateop", + "TemplateUpdateTemplateDataGlobalActionAuth": ".template_updatetemplateop", "TemplateUpdateTemplateDataType": ".template_updatetemplateop", "TemplateUpdateTemplateDataTypedDict": ".template_updatetemplateop", + "TemplateUpdateTemplateDataVisibility": ".template_updatetemplateop", "TemplateUpdateTemplateDateFormat": ".template_updatetemplateop", "TemplateUpdateTemplateDistributionMethod": ".template_updatetemplateop", "TemplateUpdateTemplateEmailSettings": ".template_updatetemplateop", "TemplateUpdateTemplateEmailSettingsTypedDict": ".template_updatetemplateop", - "TemplateUpdateTemplateGlobalAccessAuthRequest": ".template_updatetemplateop", + "TemplateUpdateTemplateForbiddenError": ".template_updatetemplateop", + "TemplateUpdateTemplateForbiddenErrorData": ".template_updatetemplateop", + "TemplateUpdateTemplateForbiddenIssue": ".template_updatetemplateop", + "TemplateUpdateTemplateForbiddenIssueTypedDict": ".template_updatetemplateop", "TemplateUpdateTemplateGlobalAccessAuthResponse": ".template_updatetemplateop", - "TemplateUpdateTemplateGlobalActionAuthRequest": ".template_updatetemplateop", "TemplateUpdateTemplateGlobalActionAuthResponse": ".template_updatetemplateop", "TemplateUpdateTemplateInternalServerError": ".template_updatetemplateop", "TemplateUpdateTemplateInternalServerErrorData": ".template_updatetemplateop", @@ -7746,7 +14714,10 @@ "TemplateUpdateTemplateResponseTypedDict": ".template_updatetemplateop", "TemplateUpdateTemplateSigningOrder": ".template_updatetemplateop", "TemplateUpdateTemplateTypeResponse": ".template_updatetemplateop", - "TemplateUpdateTemplateVisibilityRequest": ".template_updatetemplateop", + "TemplateUpdateTemplateUnauthorizedError": ".template_updatetemplateop", + "TemplateUpdateTemplateUnauthorizedErrorData": ".template_updatetemplateop", + "TemplateUpdateTemplateUnauthorizedIssue": ".template_updatetemplateop", + "TemplateUpdateTemplateUnauthorizedIssueTypedDict": ".template_updatetemplateop", "TemplateUpdateTemplateVisibilityResponse": ".template_updatetemplateop", } 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_attachment_createop.py b/src/documenso_sdk/models/document_attachment_createop.py new file mode 100644 index 0000000..3a86c5b --- /dev/null +++ b/src/documenso_sdk/models/document_attachment_createop.py @@ -0,0 +1,180 @@ +"""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 DocumentAttachmentCreateDataTypedDict(TypedDict): + label: str + data: str + + +class DocumentAttachmentCreateData(BaseModel): + label: str + + data: str + + +class DocumentAttachmentCreateRequestTypedDict(TypedDict): + document_id: float + data: DocumentAttachmentCreateDataTypedDict + + +class DocumentAttachmentCreateRequest(BaseModel): + document_id: Annotated[float, pydantic.Field(alias="documentId")] + + data: DocumentAttachmentCreateData + + +class DocumentAttachmentCreateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentCreateInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentAttachmentCreateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentCreateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentCreateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentAttachmentCreateInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentCreateInternalServerErrorData, + 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 DocumentAttachmentCreateForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentCreateForbiddenIssue(BaseModel): + message: str + + +class DocumentAttachmentCreateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentCreateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentCreateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentAttachmentCreateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentCreateForbiddenErrorData, + 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 DocumentAttachmentCreateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentCreateUnauthorizedIssue(BaseModel): + message: str + + +class DocumentAttachmentCreateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentCreateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentCreateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentAttachmentCreateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentCreateUnauthorizedErrorData, + 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 DocumentAttachmentCreateBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentCreateBadRequestIssue(BaseModel): + message: str + + +class DocumentAttachmentCreateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentCreateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentCreateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentAttachmentCreateBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentCreateBadRequestErrorData, + 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 DocumentAttachmentCreateResponseTypedDict(TypedDict): + r"""Successful response""" + + id: str + + +class DocumentAttachmentCreateResponse(BaseModel): + r"""Successful response""" + + id: str diff --git a/src/documenso_sdk/models/document_attachment_deleteop.py b/src/documenso_sdk/models/document_attachment_deleteop.py new file mode 100644 index 0000000..a5e2fe1 --- /dev/null +++ b/src/documenso_sdk/models/document_attachment_deleteop.py @@ -0,0 +1,165 @@ +"""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 +from typing import List, Optional +from typing_extensions import TypedDict + + +class DocumentAttachmentDeleteRequestTypedDict(TypedDict): + id: str + + +class DocumentAttachmentDeleteRequest(BaseModel): + id: str + + +class DocumentAttachmentDeleteInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentDeleteInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentAttachmentDeleteInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentDeleteInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentDeleteInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentAttachmentDeleteInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentDeleteInternalServerErrorData, + 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 DocumentAttachmentDeleteForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentDeleteForbiddenIssue(BaseModel): + message: str + + +class DocumentAttachmentDeleteForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentDeleteForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentDeleteForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentAttachmentDeleteForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentDeleteForbiddenErrorData, + 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 DocumentAttachmentDeleteUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentDeleteUnauthorizedIssue(BaseModel): + message: str + + +class DocumentAttachmentDeleteUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentDeleteUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentDeleteUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentAttachmentDeleteUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentDeleteUnauthorizedErrorData, + 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 DocumentAttachmentDeleteBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentDeleteBadRequestIssue(BaseModel): + message: str + + +class DocumentAttachmentDeleteBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentDeleteBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentDeleteBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentAttachmentDeleteBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentDeleteBadRequestErrorData, + 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 DocumentAttachmentDeleteResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class DocumentAttachmentDeleteResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/document_attachment_findop.py b/src/documenso_sdk/models/document_attachment_findop.py new file mode 100644 index 0000000..d05e88d --- /dev/null +++ b/src/documenso_sdk/models/document_attachment_findop.py @@ -0,0 +1,227 @@ +"""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, QueryParamMetadata +from enum import Enum +import httpx +import pydantic +from typing import List, Optional +from typing_extensions import Annotated, TypedDict + + +class DocumentAttachmentFindRequestTypedDict(TypedDict): + document_id: float + + +class DocumentAttachmentFindRequest(BaseModel): + document_id: Annotated[ + float, + pydantic.Field(alias="documentId"), + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] + + +class DocumentAttachmentFindInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentFindInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentAttachmentFindInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentFindInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentFindInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentAttachmentFindInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentFindInternalServerErrorData, + 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 DocumentAttachmentFindNotFoundIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentFindNotFoundIssue(BaseModel): + message: str + + +class DocumentAttachmentFindNotFoundErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentFindNotFoundIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentFindNotFoundError(DocumensoError): + r"""Not found""" + + data: DocumentAttachmentFindNotFoundErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentFindNotFoundErrorData, + 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 DocumentAttachmentFindForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentFindForbiddenIssue(BaseModel): + message: str + + +class DocumentAttachmentFindForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentFindForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentFindForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentAttachmentFindForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentFindForbiddenErrorData, + 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 DocumentAttachmentFindUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentFindUnauthorizedIssue(BaseModel): + message: str + + +class DocumentAttachmentFindUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentFindUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentFindUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentAttachmentFindUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentFindUnauthorizedErrorData, + 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 DocumentAttachmentFindBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentFindBadRequestIssue(BaseModel): + message: str + + +class DocumentAttachmentFindBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentFindBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentFindBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentAttachmentFindBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentFindBadRequestErrorData, + 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 DocumentAttachmentFindType(str, Enum): + LINK = "link" + + +class DocumentAttachmentFindDataTypedDict(TypedDict): + id: str + type: DocumentAttachmentFindType + label: str + data: str + + +class DocumentAttachmentFindData(BaseModel): + id: str + + type: DocumentAttachmentFindType + + label: str + + data: str + + +class DocumentAttachmentFindResponseTypedDict(TypedDict): + r"""Successful response""" + + data: List[DocumentAttachmentFindDataTypedDict] + + +class DocumentAttachmentFindResponse(BaseModel): + r"""Successful response""" + + data: List[DocumentAttachmentFindData] diff --git a/src/documenso_sdk/models/document_attachment_updateop.py b/src/documenso_sdk/models/document_attachment_updateop.py new file mode 100644 index 0000000..2f721d7 --- /dev/null +++ b/src/documenso_sdk/models/document_attachment_updateop.py @@ -0,0 +1,179 @@ +"""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 +from typing import List, Optional +from typing_extensions import TypedDict + + +class DocumentAttachmentUpdateDataTypedDict(TypedDict): + label: str + data: str + + +class DocumentAttachmentUpdateData(BaseModel): + label: str + + data: str + + +class DocumentAttachmentUpdateRequestTypedDict(TypedDict): + id: str + data: DocumentAttachmentUpdateDataTypedDict + + +class DocumentAttachmentUpdateRequest(BaseModel): + id: str + + data: DocumentAttachmentUpdateData + + +class DocumentAttachmentUpdateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentUpdateInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentAttachmentUpdateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentUpdateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentUpdateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentAttachmentUpdateInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentUpdateInternalServerErrorData, + 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 DocumentAttachmentUpdateForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentUpdateForbiddenIssue(BaseModel): + message: str + + +class DocumentAttachmentUpdateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentUpdateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentUpdateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentAttachmentUpdateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentUpdateForbiddenErrorData, + 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 DocumentAttachmentUpdateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentUpdateUnauthorizedIssue(BaseModel): + message: str + + +class DocumentAttachmentUpdateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentUpdateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentUpdateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentAttachmentUpdateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentUpdateUnauthorizedErrorData, + 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 DocumentAttachmentUpdateBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentAttachmentUpdateBadRequestIssue(BaseModel): + message: str + + +class DocumentAttachmentUpdateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentAttachmentUpdateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentAttachmentUpdateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentAttachmentUpdateBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: DocumentAttachmentUpdateBadRequestErrorData, + 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 DocumentAttachmentUpdateResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class DocumentAttachmentUpdateResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/document_createdocumenttemporaryop.py b/src/documenso_sdk/models/document_createdocumenttemporaryop.py index 1bab755..739fb47 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 @@ -12,34 +19,31 @@ class DocumentCreateDocumentTemporaryVisibilityRequest(str, Enum): - r"""The visibility of the document.""" - EVERYONE = "EVERYONE" MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" ADMIN = "ADMIN" 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): - 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" -FormValuesRequestTypedDict = TypeAliasType( - "FormValuesRequestTypedDict", Union[str, bool, float] +DocumentCreateDocumentTemporaryFormValuesRequestTypedDict = TypeAliasType( + "DocumentCreateDocumentTemporaryFormValuesRequestTypedDict", Union[str, bool, float] ) -FormValuesRequest = TypeAliasType("FormValuesRequest", Union[str, bool, float]) +DocumentCreateDocumentTemporaryFormValuesRequest = TypeAliasType( + "DocumentCreateDocumentTemporaryFormValuesRequest", Union[str, bool, float] +) class DocumentCreateDocumentTemporaryRoleRequest(str, Enum): @@ -51,14 +55,11 @@ class DocumentCreateDocumentTemporaryRoleRequest(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -88,6 +89,7 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaDropdownTypedDict(TypedDi placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[DocumentCreateDocumentTemporaryValueDropdownTypedDict]] default_value: NotRequired[str] @@ -103,6 +105,8 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[DocumentCreateDocumentTemporaryValueDropdown]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -111,15 +115,10 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaDropdown(BaseModel): class DocumentCreateDocumentTemporaryFieldDropdownTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeDropdown1 page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[ DocumentCreateDocumentTemporaryRecipientFieldMetaDropdownTypedDict ] @@ -129,19 +128,14 @@ class DocumentCreateDocumentTemporaryFieldDropdown(BaseModel): type: DocumentCreateDocumentTemporaryRecipientTypeDropdown1 page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[DocumentCreateDocumentTemporaryRecipientFieldMetaDropdown], @@ -171,15 +165,22 @@ class DocumentCreateDocumentTemporaryValueCheckbox(BaseModel): value: str +class DocumentCreateDocumentTemporaryDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class DocumentCreateDocumentTemporaryRecipientFieldMetaCheckboxTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeCheckbox2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[DocumentCreateDocumentTemporaryValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[DocumentCreateDocumentTemporaryDirectionCheckbox] class DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox(BaseModel): @@ -193,6 +194,8 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[DocumentCreateDocumentTemporaryValueCheckbox]] = None validation_rule: Annotated[ @@ -203,19 +206,18 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[DocumentCreateDocumentTemporaryDirectionCheckbox] = ( + DocumentCreateDocumentTemporaryDirectionCheckbox.VERTICAL + ) + class DocumentCreateDocumentTemporaryFieldCheckboxTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeCheckbox1 page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[ DocumentCreateDocumentTemporaryRecipientFieldMetaCheckboxTypedDict ] @@ -225,19 +227,14 @@ class DocumentCreateDocumentTemporaryFieldCheckbox(BaseModel): type: DocumentCreateDocumentTemporaryRecipientTypeCheckbox1 page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox], @@ -267,13 +264,20 @@ class DocumentCreateDocumentTemporaryValueRadio(BaseModel): value: str +class DocumentCreateDocumentTemporaryDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class DocumentCreateDocumentTemporaryRecipientFieldMetaRadioTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeRadio2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[DocumentCreateDocumentTemporaryValueRadioTypedDict]] + direction: NotRequired[DocumentCreateDocumentTemporaryDirectionRadio] class DocumentCreateDocumentTemporaryRecipientFieldMetaRadio(BaseModel): @@ -287,21 +291,22 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[DocumentCreateDocumentTemporaryValueRadio]] = None + direction: Optional[DocumentCreateDocumentTemporaryDirectionRadio] = ( + DocumentCreateDocumentTemporaryDirectionRadio.VERTICAL + ) + class DocumentCreateDocumentTemporaryFieldRadioTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeRadio1 page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[ DocumentCreateDocumentTemporaryRecipientFieldMetaRadioTypedDict ] @@ -311,19 +316,14 @@ class DocumentCreateDocumentTemporaryFieldRadio(BaseModel): type: DocumentCreateDocumentTemporaryRecipientTypeRadio1 page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[DocumentCreateDocumentTemporaryRecipientFieldMetaRadio], @@ -345,18 +345,29 @@ class DocumentCreateDocumentTemporaryTextAlignNumber(str, Enum): RIGHT = "right" +class DocumentCreateDocumentTemporaryVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class DocumentCreateDocumentTemporaryRecipientFieldMetaNumberTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeNumber2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[DocumentCreateDocumentTemporaryTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[DocumentCreateDocumentTemporaryVerticalAlignNumber] + ] class DocumentCreateDocumentTemporaryRecipientFieldMetaNumber(BaseModel): @@ -370,34 +381,99 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[DocumentCreateDocumentTemporaryTextAlignNumber], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[DocumentCreateDocumentTemporaryVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[ DocumentCreateDocumentTemporaryRecipientFieldMetaNumberTypedDict ] @@ -407,19 +483,14 @@ class DocumentCreateDocumentTemporaryFieldNumber(BaseModel): type: DocumentCreateDocumentTemporaryRecipientTypeNumber1 page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[DocumentCreateDocumentTemporaryRecipientFieldMetaNumber], @@ -441,16 +512,27 @@ class DocumentCreateDocumentTemporaryTextAlignText(str, Enum): RIGHT = "right" +class DocumentCreateDocumentTemporaryVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class DocumentCreateDocumentTemporaryRecipientFieldMetaTextTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeText2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[DocumentCreateDocumentTemporaryTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[DocumentCreateDocumentTemporaryVerticalAlignText] + ] class DocumentCreateDocumentTemporaryRecipientFieldMetaText(BaseModel): @@ -464,32 +546,82 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[DocumentCreateDocumentTemporaryTextAlignText], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[DocumentCreateDocumentTemporaryVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 DocumentCreateDocumentTemporaryFieldTextTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeText1 page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[ DocumentCreateDocumentTemporaryRecipientFieldMetaTextTypedDict ] @@ -499,19 +631,14 @@ class DocumentCreateDocumentTemporaryFieldText(BaseModel): type: DocumentCreateDocumentTemporaryRecipientTypeText1 page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[DocumentCreateDocumentTemporaryRecipientFieldMetaText], @@ -554,7 +681,7 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[DocumentCreateDocumentTemporaryTextAlignDate], @@ -565,15 +692,10 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaDate(BaseModel): class DocumentCreateDocumentTemporaryFieldDateTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeDate1 page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[ DocumentCreateDocumentTemporaryRecipientFieldMetaDateTypedDict ] @@ -583,19 +705,14 @@ class DocumentCreateDocumentTemporaryFieldDate(BaseModel): type: DocumentCreateDocumentTemporaryRecipientTypeDate1 page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[DocumentCreateDocumentTemporaryRecipientFieldMetaDate], @@ -638,7 +755,7 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[DocumentCreateDocumentTemporaryTextAlignEmail], @@ -649,15 +766,10 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaEmail(BaseModel): class DocumentCreateDocumentTemporaryFieldEmailTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeEmail1 page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[ DocumentCreateDocumentTemporaryRecipientFieldMetaEmailTypedDict ] @@ -667,19 +779,14 @@ class DocumentCreateDocumentTemporaryFieldEmail(BaseModel): type: DocumentCreateDocumentTemporaryRecipientTypeEmail1 page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[DocumentCreateDocumentTemporaryRecipientFieldMetaEmail], @@ -722,7 +829,7 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[DocumentCreateDocumentTemporaryTextAlignName], @@ -733,15 +840,10 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaName(BaseModel): class DocumentCreateDocumentTemporaryFieldNameTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeName1 page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[ DocumentCreateDocumentTemporaryRecipientFieldMetaNameTypedDict ] @@ -751,19 +853,14 @@ class DocumentCreateDocumentTemporaryFieldName(BaseModel): type: DocumentCreateDocumentTemporaryRecipientTypeName1 page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[DocumentCreateDocumentTemporaryRecipientFieldMetaName], @@ -806,7 +903,7 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[DocumentCreateDocumentTemporaryTextAlignInitials], @@ -817,15 +914,10 @@ class DocumentCreateDocumentTemporaryRecipientFieldMetaInitials(BaseModel): class DocumentCreateDocumentTemporaryFieldInitialsTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryRecipientTypeInitials1 page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[ DocumentCreateDocumentTemporaryRecipientFieldMetaInitialsTypedDict ] @@ -835,19 +927,14 @@ class DocumentCreateDocumentTemporaryFieldInitials(BaseModel): type: DocumentCreateDocumentTemporaryRecipientTypeInitials1 page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[DocumentCreateDocumentTemporaryRecipientFieldMetaInitials], @@ -862,78 +949,93 @@ class DocumentCreateDocumentTemporaryTypeFreeSignature(str, Enum): class DocumentCreateDocumentTemporaryFieldFreeSignatureTypedDict(TypedDict): type: DocumentCreateDocumentTemporaryTypeFreeSignature page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" class DocumentCreateDocumentTemporaryFieldFreeSignature(BaseModel): type: DocumentCreateDocumentTemporaryTypeFreeSignature page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" -class DocumentCreateDocumentTemporaryTypeSignature(str, Enum): +class DocumentCreateDocumentTemporaryRecipientTypeSignature1(str, Enum): SIGNATURE = "SIGNATURE" +class DocumentCreateDocumentTemporaryRecipientTypeSignature2(str, Enum): + SIGNATURE = "signature" + + +class DocumentCreateDocumentTemporaryRecipientFieldMetaSignatureTypedDict(TypedDict): + type: DocumentCreateDocumentTemporaryRecipientTypeSignature2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class DocumentCreateDocumentTemporaryRecipientFieldMetaSignature(BaseModel): + type: DocumentCreateDocumentTemporaryRecipientTypeSignature2 + + 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")] = 12 + + class DocumentCreateDocumentTemporaryFieldSignatureTypedDict(TypedDict): - type: DocumentCreateDocumentTemporaryTypeSignature + type: DocumentCreateDocumentTemporaryRecipientTypeSignature1 page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" + field_meta: NotRequired[ + DocumentCreateDocumentTemporaryRecipientFieldMetaSignatureTypedDict + ] class DocumentCreateDocumentTemporaryFieldSignature(BaseModel): - type: DocumentCreateDocumentTemporaryTypeSignature + type: DocumentCreateDocumentTemporaryRecipientTypeSignature1 page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" + + field_meta: Annotated[ + Optional[DocumentCreateDocumentTemporaryRecipientFieldMetaSignature], + pydantic.Field(alias="fieldMeta"), + ] = None DocumentCreateDocumentTemporaryFieldUnionTypedDict = TypeAliasType( "DocumentCreateDocumentTemporaryFieldUnionTypedDict", Union[ - DocumentCreateDocumentTemporaryFieldSignatureTypedDict, DocumentCreateDocumentTemporaryFieldFreeSignatureTypedDict, + DocumentCreateDocumentTemporaryFieldSignatureTypedDict, DocumentCreateDocumentTemporaryFieldInitialsTypedDict, DocumentCreateDocumentTemporaryFieldNameTypedDict, DocumentCreateDocumentTemporaryFieldEmailTypedDict, @@ -950,8 +1052,8 @@ class DocumentCreateDocumentTemporaryFieldSignature(BaseModel): DocumentCreateDocumentTemporaryFieldUnion = TypeAliasType( "DocumentCreateDocumentTemporaryFieldUnion", Union[ - DocumentCreateDocumentTemporaryFieldSignature, DocumentCreateDocumentTemporaryFieldFreeSignature, + DocumentCreateDocumentTemporaryFieldSignature, DocumentCreateDocumentTemporaryFieldInitials, DocumentCreateDocumentTemporaryFieldName, DocumentCreateDocumentTemporaryFieldEmail, @@ -999,24 +1101,52 @@ class DocumentCreateDocumentTemporaryRecipientRequest(BaseModel): fields: Optional[List[DocumentCreateDocumentTemporaryFieldUnion]] = None -class DocumentCreateDocumentTemporaryDateFormat(str, Enum): - r"""The date format to use for date fields and signing the document.""" +class DocumentCreateDocumentTemporaryTypeLink(str, Enum): + LINK = "link" + - 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 DocumentCreateDocumentTemporaryAttachmentTypedDict(TypedDict): + label: str + data: str + type: NotRequired[DocumentCreateDocumentTemporaryTypeLink] -class DocumentCreateDocumentTemporaryDistributionMethodRequest(str, Enum): - r"""The distribution method to use when sending the document to the recipients.""" +class DocumentCreateDocumentTemporaryAttachment(BaseModel): + label: str + data: str + + type: Optional[DocumentCreateDocumentTemporaryTypeLink] = ( + DocumentCreateDocumentTemporaryTypeLink.LINK + ) + + +class DocumentCreateDocumentTemporaryDateFormat(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 DocumentCreateDocumentTemporaryMetaDistributionMethod(str, Enum): EMAIL = "EMAIL" NONE = "NONE" @@ -1027,8 +1157,6 @@ class DocumentCreateDocumentTemporarySigningOrderRequest(str, Enum): class DocumentCreateDocumentTemporaryLanguage(str, Enum): - r"""The language to use for email communications with recipients.""" - DE = "de" EN = "en" FR = "fr" @@ -1037,172 +1165,195 @@ class DocumentCreateDocumentTemporaryLanguage(str, Enum): PL = "pl" -class DocumentCreateDocumentTemporaryEmailSettingsRequestTypedDict(TypedDict): +class DocumentCreateDocumentTemporaryMetaEmailSettingsTypedDict(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 DocumentCreateDocumentTemporaryEmailSettingsRequest(BaseModel): +class DocumentCreateDocumentTemporaryMetaEmailSettings(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 DocumentCreateDocumentTemporaryMetaTypedDict(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[DocumentCreateDocumentTemporaryDateFormat] - r"""The date format to use for date fields and signing the document.""" distribution_method: NotRequired[ - DocumentCreateDocumentTemporaryDistributionMethodRequest + DocumentCreateDocumentTemporaryMetaDistributionMethod ] - 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] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] email_settings: NotRequired[ - DocumentCreateDocumentTemporaryEmailSettingsRequestTypedDict + Nullable[DocumentCreateDocumentTemporaryMetaEmailSettingsTypedDict] ] class DocumentCreateDocumentTemporaryMeta(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[DocumentCreateDocumentTemporaryDateFormat], pydantic.Field(alias="dateFormat"), ] = None - r"""The date format to use for date fields and signing the document.""" distribution_method: Annotated[ - Optional[DocumentCreateDocumentTemporaryDistributionMethodRequest], + Optional[DocumentCreateDocumentTemporaryMetaDistributionMethod], pydantic.Field(alias="distributionMethod"), ] = None - r"""The distribution method to use when sending the document to the recipients.""" signing_order: Annotated[ Optional[DocumentCreateDocumentTemporarySigningOrderRequest], 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.""" language: Optional[DocumentCreateDocumentTemporaryLanguage] = 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 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[DocumentCreateDocumentTemporaryMetaEmailSettings], 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): title: str - r"""The title of the document.""" external_id: NotRequired[str] - r"""The external ID of the document.""" visibility: NotRequired[DocumentCreateDocumentTemporaryVisibilityRequest] - r"""The visibility of the document.""" global_access_auth: NotRequired[ List[DocumentCreateDocumentTemporaryGlobalAccessAuthRequest] ] global_action_auth: NotRequired[ List[DocumentCreateDocumentTemporaryGlobalActionAuthRequest] ] - form_values: NotRequired[Dict[str, FormValuesRequestTypedDict]] + form_values: NotRequired[ + Dict[str, DocumentCreateDocumentTemporaryFormValuesRequestTypedDict] + ] + folder_id: NotRequired[str] recipients: NotRequired[ List[DocumentCreateDocumentTemporaryRecipientRequestTypedDict] ] + attachments: NotRequired[List[DocumentCreateDocumentTemporaryAttachmentTypedDict]] meta: NotRequired[DocumentCreateDocumentTemporaryMetaTypedDict] class DocumentCreateDocumentTemporaryRequest(BaseModel): title: str - r"""The title of the document.""" external_id: Annotated[Optional[str], pydantic.Field(alias="externalId")] = None - r"""The external ID of the document.""" visibility: Optional[DocumentCreateDocumentTemporaryVisibilityRequest] = None - r"""The visibility of the document.""" global_access_auth: Annotated[ Optional[List[DocumentCreateDocumentTemporaryGlobalAccessAuthRequest]], @@ -1215,11 +1366,16 @@ class DocumentCreateDocumentTemporaryRequest(BaseModel): ] = None form_values: Annotated[ - Optional[Dict[str, FormValuesRequest]], pydantic.Field(alias="formValues") + Optional[Dict[str, DocumentCreateDocumentTemporaryFormValuesRequest]], + pydantic.Field(alias="formValues"), ] = None + folder_id: Annotated[Optional[str], pydantic.Field(alias="folderId")] = None + recipients: Optional[List[DocumentCreateDocumentTemporaryRecipientRequest]] = None + attachments: Optional[List[DocumentCreateDocumentTemporaryAttachment]] = None + meta: Optional[DocumentCreateDocumentTemporaryMeta] = None @@ -1241,10 +1397,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 +1412,75 @@ 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 DocumentCreateDocumentTemporaryForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentCreateDocumentTemporaryForbiddenIssue(BaseModel): + message: str + + +class DocumentCreateDocumentTemporaryForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentCreateDocumentTemporaryForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentCreateDocumentTemporaryForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentCreateDocumentTemporaryForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentCreateDocumentTemporaryForbiddenErrorData, + 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 DocumentCreateDocumentTemporaryUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentCreateDocumentTemporaryUnauthorizedIssue(BaseModel): + message: str + + +class DocumentCreateDocumentTemporaryUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentCreateDocumentTemporaryUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentCreateDocumentTemporaryUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentCreateDocumentTemporaryUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentCreateDocumentTemporaryUnauthorizedErrorData, + 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 DocumentCreateDocumentTemporaryBadRequestIssueTypedDict(TypedDict): @@ -1274,10 +1499,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 +1514,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): @@ -1311,14 +1537,11 @@ class DocumentCreateDocumentTemporarySource(str, Enum): 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): - 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" @@ -1359,6 +1582,7 @@ class DocumentCreateDocumentTemporaryDocumentDataTypedDict(TypedDict): id: str data: str initial_data: str + envelope_item_id: str class DocumentCreateDocumentTemporaryDocumentData(BaseModel): @@ -1370,6 +1594,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" @@ -1383,56 +1609,42 @@ class DocumentDistributionMethod(str, Enum): class DocumentEmailSettingsTypedDict(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 DocumentEmailSettings(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 DocumentCreateDocumentTemporaryDocumentMetaTypedDict(TypedDict): @@ -1442,9 +1654,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 +1662,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 +1683,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 +1709,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) @@ -1538,6 +1758,17 @@ def serialize_model(self, handler): return m +class DocumentCreateDocumentTemporaryEnvelopeItemTypedDict(TypedDict): + id: str + envelope_id: str + + +class DocumentCreateDocumentTemporaryEnvelopeItem(BaseModel): + id: str + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + class DocumentFolderType(str, Enum): DOCUMENT = "DOCUMENT" TEMPLATE = "TEMPLATE" @@ -1639,14 +1870,11 @@ class DocumentCreateDocumentTemporarySendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -1666,13 +1894,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 @@ -1681,11 +1908,14 @@ class DocumentRecipientTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[DocumentCreateDocumentTemporaryRecipientAuthOptionsTypedDict] 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 +1933,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 @@ -1727,22 +1953,29 @@ class DocumentRecipient(BaseModel): ] 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 = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -1803,6 +2036,7 @@ class FieldMetaDocumentDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[DocumentValue3TypedDict]] default_value: NotRequired[str] @@ -1818,6 +2052,8 @@ class FieldMetaDocumentDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[DocumentValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -1841,15 +2077,22 @@ class DocumentValue2(BaseModel): value: str +class DocumentDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldMetaDocumentCheckboxTypedDict(TypedDict): type: DocumentTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[DocumentValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[DocumentDirection2] class FieldMetaDocumentCheckbox(BaseModel): @@ -1863,6 +2106,8 @@ class FieldMetaDocumentCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[DocumentValue2]] = None validation_rule: Annotated[ @@ -1873,6 +2118,8 @@ class FieldMetaDocumentCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[DocumentDirection2] = DocumentDirection2.VERTICAL + class DocumentTypeRadio(str, Enum): RADIO = "radio" @@ -1892,13 +2139,20 @@ class DocumentValue1(BaseModel): value: str +class DocumentDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldMetaDocumentRadioTypedDict(TypedDict): type: DocumentTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[DocumentValue1TypedDict]] + direction: NotRequired[DocumentDirection1] class FieldMetaDocumentRadio(BaseModel): @@ -1912,8 +2166,12 @@ class FieldMetaDocumentRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[DocumentValue1]] = None + direction: Optional[DocumentDirection1] = DocumentDirection1.VERTICAL + class DocumentTypeNumber(str, Enum): NUMBER = "number" @@ -1925,18 +2183,27 @@ class DocumentTextAlign6(str, Enum): RIGHT = "right" +class DocumentVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldMetaDocumentNumberTypedDict(TypedDict): type: DocumentTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[DocumentTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[DocumentVerticalAlign2]] class FieldMetaDocumentNumber(BaseModel): @@ -1950,20 +2217,89 @@ class FieldMetaDocumentNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[DocumentTextAlign6], pydantic.Field(alias="textAlign") ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[DocumentVerticalAlign2], pydantic.Field(alias="verticalAlign") + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -1975,16 +2311,25 @@ class DocumentTextAlign5(str, Enum): RIGHT = "right" +class DocumentVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldMetaDocumentTextTypedDict(TypedDict): type: DocumentTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[DocumentTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[DocumentVerticalAlign1]] class FieldMetaDocumentText(BaseModel): @@ -1998,18 +2343,72 @@ class FieldMetaDocumentText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[DocumentTextAlign5], pydantic.Field(alias="textAlign") ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[DocumentVerticalAlign1], pydantic.Field(alias="verticalAlign") + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 DocumentTypeDate(str, Enum): DATE = "date" @@ -2042,7 +2441,7 @@ class FieldMetaDocumentDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[DocumentTextAlign4], pydantic.Field(alias="textAlign") @@ -2080,7 +2479,7 @@ class FieldMetaDocumentEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[DocumentTextAlign3], pydantic.Field(alias="textAlign") @@ -2118,7 +2517,7 @@ class FieldMetaDocumentName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[DocumentTextAlign2], pydantic.Field(alias="textAlign") @@ -2156,21 +2555,49 @@ class FieldMetaDocumentInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[DocumentTextAlign1], pydantic.Field(alias="textAlign") ] = None +class DocumentTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldMetaDocumentSignatureTypedDict(TypedDict): + type: DocumentTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldMetaDocumentSignature(BaseModel): + type: DocumentTypeSignature + + 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")] = 12 + + DocumentFieldMetaUnionTypedDict = TypeAliasType( "DocumentFieldMetaUnionTypedDict", Union[ - FieldMetaDocumentRadioTypedDict, + FieldMetaDocumentSignatureTypedDict, FieldMetaDocumentInitialsTypedDict, FieldMetaDocumentNameTypedDict, FieldMetaDocumentEmailTypedDict, FieldMetaDocumentDateTypedDict, + FieldMetaDocumentRadioTypedDict, FieldMetaDocumentDropdownTypedDict, FieldMetaDocumentCheckboxTypedDict, FieldMetaDocumentTextTypedDict, @@ -2182,11 +2609,12 @@ class FieldMetaDocumentInitials(BaseModel): DocumentFieldMetaUnion = TypeAliasType( "DocumentFieldMetaUnion", Union[ - FieldMetaDocumentRadio, + FieldMetaDocumentSignature, FieldMetaDocumentInitials, FieldMetaDocumentName, FieldMetaDocumentEmail, FieldMetaDocumentDate, + FieldMetaDocumentRadio, FieldMetaDocumentDropdown, FieldMetaDocumentCheckbox, FieldMetaDocumentText, @@ -2196,38 +2624,46 @@ class FieldMetaDocumentInitials(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[DocumentFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -2237,18 +2673,18 @@ class DocumentField(BaseModel): Nullable[DocumentFieldMetaUnion], pydantic.Field(alias="fieldMeta") ] - position_x: Annotated[Optional[Any], pydantic.Field(alias="positionX")] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - position_y: Annotated[Optional[Any], pydantic.Field(alias="positionY")] = None - - width: Optional[Any] = None - - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -2276,34 +2712,35 @@ def serialize_model(self, handler): return m -class DocumentTypedDict(TypedDict): +class DocumentCreateDocumentTemporaryDocumentTypedDict(TypedDict): visibility: DocumentVisibility status: DocumentCreateDocumentTemporaryStatus source: DocumentCreateDocumentTemporarySource 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[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 + internal_version: float document_data: DocumentCreateDocumentTemporaryDocumentDataTypedDict - document_meta: Nullable[DocumentCreateDocumentTemporaryDocumentMetaTypedDict] + document_meta: DocumentCreateDocumentTemporaryDocumentMetaTypedDict + envelope_items: List[DocumentCreateDocumentTemporaryEnvelopeItemTypedDict] folder: Nullable[DocumentCreateDocumentTemporaryFolderTypedDict] recipients: List[DocumentRecipientTypedDict] fields: List[DocumentFieldTypedDict] + template_id: NotRequired[Nullable[float]] + document_data_id: NotRequired[str] -class Document(BaseModel): +class DocumentCreateDocumentTemporaryDocument(BaseModel): visibility: DocumentVisibility status: DocumentCreateDocumentTemporaryStatus @@ -2313,10 +2750,8 @@ class Document(BaseModel): id: float external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] - r"""A custom external ID you can use to identify the document.""" user_id: Annotated[float, pydantic.Field(alias="userId")] - r"""The ID of the user that created this document.""" auth_options: Annotated[ Nullable[DocumentCreateDocumentTemporaryAuthOptions], @@ -2329,8 +2764,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,38 +2774,52 @@ 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")] + + internal_version: Annotated[float, pydantic.Field(alias="internalVersion")] + document_data: Annotated[ DocumentCreateDocumentTemporaryDocumentData, pydantic.Field(alias="documentData"), ] document_meta: Annotated[ - Nullable[DocumentCreateDocumentTemporaryDocumentMeta], + DocumentCreateDocumentTemporaryDocumentMeta, pydantic.Field(alias="documentMeta"), ] + envelope_items: Annotated[ + List[DocumentCreateDocumentTemporaryEnvelopeItem], + pydantic.Field(alias="envelopeItems"), + ] + folder: Nullable[DocumentCreateDocumentTemporaryFolder] recipients: List[DocumentRecipient] fields: List[DocumentField] + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + + 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,15 +2852,13 @@ 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""" 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_createop.py b/src/documenso_sdk/models/document_createop.py new file mode 100644 index 0000000..3593864 --- /dev/null +++ b/src/documenso_sdk/models/document_createop.py @@ -0,0 +1,1513 @@ +"""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 documenso_sdk.utils import FieldMetadata, MultipartFormMetadata +from enum import Enum +import httpx +import io +import pydantic +from pydantic import model_serializer +from typing import Dict, IO, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict + + +class DocumentCreateVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class DocumentCreateGlobalAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class DocumentCreateGlobalActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +DocumentCreateFormValuesTypedDict = TypeAliasType( + "DocumentCreateFormValuesTypedDict", Union[str, bool, float] +) + + +DocumentCreateFormValues = TypeAliasType( + "DocumentCreateFormValues", Union[str, bool, float] +) + + +class DocumentCreateRole(str, Enum): + CC = "CC" + SIGNER = "SIGNER" + VIEWER = "VIEWER" + APPROVER = "APPROVER" + ASSISTANT = "ASSISTANT" + + +class DocumentCreateAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class DocumentCreateActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + EXPLICIT_NONE = "EXPLICIT_NONE" + + +class DocumentCreateTypeDropdown1(str, Enum): + DROPDOWN = "DROPDOWN" + + +class DocumentCreateTypeDropdown2(str, Enum): + DROPDOWN = "dropdown" + + +class DocumentCreateValueDropdownTypedDict(TypedDict): + value: str + + +class DocumentCreateValueDropdown(BaseModel): + value: str + + +class DocumentCreateFieldMetaDropdownTypedDict(TypedDict): + type: DocumentCreateTypeDropdown2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[DocumentCreateValueDropdownTypedDict]] + default_value: NotRequired[str] + + +class DocumentCreateFieldMetaDropdown(BaseModel): + type: DocumentCreateTypeDropdown2 + + 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")] = 12 + + values: Optional[List[DocumentCreateValueDropdown]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +class DocumentCreateFieldDropdownTypedDict(TypedDict): + type: DocumentCreateTypeDropdown1 + page_number: float + page_x: float + page_y: float + width: float + height: float + field_meta: NotRequired[DocumentCreateFieldMetaDropdownTypedDict] + + +class DocumentCreateFieldDropdown(BaseModel): + type: DocumentCreateTypeDropdown1 + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[DocumentCreateFieldMetaDropdown], pydantic.Field(alias="fieldMeta") + ] = None + + +class DocumentCreateTypeCheckbox1(str, Enum): + CHECKBOX = "CHECKBOX" + + +class DocumentCreateTypeCheckbox2(str, Enum): + CHECKBOX = "checkbox" + + +class DocumentCreateValueCheckboxTypedDict(TypedDict): + id: float + checked: bool + value: str + + +class DocumentCreateValueCheckbox(BaseModel): + id: float + + checked: bool + + value: str + + +class DocumentCreateDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class DocumentCreateFieldMetaCheckboxTypedDict(TypedDict): + type: DocumentCreateTypeCheckbox2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[DocumentCreateValueCheckboxTypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[DocumentCreateDirectionCheckbox] + + +class DocumentCreateFieldMetaCheckbox(BaseModel): + type: DocumentCreateTypeCheckbox2 + + 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")] = 12 + + values: Optional[List[DocumentCreateValueCheckbox]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[DocumentCreateDirectionCheckbox] = ( + DocumentCreateDirectionCheckbox.VERTICAL + ) + + +class DocumentCreateFieldCheckboxTypedDict(TypedDict): + type: DocumentCreateTypeCheckbox1 + page_number: float + page_x: float + page_y: float + width: float + height: float + field_meta: NotRequired[DocumentCreateFieldMetaCheckboxTypedDict] + + +class DocumentCreateFieldCheckbox(BaseModel): + type: DocumentCreateTypeCheckbox1 + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[DocumentCreateFieldMetaCheckbox], pydantic.Field(alias="fieldMeta") + ] = None + + +class DocumentCreateTypeRadio1(str, Enum): + RADIO = "RADIO" + + +class DocumentCreateTypeRadio2(str, Enum): + RADIO = "radio" + + +class DocumentCreateValueRadioTypedDict(TypedDict): + id: float + checked: bool + value: str + + +class DocumentCreateValueRadio(BaseModel): + id: float + + checked: bool + + value: str + + +class DocumentCreateDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class DocumentCreateFieldMetaRadioTypedDict(TypedDict): + type: DocumentCreateTypeRadio2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[DocumentCreateValueRadioTypedDict]] + direction: NotRequired[DocumentCreateDirectionRadio] + + +class DocumentCreateFieldMetaRadio(BaseModel): + type: DocumentCreateTypeRadio2 + + 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")] = 12 + + values: Optional[List[DocumentCreateValueRadio]] = None + + direction: Optional[DocumentCreateDirectionRadio] = ( + DocumentCreateDirectionRadio.VERTICAL + ) + + +class DocumentCreateFieldRadioTypedDict(TypedDict): + type: DocumentCreateTypeRadio1 + page_number: float + page_x: float + page_y: float + width: float + height: float + field_meta: NotRequired[DocumentCreateFieldMetaRadioTypedDict] + + +class DocumentCreateFieldRadio(BaseModel): + type: DocumentCreateTypeRadio1 + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[DocumentCreateFieldMetaRadio], pydantic.Field(alias="fieldMeta") + ] = None + + +class DocumentCreateTypeNumber1(str, Enum): + NUMBER = "NUMBER" + + +class DocumentCreateTypeNumber2(str, Enum): + NUMBER = "number" + + +class DocumentCreateTextAlignNumber(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class DocumentCreateVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class DocumentCreateFieldMetaNumberTypedDict(TypedDict): + type: DocumentCreateTypeNumber2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[DocumentCreateTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[DocumentCreateVerticalAlignNumber]] + + +class DocumentCreateFieldMetaNumber(BaseModel): + type: DocumentCreateTypeNumber2 + + 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")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[DocumentCreateTextAlignNumber], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[DocumentCreateVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 DocumentCreateFieldNumberTypedDict(TypedDict): + type: DocumentCreateTypeNumber1 + page_number: float + page_x: float + page_y: float + width: float + height: float + field_meta: NotRequired[DocumentCreateFieldMetaNumberTypedDict] + + +class DocumentCreateFieldNumber(BaseModel): + type: DocumentCreateTypeNumber1 + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[DocumentCreateFieldMetaNumber], pydantic.Field(alias="fieldMeta") + ] = None + + +class DocumentCreateTypeText1(str, Enum): + TEXT = "TEXT" + + +class DocumentCreateTypeText2(str, Enum): + TEXT = "text" + + +class DocumentCreateTextAlignText(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class DocumentCreateVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class DocumentCreateFieldMetaTextTypedDict(TypedDict): + type: DocumentCreateTypeText2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[DocumentCreateTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[DocumentCreateVerticalAlignText]] + + +class DocumentCreateFieldMetaText(BaseModel): + type: DocumentCreateTypeText2 + + 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")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[DocumentCreateTextAlignText], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[DocumentCreateVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 DocumentCreateFieldTextTypedDict(TypedDict): + type: DocumentCreateTypeText1 + page_number: float + page_x: float + page_y: float + width: float + height: float + field_meta: NotRequired[DocumentCreateFieldMetaTextTypedDict] + + +class DocumentCreateFieldText(BaseModel): + type: DocumentCreateTypeText1 + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[DocumentCreateFieldMetaText], pydantic.Field(alias="fieldMeta") + ] = None + + +class DocumentCreateTypeDate1(str, Enum): + DATE = "DATE" + + +class DocumentCreateTypeDate2(str, Enum): + DATE = "date" + + +class DocumentCreateTextAlignDate(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class DocumentCreateFieldMetaDateTypedDict(TypedDict): + type: DocumentCreateTypeDate2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[DocumentCreateTextAlignDate] + + +class DocumentCreateFieldMetaDate(BaseModel): + type: DocumentCreateTypeDate2 + + 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")] = 12 + + text_align: Annotated[ + Optional[DocumentCreateTextAlignDate], pydantic.Field(alias="textAlign") + ] = None + + +class DocumentCreateFieldDateTypedDict(TypedDict): + type: DocumentCreateTypeDate1 + page_number: float + page_x: float + page_y: float + width: float + height: float + field_meta: NotRequired[DocumentCreateFieldMetaDateTypedDict] + + +class DocumentCreateFieldDate(BaseModel): + type: DocumentCreateTypeDate1 + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[DocumentCreateFieldMetaDate], pydantic.Field(alias="fieldMeta") + ] = None + + +class DocumentCreateTypeEmail1(str, Enum): + EMAIL = "EMAIL" + + +class DocumentCreateTypeEmail2(str, Enum): + EMAIL = "email" + + +class DocumentCreateTextAlignEmail(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class DocumentCreateFieldMetaEmailTypedDict(TypedDict): + type: DocumentCreateTypeEmail2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[DocumentCreateTextAlignEmail] + + +class DocumentCreateFieldMetaEmail(BaseModel): + type: DocumentCreateTypeEmail2 + + 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")] = 12 + + text_align: Annotated[ + Optional[DocumentCreateTextAlignEmail], pydantic.Field(alias="textAlign") + ] = None + + +class DocumentCreateFieldEmailTypedDict(TypedDict): + type: DocumentCreateTypeEmail1 + page_number: float + page_x: float + page_y: float + width: float + height: float + field_meta: NotRequired[DocumentCreateFieldMetaEmailTypedDict] + + +class DocumentCreateFieldEmail(BaseModel): + type: DocumentCreateTypeEmail1 + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[DocumentCreateFieldMetaEmail], pydantic.Field(alias="fieldMeta") + ] = None + + +class DocumentCreateTypeName1(str, Enum): + NAME = "NAME" + + +class DocumentCreateTypeName2(str, Enum): + NAME = "name" + + +class DocumentCreateTextAlignName(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class DocumentCreateFieldMetaNameTypedDict(TypedDict): + type: DocumentCreateTypeName2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[DocumentCreateTextAlignName] + + +class DocumentCreateFieldMetaName(BaseModel): + type: DocumentCreateTypeName2 + + 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")] = 12 + + text_align: Annotated[ + Optional[DocumentCreateTextAlignName], pydantic.Field(alias="textAlign") + ] = None + + +class DocumentCreateFieldNameTypedDict(TypedDict): + type: DocumentCreateTypeName1 + page_number: float + page_x: float + page_y: float + width: float + height: float + field_meta: NotRequired[DocumentCreateFieldMetaNameTypedDict] + + +class DocumentCreateFieldName(BaseModel): + type: DocumentCreateTypeName1 + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[DocumentCreateFieldMetaName], pydantic.Field(alias="fieldMeta") + ] = None + + +class DocumentCreateTypeInitials1(str, Enum): + INITIALS = "INITIALS" + + +class DocumentCreateTypeInitials2(str, Enum): + INITIALS = "initials" + + +class DocumentCreateTextAlignInitials(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class DocumentCreateFieldMetaInitialsTypedDict(TypedDict): + type: DocumentCreateTypeInitials2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[DocumentCreateTextAlignInitials] + + +class DocumentCreateFieldMetaInitials(BaseModel): + type: DocumentCreateTypeInitials2 + + 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")] = 12 + + text_align: Annotated[ + Optional[DocumentCreateTextAlignInitials], pydantic.Field(alias="textAlign") + ] = None + + +class DocumentCreateFieldInitialsTypedDict(TypedDict): + type: DocumentCreateTypeInitials1 + page_number: float + page_x: float + page_y: float + width: float + height: float + field_meta: NotRequired[DocumentCreateFieldMetaInitialsTypedDict] + + +class DocumentCreateFieldInitials(BaseModel): + type: DocumentCreateTypeInitials1 + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[DocumentCreateFieldMetaInitials], pydantic.Field(alias="fieldMeta") + ] = None + + +class DocumentCreateTypeFreeSignature(str, Enum): + FREE_SIGNATURE = "FREE_SIGNATURE" + + +class DocumentCreateFieldFreeSignatureTypedDict(TypedDict): + type: DocumentCreateTypeFreeSignature + page_number: float + page_x: float + page_y: float + width: float + height: float + + +class DocumentCreateFieldFreeSignature(BaseModel): + type: DocumentCreateTypeFreeSignature + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + +class DocumentCreateTypeSignature1(str, Enum): + SIGNATURE = "SIGNATURE" + + +class DocumentCreateTypeSignature2(str, Enum): + SIGNATURE = "signature" + + +class DocumentCreateFieldMetaSignatureTypedDict(TypedDict): + type: DocumentCreateTypeSignature2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class DocumentCreateFieldMetaSignature(BaseModel): + type: DocumentCreateTypeSignature2 + + 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")] = 12 + + +class DocumentCreateFieldSignatureTypedDict(TypedDict): + type: DocumentCreateTypeSignature1 + page_number: float + page_x: float + page_y: float + width: float + height: float + field_meta: NotRequired[DocumentCreateFieldMetaSignatureTypedDict] + + +class DocumentCreateFieldSignature(BaseModel): + type: DocumentCreateTypeSignature1 + + page_number: Annotated[float, pydantic.Field(alias="pageNumber")] + + page_x: Annotated[float, pydantic.Field(alias="pageX")] + + page_y: Annotated[float, pydantic.Field(alias="pageY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[DocumentCreateFieldMetaSignature], pydantic.Field(alias="fieldMeta") + ] = None + + +DocumentCreateFieldUnionTypedDict = TypeAliasType( + "DocumentCreateFieldUnionTypedDict", + Union[ + DocumentCreateFieldFreeSignatureTypedDict, + DocumentCreateFieldSignatureTypedDict, + DocumentCreateFieldInitialsTypedDict, + DocumentCreateFieldNameTypedDict, + DocumentCreateFieldEmailTypedDict, + DocumentCreateFieldDateTypedDict, + DocumentCreateFieldTextTypedDict, + DocumentCreateFieldNumberTypedDict, + DocumentCreateFieldRadioTypedDict, + DocumentCreateFieldCheckboxTypedDict, + DocumentCreateFieldDropdownTypedDict, + ], +) + + +DocumentCreateFieldUnion = TypeAliasType( + "DocumentCreateFieldUnion", + Union[ + DocumentCreateFieldFreeSignature, + DocumentCreateFieldSignature, + DocumentCreateFieldInitials, + DocumentCreateFieldName, + DocumentCreateFieldEmail, + DocumentCreateFieldDate, + DocumentCreateFieldText, + DocumentCreateFieldNumber, + DocumentCreateFieldRadio, + DocumentCreateFieldCheckbox, + DocumentCreateFieldDropdown, + ], +) + + +class DocumentCreateRecipientTypedDict(TypedDict): + email: str + name: str + role: DocumentCreateRole + signing_order: NotRequired[float] + access_auth: NotRequired[List[DocumentCreateAccessAuth]] + action_auth: NotRequired[List[DocumentCreateActionAuth]] + fields: NotRequired[List[DocumentCreateFieldUnionTypedDict]] + + +class DocumentCreateRecipient(BaseModel): + email: str + + name: str + + role: DocumentCreateRole + + signing_order: Annotated[Optional[float], pydantic.Field(alias="signingOrder")] = ( + None + ) + + access_auth: Annotated[ + Optional[List[DocumentCreateAccessAuth]], pydantic.Field(alias="accessAuth") + ] = None + + action_auth: Annotated[ + Optional[List[DocumentCreateActionAuth]], pydantic.Field(alias="actionAuth") + ] = None + + fields: Optional[List[DocumentCreateFieldUnion]] = None + + +class DocumentCreateTypeLink(str, Enum): + LINK = "link" + + +class DocumentCreateAttachmentTypedDict(TypedDict): + label: str + data: str + type: NotRequired[DocumentCreateTypeLink] + + +class DocumentCreateAttachment(BaseModel): + label: str + + data: str + + type: Optional[DocumentCreateTypeLink] = DocumentCreateTypeLink.LINK + + +class DocumentCreateDateFormat(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 DocumentCreateDistributionMethod(str, Enum): + EMAIL = "EMAIL" + NONE = "NONE" + + +class DocumentCreateSigningOrder(str, Enum): + PARALLEL = "PARALLEL" + SEQUENTIAL = "SEQUENTIAL" + + +class DocumentCreateLanguage(str, Enum): + DE = "de" + EN = "en" + FR = "fr" + ES = "es" + IT = "it" + PL = "pl" + + +class DocumentCreateEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class DocumentCreateEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class DocumentCreateMetaTypedDict(TypedDict): + subject: NotRequired[str] + message: NotRequired[str] + timezone: NotRequired[str] + date_format: NotRequired[DocumentCreateDateFormat] + distribution_method: NotRequired[DocumentCreateDistributionMethod] + signing_order: NotRequired[DocumentCreateSigningOrder] + allow_dictate_next_signer: NotRequired[bool] + redirect_url: NotRequired[str] + language: NotRequired[DocumentCreateLanguage] + typed_signature_enabled: NotRequired[bool] + upload_signature_enabled: NotRequired[bool] + draw_signature_enabled: NotRequired[bool] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[Nullable[DocumentCreateEmailSettingsTypedDict]] + + +class DocumentCreateMeta(BaseModel): + subject: Optional[str] = None + + message: Optional[str] = None + + timezone: Optional[str] = None + + date_format: Annotated[ + Optional[DocumentCreateDateFormat], pydantic.Field(alias="dateFormat") + ] = None + + distribution_method: Annotated[ + Optional[DocumentCreateDistributionMethod], + pydantic.Field(alias="distributionMethod"), + ] = None + + signing_order: Annotated[ + Optional[DocumentCreateSigningOrder], 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 + + language: Optional[DocumentCreateLanguage] = None + + typed_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="typedSignatureEnabled") + ] = None + + upload_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="uploadSignatureEnabled") + ] = None + + draw_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="drawSignatureEnabled") + ] = None + + email_id: Annotated[OptionalNullable[str], pydantic.Field(alias="emailId")] = UNSET + + email_reply_to: Annotated[ + OptionalNullable[str], pydantic.Field(alias="emailReplyTo") + ] = UNSET + + email_settings: Annotated[ + OptionalNullable[DocumentCreateEmailSettings], + pydantic.Field(alias="emailSettings"), + ] = 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 DocumentCreatePayloadTypedDict(TypedDict): + title: str + external_id: NotRequired[str] + visibility: NotRequired[DocumentCreateVisibility] + global_access_auth: NotRequired[List[DocumentCreateGlobalAccessAuth]] + global_action_auth: NotRequired[List[DocumentCreateGlobalActionAuth]] + form_values: NotRequired[Dict[str, DocumentCreateFormValuesTypedDict]] + folder_id: NotRequired[str] + recipients: NotRequired[List[DocumentCreateRecipientTypedDict]] + attachments: NotRequired[List[DocumentCreateAttachmentTypedDict]] + meta: NotRequired[DocumentCreateMetaTypedDict] + + +class DocumentCreatePayload(BaseModel): + title: str + + external_id: Annotated[Optional[str], pydantic.Field(alias="externalId")] = None + + visibility: Optional[DocumentCreateVisibility] = None + + global_access_auth: Annotated[ + Optional[List[DocumentCreateGlobalAccessAuth]], + pydantic.Field(alias="globalAccessAuth"), + ] = None + + global_action_auth: Annotated[ + Optional[List[DocumentCreateGlobalActionAuth]], + pydantic.Field(alias="globalActionAuth"), + ] = None + + form_values: Annotated[ + Optional[Dict[str, DocumentCreateFormValues]], + pydantic.Field(alias="formValues"), + ] = None + + folder_id: Annotated[Optional[str], pydantic.Field(alias="folderId")] = None + + recipients: Optional[List[DocumentCreateRecipient]] = None + + attachments: Optional[List[DocumentCreateAttachment]] = None + + meta: Optional[DocumentCreateMeta] = None + + +class DocumentCreateFileTypedDict(TypedDict): + file_name: str + content: Union[bytes, IO[bytes], io.BufferedReader] + content_type: NotRequired[str] + + +class DocumentCreateFile(BaseModel): + file_name: Annotated[ + str, pydantic.Field(alias="fileName"), FieldMetadata(multipart=True) + ] + + content: Annotated[ + Union[bytes, IO[bytes], io.BufferedReader], + pydantic.Field(alias=""), + FieldMetadata(multipart=MultipartFormMetadata(content=True)), + ] + + content_type: Annotated[ + Optional[str], + pydantic.Field(alias="Content-Type"), + FieldMetadata(multipart=True), + ] = None + + +class DocumentCreateRequestTypedDict(TypedDict): + payload: DocumentCreatePayloadTypedDict + file: DocumentCreateFileTypedDict + + +class DocumentCreateRequest(BaseModel): + payload: Annotated[ + DocumentCreatePayload, FieldMetadata(multipart=MultipartFormMetadata(json=True)) + ] + + file: Annotated[ + DocumentCreateFile, FieldMetadata(multipart=MultipartFormMetadata(file=True)) + ] + + +class DocumentCreateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentCreateInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentCreateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentCreateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentCreateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentCreateInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: DocumentCreateInternalServerErrorData, + 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 DocumentCreateForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentCreateForbiddenIssue(BaseModel): + message: str + + +class DocumentCreateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentCreateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentCreateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentCreateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentCreateForbiddenErrorData, + 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 DocumentCreateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentCreateUnauthorizedIssue(BaseModel): + message: str + + +class DocumentCreateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentCreateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentCreateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentCreateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentCreateUnauthorizedErrorData, + 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 DocumentCreateBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentCreateBadRequestIssue(BaseModel): + message: str + + +class DocumentCreateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentCreateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentCreateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentCreateBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: DocumentCreateBadRequestErrorData, + 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 DocumentCreateResponseTypedDict(TypedDict): + r"""Successful response""" + + envelope_id: str + id: float + + +class DocumentCreateResponse(BaseModel): + r"""Successful response""" + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + id: float diff --git a/src/documenso_sdk/models/document_deletedocumentop.py b/src/documenso_sdk/models/document_deletedocumentop.py deleted file mode 100644 index 0581b79..0000000 --- a/src/documenso_sdk/models/document_deletedocumentop.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 DocumentDeleteDocumentRequestTypedDict(TypedDict): - document_id: float - - -class DocumentDeleteDocumentRequest(BaseModel): - document_id: Annotated[float, pydantic.Field(alias="documentId")] - - -class DocumentDeleteDocumentInternalServerErrorIssueTypedDict(TypedDict): - message: str - - -class DocumentDeleteDocumentInternalServerErrorIssue(BaseModel): - message: str - - -class DocumentDeleteDocumentInternalServerErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentDeleteDocumentInternalServerErrorIssue]] = None - - -class DocumentDeleteDocumentInternalServerError(DocumensoError): - r"""Internal server error""" - - data: DocumentDeleteDocumentInternalServerErrorData - - def __init__( - self, - data: DocumentDeleteDocumentInternalServerErrorData, - 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 DocumentDeleteDocumentBadRequestIssueTypedDict(TypedDict): - message: str - - -class DocumentDeleteDocumentBadRequestIssue(BaseModel): - message: str - - -class DocumentDeleteDocumentBadRequestErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentDeleteDocumentBadRequestIssue]] = None - - -class DocumentDeleteDocumentBadRequestError(DocumensoError): - r"""Invalid input data""" - - data: DocumentDeleteDocumentBadRequestErrorData - - def __init__( - self, - data: DocumentDeleteDocumentBadRequestErrorData, - 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 DocumentDeleteDocumentResponseTypedDict(TypedDict): - r"""Successful response""" - - success: bool - - -class DocumentDeleteDocumentResponse(BaseModel): - r"""Successful response""" - - success: bool diff --git a/src/documenso_sdk/models/document_deleteop.py b/src/documenso_sdk/models/document_deleteop.py new file mode 100644 index 0000000..df23a7d --- /dev/null +++ b/src/documenso_sdk/models/document_deleteop.py @@ -0,0 +1,166 @@ +"""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 DocumentDeleteRequestTypedDict(TypedDict): + document_id: float + + +class DocumentDeleteRequest(BaseModel): + document_id: Annotated[float, pydantic.Field(alias="documentId")] + + +class DocumentDeleteInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentDeleteInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentDeleteInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDeleteInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDeleteInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentDeleteInternalServerErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentDeleteForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentDeleteForbiddenIssue(BaseModel): + message: str + + +class DocumentDeleteForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDeleteForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDeleteForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentDeleteForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDeleteForbiddenErrorData, + 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 DocumentDeleteUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentDeleteUnauthorizedIssue(BaseModel): + message: str + + +class DocumentDeleteUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDeleteUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDeleteUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentDeleteUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDeleteUnauthorizedErrorData, + 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 DocumentDeleteBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentDeleteBadRequestIssue(BaseModel): + message: str + + +class DocumentDeleteBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDeleteBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDeleteBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentDeleteBadRequestErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentDeleteResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class DocumentDeleteResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/document_distributeop.py b/src/documenso_sdk/models/document_distributeop.py new file mode 100644 index 0000000..ec8e5c1 --- /dev/null +++ b/src/documenso_sdk/models/document_distributeop.py @@ -0,0 +1,505 @@ +"""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 Dict, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict + + +class DocumentDistributeDateFormat(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): + EMAIL = "EMAIL" + NONE = "NONE" + + +class DocumentDistributeLanguage(str, Enum): + DE = "de" + EN = "en" + FR = "fr" + ES = "es" + IT = "it" + PL = "pl" + + +class DocumentDistributeEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class DocumentDistributeEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class DocumentDistributeMetaTypedDict(TypedDict): + subject: NotRequired[str] + message: NotRequired[str] + timezone: NotRequired[str] + date_format: NotRequired[DocumentDistributeDateFormat] + distribution_method: NotRequired[DocumentDistributeDistributionMethod] + redirect_url: NotRequired[str] + language: NotRequired[DocumentDistributeLanguage] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[DocumentDistributeEmailSettingsTypedDict] + + +class DocumentDistributeMeta(BaseModel): + subject: Optional[str] = None + + message: Optional[str] = None + + timezone: Optional[str] = None + + date_format: Annotated[ + Optional[DocumentDistributeDateFormat], pydantic.Field(alias="dateFormat") + ] = None + + distribution_method: Annotated[ + Optional[DocumentDistributeDistributionMethod], + pydantic.Field(alias="distributionMethod"), + ] = None + + redirect_url: Annotated[Optional[str], pydantic.Field(alias="redirectUrl")] = None + + language: Optional[DocumentDistributeLanguage] = None + + 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[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 + + return m + + +class DocumentDistributeRequestTypedDict(TypedDict): + document_id: float + meta: NotRequired[DocumentDistributeMetaTypedDict] + + +class DocumentDistributeRequest(BaseModel): + document_id: Annotated[float, pydantic.Field(alias="documentId")] + + meta: Optional[DocumentDistributeMeta] = None + + +class DocumentDistributeInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentDistributeInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentDistributeInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDistributeInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDistributeInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentDistributeInternalServerErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentDistributeForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentDistributeForbiddenIssue(BaseModel): + message: str + + +class DocumentDistributeForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDistributeForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDistributeForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentDistributeForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDistributeForbiddenErrorData, + 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 DocumentDistributeUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentDistributeUnauthorizedIssue(BaseModel): + message: str + + +class DocumentDistributeUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDistributeUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDistributeUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentDistributeUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDistributeUnauthorizedErrorData, + 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 DocumentDistributeBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentDistributeBadRequestIssue(BaseModel): + message: str + + +class DocumentDistributeBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDistributeBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDistributeBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentDistributeBadRequestErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentDistributeVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class DocumentDistributeStatus(str, Enum): + DRAFT = "DRAFT" + PENDING = "PENDING" + COMPLETED = "COMPLETED" + REJECTED = "REJECTED" + + +class DocumentDistributeSource(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" + + +class DocumentDistributeGlobalAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class DocumentDistributeGlobalActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class DocumentDistributeAuthOptionsTypedDict(TypedDict): + global_access_auth: List[DocumentDistributeGlobalAccessAuth] + global_action_auth: List[DocumentDistributeGlobalActionAuth] + + +class DocumentDistributeAuthOptions(BaseModel): + global_access_auth: Annotated[ + List[DocumentDistributeGlobalAccessAuth], + pydantic.Field(alias="globalAccessAuth"), + ] + + global_action_auth: Annotated[ + List[DocumentDistributeGlobalActionAuth], + pydantic.Field(alias="globalActionAuth"), + ] + + +DocumentDistributeFormValuesTypedDict = TypeAliasType( + "DocumentDistributeFormValuesTypedDict", Union[str, bool, float] +) + + +DocumentDistributeFormValues = TypeAliasType( + "DocumentDistributeFormValues", Union[str, bool, float] +) + + +class DocumentDistributeResponseTypedDict(TypedDict): + r"""Successful response""" + + visibility: DocumentDistributeVisibility + status: DocumentDistributeStatus + source: DocumentDistributeSource + id: float + external_id: Nullable[str] + user_id: float + auth_options: Nullable[DocumentDistributeAuthOptionsTypedDict] + form_values: Nullable[Dict[str, DocumentDistributeFormValuesTypedDict]] + title: str + created_at: str + updated_at: str + completed_at: Nullable[str] + deleted_at: Nullable[str] + team_id: float + folder_id: Nullable[str] + use_legacy_field_insertion: bool + envelope_id: str + internal_version: float + document_data_id: NotRequired[str] + template_id: NotRequired[Nullable[float]] + + +class DocumentDistributeResponse(BaseModel): + r"""Successful response""" + + visibility: DocumentDistributeVisibility + + status: DocumentDistributeStatus + + source: DocumentDistributeSource + + id: float + + external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] + + user_id: Annotated[float, pydantic.Field(alias="userId")] + + auth_options: Annotated[ + Nullable[DocumentDistributeAuthOptions], pydantic.Field(alias="authOptions") + ] + + form_values: Annotated[ + Nullable[Dict[str, DocumentDistributeFormValues]], + pydantic.Field(alias="formValues"), + ] + + title: str + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] + + completed_at: Annotated[Nullable[str], pydantic.Field(alias="completedAt")] + + deleted_at: Annotated[Nullable[str], pydantic.Field(alias="deletedAt")] + + team_id: Annotated[float, pydantic.Field(alias="teamId")] + + 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")] + + internal_version: Annotated[float, pydantic.Field(alias="internalVersion")] + + document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="documentDataId") + ] = "" + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["documentDataId", "templateId"] + nullable_fields = [ + "externalId", + "authOptions", + "formValues", + "completedAt", + "deletedAt", + "folderId", + "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 diff --git a/src/documenso_sdk/models/document_downloadbetaop.py b/src/documenso_sdk/models/document_downloadbetaop.py new file mode 100644 index 0000000..5f46ba8 --- /dev/null +++ b/src/documenso_sdk/models/document_downloadbetaop.py @@ -0,0 +1,229 @@ +"""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 DocumentDownloadBetaVersion(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 DocumentDownloadBetaRequestTypedDict(TypedDict): + document_id: float + r"""The ID of the document to download.""" + version: NotRequired[DocumentDownloadBetaVersion] + r"""The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.""" + + +class DocumentDownloadBetaRequest(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[DocumentDownloadBetaVersion], + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = DocumentDownloadBetaVersion.SIGNED + r"""The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.""" + + +class DocumentDownloadBetaInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentDownloadBetaInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentDownloadBetaInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDownloadBetaInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDownloadBetaInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentDownloadBetaInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDownloadBetaInternalServerErrorData, + 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 DocumentDownloadBetaNotFoundIssueTypedDict(TypedDict): + message: str + + +class DocumentDownloadBetaNotFoundIssue(BaseModel): + message: str + + +class DocumentDownloadBetaNotFoundErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDownloadBetaNotFoundIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDownloadBetaNotFoundError(DocumensoError): + r"""Not found""" + + data: DocumentDownloadBetaNotFoundErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDownloadBetaNotFoundErrorData, + 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 DocumentDownloadBetaForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentDownloadBetaForbiddenIssue(BaseModel): + message: str + + +class DocumentDownloadBetaForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDownloadBetaForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDownloadBetaForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentDownloadBetaForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDownloadBetaForbiddenErrorData, + 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 DocumentDownloadBetaUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentDownloadBetaUnauthorizedIssue(BaseModel): + message: str + + +class DocumentDownloadBetaUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDownloadBetaUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDownloadBetaUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentDownloadBetaUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDownloadBetaUnauthorizedErrorData, + 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 DocumentDownloadBetaBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentDownloadBetaBadRequestIssue(BaseModel): + message: str + + +class DocumentDownloadBetaBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDownloadBetaBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDownloadBetaBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentDownloadBetaBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDownloadBetaBadRequestErrorData, + 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 DocumentDownloadBetaResponseTypedDict(TypedDict): + r"""Successful response""" + + download_url: str + filename: str + content_type: str + + +class DocumentDownloadBetaResponse(BaseModel): + r"""Successful response""" + + download_url: Annotated[str, pydantic.Field(alias="downloadUrl")] + + filename: str + + content_type: Annotated[str, pydantic.Field(alias="contentType")] diff --git a/src/documenso_sdk/models/document_downloadop.py b/src/documenso_sdk/models/document_downloadop.py new file mode 100644 index 0000000..7124ed5 --- /dev/null +++ b/src/documenso_sdk/models/document_downloadop.py @@ -0,0 +1,222 @@ +"""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 Any, Dict, List, Optional +from typing_extensions import Annotated, NotRequired, TypedDict + + +class DocumentDownloadVersion(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[DocumentDownloadVersion] + 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[DocumentDownloadVersion], + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = DocumentDownloadVersion.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 DocumentDownloadForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentDownloadForbiddenIssue(BaseModel): + message: str + + +class DocumentDownloadForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDownloadForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDownloadForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentDownloadForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDownloadForbiddenErrorData, + 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 DocumentDownloadUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentDownloadUnauthorizedIssue(BaseModel): + message: str + + +class DocumentDownloadUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDownloadUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDownloadUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentDownloadUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDownloadUnauthorizedErrorData, + 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): + headers: Dict[str, List[str]] + result: Any + + +class DocumentDownloadResponse(BaseModel): + headers: Dict[str, List[str]] + + result: Any 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..1f92753 --- /dev/null +++ b/src/documenso_sdk/models/document_duplicateop.py @@ -0,0 +1,169 @@ +"""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 DocumentDuplicateForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentDuplicateForbiddenIssue(BaseModel): + message: str + + +class DocumentDuplicateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDuplicateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDuplicateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentDuplicateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDuplicateForbiddenErrorData, + 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 DocumentDuplicateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentDuplicateUnauthorizedIssue(BaseModel): + message: str + + +class DocumentDuplicateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentDuplicateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentDuplicateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentDuplicateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentDuplicateUnauthorizedErrorData, + 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 + document_id: float + + +class DocumentDuplicateResponse(BaseModel): + r"""Successful response""" + + id: str + + document_id: Annotated[float, pydantic.Field(alias="documentId")] diff --git a/src/documenso_sdk/models/document_finddocumentsop.py b/src/documenso_sdk/models/document_findop.py similarity index 61% rename from src/documenso_sdk/models/document_finddocumentsop.py rename to src/documenso_sdk/models/document_findop.py index 69c2345..711f340 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,177 @@ 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: 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) + object.__setattr__(self, "data", data) + + +class DocumentFindForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentFindForbiddenIssue(BaseModel): + message: str + + +class DocumentFindForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentFindForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentFindForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentFindForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentFindForbiddenErrorData, + 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 DocumentFindUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentFindUnauthorizedIssue(BaseModel): + message: str + + +class DocumentFindUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentFindUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentFindUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentFindUnauthorizedErrorData = field(hash=False) def __init__( self, - data: DocumentFindDocumentsNotFoundErrorData, + data: DocumentFindUnauthorizedErrorData, 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,55 +312,50 @@ class DataSource(str, Enum): TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" -class DocumentFindDocumentsGlobalAccessAuth(str, Enum): - r"""The type of authentication required for the recipient to access the document.""" - +class DocumentFindGlobalAccessAuth(str, Enum): ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" -class DocumentFindDocumentsGlobalActionAuth(str, Enum): - r"""The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only.""" - +class DocumentFindGlobalActionAuth(str, Enum): ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" 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 +393,7 @@ def serialize_model(self, handler): return m -class DocumentFindDocumentsRole(str, Enum): +class DocumentFindRole(str, Enum): CC = "CC" SIGNER = "SIGNER" VIEWER = "VIEWER" @@ -328,31 +401,28 @@ 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): - r"""The type of authentication required for the recipient to access the document.""" - +class DocumentFindAccessAuth(str, Enum): ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" -class DocumentFindDocumentsActionAuth(str, Enum): - r"""The type of authentication required for the recipient to sign the document.""" - +class DocumentFindActionAuth(str, Enum): ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -360,62 +430,56 @@ 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,27 +495,33 @@ 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")] - 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 = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -480,45 +550,45 @@ 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 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[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 + internal_version: float + user: DocumentFindUserTypedDict + recipients: List[DocumentFindRecipientTypedDict] + team: Nullable[DocumentFindTeamTypedDict] + document_data_id: NotRequired[str] + template_id: NotRequired[Nullable[float]] -class DocumentFindDocumentsData(BaseModel): - visibility: DocumentFindDocumentsVisibility +class DocumentFindData(BaseModel): + visibility: DocumentFindVisibility status: DataStatus @@ -527,24 +597,19 @@ class DocumentFindDocumentsData(BaseModel): id: float external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] - r"""A custom external ID you can use to identify the document.""" user_id: Annotated[float, pydantic.Field(alias="userId")] - 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 +620,41 @@ 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")] - recipients: List[DocumentFindDocumentsRecipient] + internal_version: Annotated[float, pydantic.Field(alias="internalVersion")] - team: Nullable[DocumentFindDocumentsTeam] + user: DocumentFindUser + + recipients: List[DocumentFindRecipient] + + team: Nullable[DocumentFindTeam] + + document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="documentDataId") + ] = "" + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET @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,33 +684,25 @@ 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 - r"""The current page number, starts at 1.""" per_page: float - r"""The number of items per page.""" total_pages: float - 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.""" current_page: Annotated[float, pydantic.Field(alias="currentPage")] - r"""The current page number, starts at 1.""" per_page: Annotated[float, pydantic.Field(alias="perPage")] - r"""The number of items per page.""" total_pages: Annotated[float, pydantic.Field(alias="totalPages")] - r"""The total number of pages.""" diff --git a/src/documenso_sdk/models/document_getdocumentwithdetailsbyidop.py b/src/documenso_sdk/models/document_getdocumentwithdetailsbyidop.py deleted file mode 100644 index 4873cb5..0000000 --- a/src/documenso_sdk/models/document_getdocumentwithdetailsbyidop.py +++ /dev/null @@ -1,1276 +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, Nullable, UNSET_SENTINEL -from documenso_sdk.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata -from enum import Enum -import httpx -import pydantic -from pydantic import model_serializer -from typing import Any, Dict, List, Optional, Union -from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict - - -class DocumentGetDocumentWithDetailsByIDRequestTypedDict(TypedDict): - document_id: float - folder_id: NotRequired[str] - r"""Filter documents by folder ID""" - - -class DocumentGetDocumentWithDetailsByIDRequest(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): - message: str - - -class DocumentGetDocumentWithDetailsByIDInternalServerErrorIssue(BaseModel): - message: str - - -class DocumentGetDocumentWithDetailsByIDInternalServerErrorData(BaseModel): - message: str - - code: str - - issues: Optional[ - List[DocumentGetDocumentWithDetailsByIDInternalServerErrorIssue] - ] = None - - -class DocumentGetDocumentWithDetailsByIDInternalServerError(DocumensoError): - r"""Internal server error""" - - data: DocumentGetDocumentWithDetailsByIDInternalServerErrorData - - def __init__( - self, - data: DocumentGetDocumentWithDetailsByIDInternalServerErrorData, - 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 DocumentGetDocumentWithDetailsByIDNotFoundIssueTypedDict(TypedDict): - message: str - - -class DocumentGetDocumentWithDetailsByIDNotFoundIssue(BaseModel): - message: str - - -class DocumentGetDocumentWithDetailsByIDNotFoundErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentGetDocumentWithDetailsByIDNotFoundIssue]] = None - - -class DocumentGetDocumentWithDetailsByIDNotFoundError(DocumensoError): - r"""Not found""" - - data: DocumentGetDocumentWithDetailsByIDNotFoundErrorData - - def __init__( - self, - data: DocumentGetDocumentWithDetailsByIDNotFoundErrorData, - 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 DocumentGetDocumentWithDetailsByIDBadRequestIssueTypedDict(TypedDict): - message: str - - -class DocumentGetDocumentWithDetailsByIDBadRequestIssue(BaseModel): - message: str - - -class DocumentGetDocumentWithDetailsByIDBadRequestErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentGetDocumentWithDetailsByIDBadRequestIssue]] = None - - -class DocumentGetDocumentWithDetailsByIDBadRequestError(DocumensoError): - r"""Invalid input data""" - - data: DocumentGetDocumentWithDetailsByIDBadRequestErrorData - - def __init__( - self, - data: DocumentGetDocumentWithDetailsByIDBadRequestErrorData, - 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 DocumentGetDocumentWithDetailsByIDVisibility(str, Enum): - EVERYONE = "EVERYONE" - MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" - ADMIN = "ADMIN" - - -class DocumentGetDocumentWithDetailsByIDStatus(str, Enum): - DRAFT = "DRAFT" - PENDING = "PENDING" - COMPLETED = "COMPLETED" - REJECTED = "REJECTED" - - -class DocumentGetDocumentWithDetailsByIDSource(str, Enum): - DOCUMENT = "DOCUMENT" - TEMPLATE = "TEMPLATE" - TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" - - -class DocumentGetDocumentWithDetailsByIDGlobalAccessAuth(str, Enum): - r"""The type of authentication required for the recipient to access the document.""" - - ACCOUNT = "ACCOUNT" - - -class DocumentGetDocumentWithDetailsByIDGlobalActionAuth(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 DocumentGetDocumentWithDetailsByIDAuthOptionsTypedDict(TypedDict): - global_access_auth: List[DocumentGetDocumentWithDetailsByIDGlobalAccessAuth] - global_action_auth: List[DocumentGetDocumentWithDetailsByIDGlobalActionAuth] - - -class DocumentGetDocumentWithDetailsByIDAuthOptions(BaseModel): - global_access_auth: Annotated[ - List[DocumentGetDocumentWithDetailsByIDGlobalAccessAuth], - pydantic.Field(alias="globalAccessAuth"), - ] - - global_action_auth: Annotated[ - List[DocumentGetDocumentWithDetailsByIDGlobalActionAuth], - pydantic.Field(alias="globalActionAuth"), - ] - - -DocumentGetDocumentWithDetailsByIDFormValuesTypedDict = TypeAliasType( - "DocumentGetDocumentWithDetailsByIDFormValuesTypedDict", Union[str, bool, float] -) - - -DocumentGetDocumentWithDetailsByIDFormValues = TypeAliasType( - "DocumentGetDocumentWithDetailsByIDFormValues", Union[str, bool, float] -) - - -class DocumentGetDocumentWithDetailsByIDDocumentDataType(str, Enum): - S3_PATH = "S3_PATH" - BYTES = "BYTES" - BYTES_64 = "BYTES_64" - - -class DocumentGetDocumentWithDetailsByIDDocumentDataTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDDocumentDataType - id: str - data: str - initial_data: str - - -class DocumentGetDocumentWithDetailsByIDDocumentData(BaseModel): - type: DocumentGetDocumentWithDetailsByIDDocumentDataType - - id: str - - data: str - - initial_data: Annotated[str, pydantic.Field(alias="initialData")] - - -class DocumentGetDocumentWithDetailsByIDSigningOrder(str, Enum): - PARALLEL = "PARALLEL" - SEQUENTIAL = "SEQUENTIAL" - - -class DocumentGetDocumentWithDetailsByIDDistributionMethod(str, Enum): - EMAIL = "EMAIL" - NONE = "NONE" - - -class DocumentGetDocumentWithDetailsByIDEmailSettingsTypedDict(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 DocumentGetDocumentWithDetailsByIDEmailSettings(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 DocumentGetDocumentWithDetailsByIDDocumentMetaTypedDict(TypedDict): - signing_order: DocumentGetDocumentWithDetailsByIDSigningOrder - distribution_method: DocumentGetDocumentWithDetailsByIDDistributionMethod - 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] - - -class DocumentGetDocumentWithDetailsByIDDocumentMeta(BaseModel): - signing_order: Annotated[ - DocumentGetDocumentWithDetailsByIDSigningOrder, - pydantic.Field(alias="signingOrder"), - ] - - distribution_method: Annotated[ - DocumentGetDocumentWithDetailsByIDDistributionMethod, - pydantic.Field(alias="distributionMethod"), - ] - - id: str - - subject: Nullable[str] - - message: Nullable[str] - - 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[ - 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") - ] - - language: str - - email_settings: Annotated[ - Nullable[DocumentGetDocumentWithDetailsByIDEmailSettings], - pydantic.Field(alias="emailSettings"), - ] - - @model_serializer(mode="wrap") - def serialize_model(self, handler): - optional_fields = [] - nullable_fields = [ - "subject", - "message", - "timezone", - "password", - "dateFormat", - "redirectUrl", - "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 DocumentGetDocumentWithDetailsByIDFolderType(str, Enum): - DOCUMENT = "DOCUMENT" - TEMPLATE = "TEMPLATE" - - -class DocumentGetDocumentWithDetailsByIDFolderVisibility(str, Enum): - EVERYONE = "EVERYONE" - MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" - ADMIN = "ADMIN" - - -class DocumentGetDocumentWithDetailsByIDFolderTypedDict(TypedDict): - id: str - name: str - type: DocumentGetDocumentWithDetailsByIDFolderType - visibility: DocumentGetDocumentWithDetailsByIDFolderVisibility - user_id: float - team_id: float - pinned: bool - parent_id: Nullable[str] - created_at: str - updated_at: str - - -class DocumentGetDocumentWithDetailsByIDFolder(BaseModel): - id: str - - name: str - - type: DocumentGetDocumentWithDetailsByIDFolderType - - visibility: DocumentGetDocumentWithDetailsByIDFolderVisibility - - 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 DocumentGetDocumentWithDetailsByIDRole(str, Enum): - CC = "CC" - SIGNER = "SIGNER" - VIEWER = "VIEWER" - APPROVER = "APPROVER" - ASSISTANT = "ASSISTANT" - - -class DocumentGetDocumentWithDetailsByIDReadStatus(str, Enum): - NOT_OPENED = "NOT_OPENED" - OPENED = "OPENED" - - -class DocumentGetDocumentWithDetailsByIDSigningStatus(str, Enum): - NOT_SIGNED = "NOT_SIGNED" - SIGNED = "SIGNED" - REJECTED = "REJECTED" - - -class DocumentGetDocumentWithDetailsByIDSendStatus(str, Enum): - NOT_SENT = "NOT_SENT" - SENT = "SENT" - - -class DocumentGetDocumentWithDetailsByIDAccessAuth(str, Enum): - r"""The type of authentication required for the recipient to access the document.""" - - ACCOUNT = "ACCOUNT" - - -class DocumentGetDocumentWithDetailsByIDActionAuth(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 DocumentGetDocumentWithDetailsByIDRecipientAuthOptionsTypedDict(TypedDict): - access_auth: List[DocumentGetDocumentWithDetailsByIDAccessAuth] - action_auth: List[DocumentGetDocumentWithDetailsByIDActionAuth] - - -class DocumentGetDocumentWithDetailsByIDRecipientAuthOptions(BaseModel): - access_auth: Annotated[ - List[DocumentGetDocumentWithDetailsByIDAccessAuth], - pydantic.Field(alias="accessAuth"), - ] - - action_auth: Annotated[ - List[DocumentGetDocumentWithDetailsByIDActionAuth], - pydantic.Field(alias="actionAuth"), - ] - - -class DocumentGetDocumentWithDetailsByIDRecipientTypedDict(TypedDict): - role: DocumentGetDocumentWithDetailsByIDRole - read_status: DocumentGetDocumentWithDetailsByIDReadStatus - signing_status: DocumentGetDocumentWithDetailsByIDSigningStatus - send_status: DocumentGetDocumentWithDetailsByIDSendStatus - 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 - ] - 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] - - -class DocumentGetDocumentWithDetailsByIDRecipient(BaseModel): - role: DocumentGetDocumentWithDetailsByIDRole - - read_status: Annotated[ - DocumentGetDocumentWithDetailsByIDReadStatus, pydantic.Field(alias="readStatus") - ] - - signing_status: Annotated[ - DocumentGetDocumentWithDetailsByIDSigningStatus, - pydantic.Field(alias="signingStatus"), - ] - - send_status: Annotated[ - DocumentGetDocumentWithDetailsByIDSendStatus, 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 - - 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[DocumentGetDocumentWithDetailsByIDRecipientAuthOptions], - 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")] - - @model_serializer(mode="wrap") - def serialize_model(self, handler): - optional_fields = [] - nullable_fields = [ - "documentId", - "templateId", - "documentDeletedAt", - "expired", - "signedAt", - "authOptions", - "signingOrder", - "rejectionReason", - ] - 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 DocumentGetDocumentWithDetailsByIDFieldType(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 DocumentGetDocumentWithDetailsByIDTypeDropdown(str, Enum): - DROPDOWN = "dropdown" - - -class DocumentGetDocumentWithDetailsByIDValue3TypedDict(TypedDict): - value: str - - -class DocumentGetDocumentWithDetailsByIDValue3(BaseModel): - value: str - - -class DocumentGetDocumentWithDetailsByIDFieldMetaDropdownTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeDropdown - label: NotRequired[str] - placeholder: NotRequired[str] - required: NotRequired[bool] - read_only: NotRequired[bool] - values: NotRequired[List[DocumentGetDocumentWithDetailsByIDValue3TypedDict]] - default_value: NotRequired[str] - - -class DocumentGetDocumentWithDetailsByIDFieldMetaDropdown(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeDropdown - - 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[DocumentGetDocumentWithDetailsByIDValue3]] = None - - default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None - - -class DocumentGetDocumentWithDetailsByIDTypeCheckbox(str, Enum): - CHECKBOX = "checkbox" - - -class DocumentGetDocumentWithDetailsByIDValue2TypedDict(TypedDict): - id: float - checked: bool - value: str - - -class DocumentGetDocumentWithDetailsByIDValue2(BaseModel): - id: float - - checked: bool - - value: str - - -class DocumentGetDocumentWithDetailsByIDFieldMetaCheckboxTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeCheckbox - label: NotRequired[str] - placeholder: NotRequired[str] - required: NotRequired[bool] - read_only: NotRequired[bool] - values: NotRequired[List[DocumentGetDocumentWithDetailsByIDValue2TypedDict]] - validation_rule: NotRequired[str] - validation_length: NotRequired[float] - - -class DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeCheckbox - - 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[DocumentGetDocumentWithDetailsByIDValue2]] = None - - validation_rule: Annotated[ - Optional[str], pydantic.Field(alias="validationRule") - ] = None - - validation_length: Annotated[ - Optional[float], pydantic.Field(alias="validationLength") - ] = None - - -class DocumentGetDocumentWithDetailsByIDTypeRadio(str, Enum): - RADIO = "radio" - - -class DocumentGetDocumentWithDetailsByIDValue1TypedDict(TypedDict): - id: float - checked: bool - value: str - - -class DocumentGetDocumentWithDetailsByIDValue1(BaseModel): - id: float - - checked: bool - - value: str - - -class DocumentGetDocumentWithDetailsByIDFieldMetaRadioTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeRadio - label: NotRequired[str] - placeholder: NotRequired[str] - required: NotRequired[bool] - read_only: NotRequired[bool] - values: NotRequired[List[DocumentGetDocumentWithDetailsByIDValue1TypedDict]] - - -class DocumentGetDocumentWithDetailsByIDFieldMetaRadio(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeRadio - - 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[DocumentGetDocumentWithDetailsByIDValue1]] = None - - -class DocumentGetDocumentWithDetailsByIDTypeNumber(str, Enum): - NUMBER = "number" - - -class DocumentGetDocumentWithDetailsByIDTextAlign6(str, Enum): - LEFT = "left" - CENTER = "center" - RIGHT = "right" - - -class DocumentGetDocumentWithDetailsByIDFieldMetaNumberTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeNumber - label: NotRequired[str] - placeholder: NotRequired[str] - required: NotRequired[bool] - read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] - font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign6] - - -class DocumentGetDocumentWithDetailsByIDFieldMetaNumber(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeNumber - - 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[Optional[str], pydantic.Field(alias="numberFormat")] = None - - value: Optional[str] = None - - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None - - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None - - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None - - text_align: Annotated[ - Optional[DocumentGetDocumentWithDetailsByIDTextAlign6], - pydantic.Field(alias="textAlign"), - ] = None - - -class DocumentGetDocumentWithDetailsByIDTypeText(str, Enum): - TEXT = "text" - - -class DocumentGetDocumentWithDetailsByIDTextAlign5(str, Enum): - LEFT = "left" - CENTER = "center" - RIGHT = "right" - - -class DocumentGetDocumentWithDetailsByIDFieldMetaTextTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeText - 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[DocumentGetDocumentWithDetailsByIDTextAlign5] - - -class DocumentGetDocumentWithDetailsByIDFieldMetaText(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeText - - 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[DocumentGetDocumentWithDetailsByIDTextAlign5], - pydantic.Field(alias="textAlign"), - ] = None - - -class DocumentGetDocumentWithDetailsByIDTypeDate(str, Enum): - DATE = "date" - - -class DocumentGetDocumentWithDetailsByIDTextAlign4(str, Enum): - LEFT = "left" - CENTER = "center" - RIGHT = "right" - - -class DocumentGetDocumentWithDetailsByIDFieldMetaDateTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeDate - label: NotRequired[str] - placeholder: NotRequired[str] - required: NotRequired[bool] - read_only: NotRequired[bool] - font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign4] - - -class DocumentGetDocumentWithDetailsByIDFieldMetaDate(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeDate - - 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[DocumentGetDocumentWithDetailsByIDTextAlign4], - pydantic.Field(alias="textAlign"), - ] = None - - -class DocumentGetDocumentWithDetailsByIDTypeEmail(str, Enum): - EMAIL = "email" - - -class DocumentGetDocumentWithDetailsByIDTextAlign3(str, Enum): - LEFT = "left" - CENTER = "center" - RIGHT = "right" - - -class DocumentGetDocumentWithDetailsByIDFieldMetaEmailTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeEmail - label: NotRequired[str] - placeholder: NotRequired[str] - required: NotRequired[bool] - read_only: NotRequired[bool] - font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign3] - - -class DocumentGetDocumentWithDetailsByIDFieldMetaEmail(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeEmail - - 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[DocumentGetDocumentWithDetailsByIDTextAlign3], - pydantic.Field(alias="textAlign"), - ] = None - - -class DocumentGetDocumentWithDetailsByIDTypeName(str, Enum): - NAME = "name" - - -class DocumentGetDocumentWithDetailsByIDTextAlign2(str, Enum): - LEFT = "left" - CENTER = "center" - RIGHT = "right" - - -class DocumentGetDocumentWithDetailsByIDFieldMetaNameTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeName - label: NotRequired[str] - placeholder: NotRequired[str] - required: NotRequired[bool] - read_only: NotRequired[bool] - font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign2] - - -class DocumentGetDocumentWithDetailsByIDFieldMetaName(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeName - - 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[DocumentGetDocumentWithDetailsByIDTextAlign2], - pydantic.Field(alias="textAlign"), - ] = None - - -class DocumentGetDocumentWithDetailsByIDTypeInitials(str, Enum): - INITIALS = "initials" - - -class DocumentGetDocumentWithDetailsByIDTextAlign1(str, Enum): - LEFT = "left" - CENTER = "center" - RIGHT = "right" - - -class DocumentGetDocumentWithDetailsByIDFieldMetaInitialsTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDTypeInitials - label: NotRequired[str] - placeholder: NotRequired[str] - required: NotRequired[bool] - read_only: NotRequired[bool] - font_size: NotRequired[float] - text_align: NotRequired[DocumentGetDocumentWithDetailsByIDTextAlign1] - - -class DocumentGetDocumentWithDetailsByIDFieldMetaInitials(BaseModel): - type: DocumentGetDocumentWithDetailsByIDTypeInitials - - 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[DocumentGetDocumentWithDetailsByIDTextAlign1], - pydantic.Field(alias="textAlign"), - ] = None - - -DocumentGetDocumentWithDetailsByIDFieldMetaUnionTypedDict = TypeAliasType( - "DocumentGetDocumentWithDetailsByIDFieldMetaUnionTypedDict", - Union[ - DocumentGetDocumentWithDetailsByIDFieldMetaRadioTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaInitialsTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaNameTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaEmailTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaDateTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaDropdownTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaCheckboxTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaTextTypedDict, - DocumentGetDocumentWithDetailsByIDFieldMetaNumberTypedDict, - ], -) - - -DocumentGetDocumentWithDetailsByIDFieldMetaUnion = TypeAliasType( - "DocumentGetDocumentWithDetailsByIDFieldMetaUnion", - Union[ - DocumentGetDocumentWithDetailsByIDFieldMetaRadio, - DocumentGetDocumentWithDetailsByIDFieldMetaInitials, - DocumentGetDocumentWithDetailsByIDFieldMetaName, - DocumentGetDocumentWithDetailsByIDFieldMetaEmail, - DocumentGetDocumentWithDetailsByIDFieldMetaDate, - DocumentGetDocumentWithDetailsByIDFieldMetaDropdown, - DocumentGetDocumentWithDetailsByIDFieldMetaCheckbox, - DocumentGetDocumentWithDetailsByIDFieldMetaText, - DocumentGetDocumentWithDetailsByIDFieldMetaNumber, - ], -) - - -class DocumentGetDocumentWithDetailsByIDFieldTypedDict(TypedDict): - type: DocumentGetDocumentWithDetailsByIDFieldType - 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] - position_x: NotRequired[Any] - position_y: NotRequired[Any] - width: NotRequired[Any] - height: NotRequired[Any] - - -class DocumentGetDocumentWithDetailsByIDField(BaseModel): - type: DocumentGetDocumentWithDetailsByIDFieldType - - 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 - 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[DocumentGetDocumentWithDetailsByIDFieldMetaUnion], - 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 - - @model_serializer(mode="wrap") - def serialize_model(self, handler): - optional_fields = ["positionX", "positionY", "width", "height"] - nullable_fields = ["documentId", "templateId", "fieldMeta"] - 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 DocumentGetDocumentWithDetailsByIDResponseTypedDict(TypedDict): - r"""Successful response""" - - visibility: DocumentGetDocumentWithDetailsByIDVisibility - status: DocumentGetDocumentWithDetailsByIDStatus - source: DocumentGetDocumentWithDetailsByIDSource - 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] - ] - 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): - r"""Successful response""" - - visibility: DocumentGetDocumentWithDetailsByIDVisibility - - status: DocumentGetDocumentWithDetailsByIDStatus - - source: DocumentGetDocumentWithDetailsByIDSource - - id: float - - external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] - r"""A custom external ID you can use to identify the document.""" - - user_id: Annotated[float, pydantic.Field(alias="userId")] - r"""The ID of the user that created this document.""" - - auth_options: Annotated[ - Nullable[DocumentGetDocumentWithDetailsByIDAuthOptions], - pydantic.Field(alias="authOptions"), - ] - - form_values: Annotated[ - Nullable[Dict[str, DocumentGetDocumentWithDetailsByIDFormValues]], - 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")] - - completed_at: Annotated[Nullable[str], pydantic.Field(alias="completedAt")] - - deleted_at: Annotated[Nullable[str], pydantic.Field(alias="deletedAt")] - - 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")] - - document_data: Annotated[ - DocumentGetDocumentWithDetailsByIDDocumentData, - pydantic.Field(alias="documentData"), - ] - - document_meta: Annotated[ - Nullable[DocumentGetDocumentWithDetailsByIDDocumentMeta], - pydantic.Field(alias="documentMeta"), - ] - - folder: Nullable[DocumentGetDocumentWithDetailsByIDFolder] - - recipients: List[DocumentGetDocumentWithDetailsByIDRecipient] - - fields: List[DocumentGetDocumentWithDetailsByIDField] - - @model_serializer(mode="wrap") - def serialize_model(self, handler): - optional_fields = [] - nullable_fields = [ - "externalId", - "authOptions", - "formValues", - "completedAt", - "deletedAt", - "templateId", - "folderId", - "documentMeta", - "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 diff --git a/src/documenso_sdk/models/document_getop.py b/src/documenso_sdk/models/document_getop.py new file mode 100644 index 0000000..2061ca3 --- /dev/null +++ b/src/documenso_sdk/models/document_getop.py @@ -0,0 +1,1535 @@ +"""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 documenso_sdk.utils import FieldMetadata, PathParamMetadata +from enum import Enum +import httpx +import pydantic +from pydantic import model_serializer +from typing import Any, Dict, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict + + +class DocumentGetRequestTypedDict(TypedDict): + document_id: float + + +class DocumentGetRequest(BaseModel): + document_id: Annotated[ + float, + pydantic.Field(alias="documentId"), + FieldMetadata(path=PathParamMetadata(style="simple", explode=False)), + ] + + +class DocumentGetInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentGetInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentGetInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentGetInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentGetInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentGetInternalServerErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentGetNotFoundIssueTypedDict(TypedDict): + message: str + + +class DocumentGetNotFoundIssue(BaseModel): + message: str + + +class DocumentGetNotFoundErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentGetNotFoundIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentGetNotFoundError(DocumensoError): + r"""Not found""" + + data: DocumentGetNotFoundErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentGetForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentGetForbiddenIssue(BaseModel): + message: str + + +class DocumentGetForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentGetForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentGetForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentGetForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentGetForbiddenErrorData, + 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 DocumentGetUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentGetUnauthorizedIssue(BaseModel): + message: str + + +class DocumentGetUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentGetUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentGetUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentGetUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentGetUnauthorizedErrorData, + 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 DocumentGetBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentGetBadRequestIssue(BaseModel): + message: str + + +class DocumentGetBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentGetBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentGetBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentGetBadRequestErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentGetVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class DocumentGetStatus(str, Enum): + DRAFT = "DRAFT" + PENDING = "PENDING" + COMPLETED = "COMPLETED" + REJECTED = "REJECTED" + + +class DocumentGetSource(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" + + +class DocumentGetGlobalAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class DocumentGetGlobalActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class DocumentGetAuthOptionsTypedDict(TypedDict): + global_access_auth: List[DocumentGetGlobalAccessAuth] + global_action_auth: List[DocumentGetGlobalActionAuth] + + +class DocumentGetAuthOptions(BaseModel): + global_access_auth: Annotated[ + List[DocumentGetGlobalAccessAuth], pydantic.Field(alias="globalAccessAuth") + ] + + global_action_auth: Annotated[ + List[DocumentGetGlobalActionAuth], pydantic.Field(alias="globalActionAuth") + ] + + +DocumentGetFormValuesTypedDict = TypeAliasType( + "DocumentGetFormValuesTypedDict", Union[str, bool, float] +) + + +DocumentGetFormValues = TypeAliasType("DocumentGetFormValues", Union[str, bool, float]) + + +class DocumentGetDocumentDataType(str, Enum): + S3_PATH = "S3_PATH" + BYTES = "BYTES" + BYTES_64 = "BYTES_64" + + +class DocumentGetDocumentDataTypedDict(TypedDict): + type: DocumentGetDocumentDataType + id: str + data: str + initial_data: str + envelope_item_id: str + + +class DocumentGetDocumentData(BaseModel): + type: DocumentGetDocumentDataType + + id: str + + data: str + + initial_data: Annotated[str, pydantic.Field(alias="initialData")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + +class DocumentGetSigningOrder(str, Enum): + PARALLEL = "PARALLEL" + SEQUENTIAL = "SEQUENTIAL" + + +class DocumentGetDistributionMethod(str, Enum): + EMAIL = "EMAIL" + NONE = "NONE" + + +class DocumentGetEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class DocumentGetEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class DocumentGetDocumentMetaTypedDict(TypedDict): + signing_order: DocumentGetSigningOrder + distribution_method: DocumentGetDistributionMethod + id: str + subject: Nullable[str] + message: Nullable[str] + timezone: Nullable[str] + date_format: Nullable[str] + 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[DocumentGetEmailSettingsTypedDict] + email_id: Nullable[str] + email_reply_to: Nullable[str] + password: NotRequired[Nullable[str]] + document_id: NotRequired[float] + + +class DocumentGetDocumentMeta(BaseModel): + signing_order: Annotated[ + DocumentGetSigningOrder, pydantic.Field(alias="signingOrder") + ] + + distribution_method: Annotated[ + DocumentGetDistributionMethod, pydantic.Field(alias="distributionMethod") + ] + + id: str + + subject: Nullable[str] + + message: Nullable[str] + + timezone: Nullable[str] + + date_format: Annotated[Nullable[str], pydantic.Field(alias="dateFormat")] + + redirect_url: Annotated[Nullable[str], pydantic.Field(alias="redirectUrl")] + + 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") + ] + + language: str + + email_settings: Annotated[ + 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 = ["password", "documentId"] + nullable_fields = [ + "subject", + "message", + "timezone", + "dateFormat", + "redirectUrl", + "emailSettings", + "emailId", + "emailReplyTo", + "password", + ] + null_default_fields = ["password"] + + 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 DocumentGetEnvelopeItemTypedDict(TypedDict): + id: str + envelope_id: str + + +class DocumentGetEnvelopeItem(BaseModel): + id: str + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + +class DocumentGetFolderType(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + + +class DocumentGetFolderVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class DocumentGetFolderTypedDict(TypedDict): + id: str + name: str + type: DocumentGetFolderType + visibility: DocumentGetFolderVisibility + user_id: float + team_id: float + pinned: bool + parent_id: Nullable[str] + created_at: str + updated_at: str + + +class DocumentGetFolder(BaseModel): + id: str + + name: str + + type: DocumentGetFolderType + + visibility: DocumentGetFolderVisibility + + 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 DocumentGetRole(str, Enum): + CC = "CC" + SIGNER = "SIGNER" + VIEWER = "VIEWER" + APPROVER = "APPROVER" + ASSISTANT = "ASSISTANT" + + +class DocumentGetReadStatus(str, Enum): + NOT_OPENED = "NOT_OPENED" + OPENED = "OPENED" + + +class DocumentGetSigningStatus(str, Enum): + NOT_SIGNED = "NOT_SIGNED" + SIGNED = "SIGNED" + REJECTED = "REJECTED" + + +class DocumentGetSendStatus(str, Enum): + NOT_SENT = "NOT_SENT" + SENT = "SENT" + + +class DocumentGetAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class DocumentGetActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + EXPLICIT_NONE = "EXPLICIT_NONE" + + +class DocumentGetRecipientAuthOptionsTypedDict(TypedDict): + access_auth: List[DocumentGetAccessAuth] + action_auth: List[DocumentGetActionAuth] + + +class DocumentGetRecipientAuthOptions(BaseModel): + access_auth: Annotated[ + List[DocumentGetAccessAuth], pydantic.Field(alias="accessAuth") + ] + + action_auth: Annotated[ + List[DocumentGetActionAuth], pydantic.Field(alias="actionAuth") + ] + + +class DocumentGetRecipientTypedDict(TypedDict): + envelope_id: str + role: DocumentGetRole + read_status: DocumentGetReadStatus + signing_status: DocumentGetSigningStatus + send_status: DocumentGetSendStatus + id: float + email: str + name: str + token: str + document_deleted_at: Nullable[str] + expired: Nullable[str] + signed_at: Nullable[str] + auth_options: Nullable[DocumentGetRecipientAuthOptionsTypedDict] + signing_order: Nullable[float] + rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] + + +class DocumentGetRecipient(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + role: DocumentGetRole + + read_status: Annotated[DocumentGetReadStatus, pydantic.Field(alias="readStatus")] + + signing_status: Annotated[ + DocumentGetSigningStatus, pydantic.Field(alias="signingStatus") + ] + + send_status: Annotated[DocumentGetSendStatus, 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[DocumentGetRecipientAuthOptions], pydantic.Field(alias="authOptions") + ] + + signing_order: Annotated[Nullable[float], pydantic.Field(alias="signingOrder")] + + 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 DocumentGetFieldType(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 DocumentGetTypeDropdown(str, Enum): + DROPDOWN = "dropdown" + + +class DocumentGetValue3TypedDict(TypedDict): + value: str + + +class DocumentGetValue3(BaseModel): + value: str + + +class DocumentGetFieldMetaDropdownTypedDict(TypedDict): + type: DocumentGetTypeDropdown + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[DocumentGetValue3TypedDict]] + default_value: NotRequired[str] + + +class DocumentGetFieldMetaDropdown(BaseModel): + type: DocumentGetTypeDropdown + + 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")] = 12 + + values: Optional[List[DocumentGetValue3]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +class DocumentGetTypeCheckbox(str, Enum): + CHECKBOX = "checkbox" + + +class DocumentGetValue2TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class DocumentGetValue2(BaseModel): + id: float + + checked: bool + + value: str + + +class DocumentGetDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class DocumentGetFieldMetaCheckboxTypedDict(TypedDict): + type: DocumentGetTypeCheckbox + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[DocumentGetValue2TypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[DocumentGetDirection2] + + +class DocumentGetFieldMetaCheckbox(BaseModel): + type: DocumentGetTypeCheckbox + + 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")] = 12 + + values: Optional[List[DocumentGetValue2]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[DocumentGetDirection2] = DocumentGetDirection2.VERTICAL + + +class DocumentGetTypeRadio(str, Enum): + RADIO = "radio" + + +class DocumentGetValue1TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class DocumentGetValue1(BaseModel): + id: float + + checked: bool + + value: str + + +class DocumentGetDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class DocumentGetFieldMetaRadioTypedDict(TypedDict): + type: DocumentGetTypeRadio + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[DocumentGetValue1TypedDict]] + direction: NotRequired[DocumentGetDirection1] + + +class DocumentGetFieldMetaRadio(BaseModel): + type: DocumentGetTypeRadio + + 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")] = 12 + + values: Optional[List[DocumentGetValue1]] = None + + direction: Optional[DocumentGetDirection1] = DocumentGetDirection1.VERTICAL + + +class DocumentGetTypeNumber(str, Enum): + NUMBER = "number" + + +class DocumentGetTextAlign6(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class DocumentGetVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class DocumentGetFieldMetaNumberTypedDict(TypedDict): + type: DocumentGetTypeNumber + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[DocumentGetTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[DocumentGetVerticalAlign2]] + + +class DocumentGetFieldMetaNumber(BaseModel): + type: DocumentGetTypeNumber + + 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")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[DocumentGetTextAlign6], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[DocumentGetVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 DocumentGetTypeText(str, Enum): + TEXT = "text" + + +class DocumentGetTextAlign5(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class DocumentGetVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class DocumentGetFieldMetaTextTypedDict(TypedDict): + type: DocumentGetTypeText + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[DocumentGetTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[DocumentGetVerticalAlign1]] + + +class DocumentGetFieldMetaText(BaseModel): + type: DocumentGetTypeText + + 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")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[DocumentGetTextAlign5], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[DocumentGetVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 DocumentGetTypeDate(str, Enum): + DATE = "date" + + +class DocumentGetTextAlign4(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +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[DocumentGetTextAlign4] + + +class DocumentGetFieldMetaDate(BaseModel): + type: DocumentGetTypeDate + + 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")] = 12 + + text_align: Annotated[ + Optional[DocumentGetTextAlign4], pydantic.Field(alias="textAlign") + ] = None + + +class DocumentGetTypeEmail(str, Enum): + EMAIL = "email" + + +class DocumentGetTextAlign3(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +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[DocumentGetTextAlign3] + + +class DocumentGetFieldMetaEmail(BaseModel): + type: DocumentGetTypeEmail + + 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")] = 12 + + text_align: Annotated[ + Optional[DocumentGetTextAlign3], pydantic.Field(alias="textAlign") + ] = None + + +class DocumentGetTypeName(str, Enum): + NAME = "name" + + +class DocumentGetTextAlign2(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +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[DocumentGetTextAlign2] + + +class DocumentGetFieldMetaName(BaseModel): + type: DocumentGetTypeName + + 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")] = 12 + + text_align: Annotated[ + Optional[DocumentGetTextAlign2], pydantic.Field(alias="textAlign") + ] = None + + +class DocumentGetTypeInitials(str, Enum): + INITIALS = "initials" + + +class DocumentGetTextAlign1(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +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[DocumentGetTextAlign1] + + +class DocumentGetFieldMetaInitials(BaseModel): + type: DocumentGetTypeInitials + + 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")] = 12 + + text_align: Annotated[ + Optional[DocumentGetTextAlign1], pydantic.Field(alias="textAlign") + ] = None + + +class DocumentGetTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class DocumentGetFieldMetaSignatureTypedDict(TypedDict): + type: DocumentGetTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class DocumentGetFieldMetaSignature(BaseModel): + type: DocumentGetTypeSignature + + 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")] = 12 + + +DocumentGetFieldMetaUnionTypedDict = TypeAliasType( + "DocumentGetFieldMetaUnionTypedDict", + Union[ + DocumentGetFieldMetaSignatureTypedDict, + DocumentGetFieldMetaInitialsTypedDict, + DocumentGetFieldMetaNameTypedDict, + DocumentGetFieldMetaEmailTypedDict, + DocumentGetFieldMetaDateTypedDict, + DocumentGetFieldMetaRadioTypedDict, + DocumentGetFieldMetaDropdownTypedDict, + DocumentGetFieldMetaCheckboxTypedDict, + DocumentGetFieldMetaTextTypedDict, + DocumentGetFieldMetaNumberTypedDict, + ], +) + + +DocumentGetFieldMetaUnion = TypeAliasType( + "DocumentGetFieldMetaUnion", + Union[ + DocumentGetFieldMetaSignature, + DocumentGetFieldMetaInitials, + DocumentGetFieldMetaName, + DocumentGetFieldMetaEmail, + DocumentGetFieldMetaDate, + DocumentGetFieldMetaRadio, + DocumentGetFieldMetaDropdown, + DocumentGetFieldMetaCheckbox, + DocumentGetFieldMetaText, + DocumentGetFieldMetaNumber, + ], +) + + +class DocumentGetFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str + type: DocumentGetFieldType + id: float + secondary_id: str + recipient_id: float + page: float + position_x: Any + position_y: Any + width: Any + height: Any + custom_text: str + inserted: bool + field_meta: Nullable[DocumentGetFieldMetaUnionTypedDict] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] + + +class DocumentGetField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + type: DocumentGetFieldType + + id: float + + secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any + + custom_text: Annotated[str, pydantic.Field(alias="customText")] + + inserted: bool + + field_meta: Annotated[ + Nullable[DocumentGetFieldMetaUnion], pydantic.Field(alias="fieldMeta") + ] + + 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 = ["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 DocumentGetResponseTypedDict(TypedDict): + r"""Successful response""" + + visibility: DocumentGetVisibility + status: DocumentGetStatus + source: DocumentGetSource + id: float + external_id: Nullable[str] + user_id: float + auth_options: Nullable[DocumentGetAuthOptionsTypedDict] + form_values: Nullable[Dict[str, DocumentGetFormValuesTypedDict]] + title: str + created_at: str + updated_at: str + completed_at: Nullable[str] + deleted_at: Nullable[str] + team_id: float + folder_id: Nullable[str] + envelope_id: str + internal_version: float + document_data: DocumentGetDocumentDataTypedDict + document_meta: DocumentGetDocumentMetaTypedDict + envelope_items: List[DocumentGetEnvelopeItemTypedDict] + folder: Nullable[DocumentGetFolderTypedDict] + recipients: List[DocumentGetRecipientTypedDict] + fields: List[DocumentGetFieldTypedDict] + template_id: NotRequired[Nullable[float]] + document_data_id: NotRequired[str] + + +class DocumentGetResponse(BaseModel): + r"""Successful response""" + + visibility: DocumentGetVisibility + + status: DocumentGetStatus + + source: DocumentGetSource + + id: float + + external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] + + user_id: Annotated[float, pydantic.Field(alias="userId")] + + auth_options: Annotated[ + Nullable[DocumentGetAuthOptions], pydantic.Field(alias="authOptions") + ] + + form_values: Annotated[ + Nullable[Dict[str, DocumentGetFormValues]], pydantic.Field(alias="formValues") + ] + + title: str + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] + + completed_at: Annotated[Nullable[str], pydantic.Field(alias="completedAt")] + + deleted_at: Annotated[Nullable[str], pydantic.Field(alias="deletedAt")] + + team_id: Annotated[float, pydantic.Field(alias="teamId")] + + folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + internal_version: Annotated[float, pydantic.Field(alias="internalVersion")] + + document_data: Annotated[ + DocumentGetDocumentData, pydantic.Field(alias="documentData") + ] + + document_meta: Annotated[ + DocumentGetDocumentMeta, pydantic.Field(alias="documentMeta") + ] + + envelope_items: Annotated[ + List[DocumentGetEnvelopeItem], pydantic.Field(alias="envelopeItems") + ] + + folder: Nullable[DocumentGetFolder] + + recipients: List[DocumentGetRecipient] + + fields: List[DocumentGetField] + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + + document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="documentDataId") + ] = "" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["templateId", "documentDataId"] + nullable_fields = [ + "externalId", + "authOptions", + "formValues", + "completedAt", + "deletedAt", + "folderId", + "templateId", + "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 diff --git a/src/documenso_sdk/models/document_redistributeop.py b/src/documenso_sdk/models/document_redistributeop.py new file mode 100644 index 0000000..1b3d37f --- /dev/null +++ b/src/documenso_sdk/models/document_redistributeop.py @@ -0,0 +1,169 @@ +"""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 DocumentRedistributeRequestTypedDict(TypedDict): + document_id: float + recipients: List[float] + + +class DocumentRedistributeRequest(BaseModel): + document_id: Annotated[float, pydantic.Field(alias="documentId")] + + recipients: List[float] + + +class DocumentRedistributeInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentRedistributeInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentRedistributeInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentRedistributeInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentRedistributeInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentRedistributeInternalServerErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentRedistributeForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentRedistributeForbiddenIssue(BaseModel): + message: str + + +class DocumentRedistributeForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentRedistributeForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentRedistributeForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentRedistributeForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentRedistributeForbiddenErrorData, + 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 DocumentRedistributeUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentRedistributeUnauthorizedIssue(BaseModel): + message: str + + +class DocumentRedistributeUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentRedistributeUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentRedistributeUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentRedistributeUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentRedistributeUnauthorizedErrorData, + 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 DocumentRedistributeBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentRedistributeBadRequestIssue(BaseModel): + message: str + + +class DocumentRedistributeBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentRedistributeBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentRedistributeBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentRedistributeBadRequestErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentRedistributeResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class DocumentRedistributeResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/document_resenddocumentop.py b/src/documenso_sdk/models/document_resenddocumentop.py deleted file mode 100644 index a8791ce..0000000 --- a/src/documenso_sdk/models/document_resenddocumentop.py +++ /dev/null @@ -1,100 +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 DocumentResendDocumentRequestTypedDict(TypedDict): - document_id: float - recipients: List[float] - r"""The IDs of the recipients to redistribute the document to.""" - - -class DocumentResendDocumentRequest(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): - message: str - - -class DocumentResendDocumentInternalServerErrorIssue(BaseModel): - message: str - - -class DocumentResendDocumentInternalServerErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentResendDocumentInternalServerErrorIssue]] = None - - -class DocumentResendDocumentInternalServerError(DocumensoError): - r"""Internal server error""" - - data: DocumentResendDocumentInternalServerErrorData - - def __init__( - self, - data: DocumentResendDocumentInternalServerErrorData, - 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 DocumentResendDocumentBadRequestIssueTypedDict(TypedDict): - message: str - - -class DocumentResendDocumentBadRequestIssue(BaseModel): - message: str - - -class DocumentResendDocumentBadRequestErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentResendDocumentBadRequestIssue]] = None - - -class DocumentResendDocumentBadRequestError(DocumensoError): - r"""Invalid input data""" - - data: DocumentResendDocumentBadRequestErrorData - - def __init__( - self, - data: DocumentResendDocumentBadRequestErrorData, - 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 DocumentResendDocumentResponseTypedDict(TypedDict): - r"""Successful response""" - - success: bool - - -class DocumentResendDocumentResponse(BaseModel): - r"""Successful response""" - - success: bool diff --git a/src/documenso_sdk/models/document_senddocumentop.py b/src/documenso_sdk/models/document_senddocumentop.py deleted file mode 100644 index 989cdd8..0000000 --- a/src/documenso_sdk/models/document_senddocumentop.py +++ /dev/null @@ -1,401 +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, Nullable, UNSET_SENTINEL -from enum import Enum -import httpx -import pydantic -from pydantic import model_serializer -from typing import Dict, List, Optional, Union -from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict - - -class DocumentSendDocumentDateFormat(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): - r"""The distribution method to use when sending the document to the recipients.""" - - EMAIL = "EMAIL" - NONE = "NONE" - - -class DocumentSendDocumentLanguage(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 DocumentSendDocumentEmailSettingsTypedDict(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 DocumentSendDocumentEmailSettings(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 DocumentSendDocumentMetaTypedDict(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] - r"""The date format to use for date fields and signing the document.""" - distribution_method: NotRequired[DocumentSendDocumentDistributionMethod] - 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] - r"""The language to use for email communications with recipients.""" - email_settings: NotRequired[DocumentSendDocumentEmailSettingsTypedDict] - - -class DocumentSendDocumentMeta(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[DocumentSendDocumentDateFormat], pydantic.Field(alias="dateFormat") - ] = None - r"""The date format to use for date fields and signing the document.""" - - distribution_method: Annotated[ - Optional[DocumentSendDocumentDistributionMethod], - pydantic.Field(alias="distributionMethod"), - ] = None - r"""The distribution method to use when sending the document to the recipients.""" - - 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 - r"""The language to use for email communications with recipients.""" - - email_settings: Annotated[ - Optional[DocumentSendDocumentEmailSettings], - pydantic.Field(alias="emailSettings"), - ] = None - - -class DocumentSendDocumentRequestTypedDict(TypedDict): - document_id: float - r"""The ID of the document to send.""" - meta: NotRequired[DocumentSendDocumentMetaTypedDict] - - -class DocumentSendDocumentRequest(BaseModel): - document_id: Annotated[float, pydantic.Field(alias="documentId")] - r"""The ID of the document to send.""" - - meta: Optional[DocumentSendDocumentMeta] = None - - -class DocumentSendDocumentInternalServerErrorIssueTypedDict(TypedDict): - message: str - - -class DocumentSendDocumentInternalServerErrorIssue(BaseModel): - message: str - - -class DocumentSendDocumentInternalServerErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentSendDocumentInternalServerErrorIssue]] = None - - -class DocumentSendDocumentInternalServerError(DocumensoError): - r"""Internal server error""" - - data: DocumentSendDocumentInternalServerErrorData - - def __init__( - self, - data: DocumentSendDocumentInternalServerErrorData, - 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 DocumentSendDocumentBadRequestIssueTypedDict(TypedDict): - message: str - - -class DocumentSendDocumentBadRequestIssue(BaseModel): - message: str - - -class DocumentSendDocumentBadRequestErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentSendDocumentBadRequestIssue]] = None - - -class DocumentSendDocumentBadRequestError(DocumensoError): - r"""Invalid input data""" - - data: DocumentSendDocumentBadRequestErrorData - - def __init__( - self, - data: DocumentSendDocumentBadRequestErrorData, - 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 DocumentSendDocumentVisibility(str, Enum): - EVERYONE = "EVERYONE" - MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" - ADMIN = "ADMIN" - - -class DocumentSendDocumentStatus(str, Enum): - DRAFT = "DRAFT" - PENDING = "PENDING" - COMPLETED = "COMPLETED" - REJECTED = "REJECTED" - - -class DocumentSendDocumentSource(str, Enum): - DOCUMENT = "DOCUMENT" - TEMPLATE = "TEMPLATE" - TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" - - -class DocumentSendDocumentGlobalAccessAuth(str, Enum): - r"""The type of authentication required for the recipient to access the document.""" - - ACCOUNT = "ACCOUNT" - - -class DocumentSendDocumentGlobalActionAuth(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 DocumentSendDocumentAuthOptionsTypedDict(TypedDict): - global_access_auth: List[DocumentSendDocumentGlobalAccessAuth] - global_action_auth: List[DocumentSendDocumentGlobalActionAuth] - - -class DocumentSendDocumentAuthOptions(BaseModel): - global_access_auth: Annotated[ - List[DocumentSendDocumentGlobalAccessAuth], - pydantic.Field(alias="globalAccessAuth"), - ] - - global_action_auth: Annotated[ - List[DocumentSendDocumentGlobalActionAuth], - pydantic.Field(alias="globalActionAuth"), - ] - - -DocumentSendDocumentFormValuesTypedDict = TypeAliasType( - "DocumentSendDocumentFormValuesTypedDict", Union[str, bool, float] -) - - -DocumentSendDocumentFormValues = TypeAliasType( - "DocumentSendDocumentFormValues", Union[str, bool, float] -) - - -class DocumentSendDocumentResponseTypedDict(TypedDict): - r"""Successful response""" - - visibility: DocumentSendDocumentVisibility - status: DocumentSendDocumentStatus - source: DocumentSendDocumentSource - 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]] - 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 - - -class DocumentSendDocumentResponse(BaseModel): - r"""Successful response""" - - visibility: DocumentSendDocumentVisibility - - status: DocumentSendDocumentStatus - - source: DocumentSendDocumentSource - - id: float - - external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] - r"""A custom external ID you can use to identify the document.""" - - user_id: Annotated[float, pydantic.Field(alias="userId")] - r"""The ID of the user that created this document.""" - - auth_options: Annotated[ - Nullable[DocumentSendDocumentAuthOptions], pydantic.Field(alias="authOptions") - ] - - form_values: Annotated[ - Nullable[Dict[str, DocumentSendDocumentFormValues]], - 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")] - - completed_at: Annotated[Nullable[str], pydantic.Field(alias="completedAt")] - - deleted_at: Annotated[Nullable[str], pydantic.Field(alias="deletedAt")] - - 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") - ] - - @model_serializer(mode="wrap") - def serialize_model(self, handler): - optional_fields = [] - nullable_fields = [ - "externalId", - "authOptions", - "formValues", - "completedAt", - "deletedAt", - "templateId", - "folderId", - ] - 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 diff --git a/src/documenso_sdk/models/document_updatedocumentop.py b/src/documenso_sdk/models/document_updatedocumentop.py deleted file mode 100644 index 4b67989..0000000 --- a/src/documenso_sdk/models/document_updatedocumentop.py +++ /dev/null @@ -1,544 +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, - Nullable, - OptionalNullable, - UNSET, - UNSET_SENTINEL, -) -from enum import Enum -import httpx -import pydantic -from pydantic import model_serializer -from typing import Dict, List, Optional, Union -from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict - - -class DocumentUpdateDocumentVisibilityRequest(str, Enum): - r"""The visibility of the document.""" - - EVERYONE = "EVERYONE" - MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" - ADMIN = "ADMIN" - - -class DocumentUpdateDocumentGlobalAccessAuthRequest(str, Enum): - r"""The type of authentication required for the recipient to access the document.""" - - ACCOUNT = "ACCOUNT" - - -class DocumentUpdateDocumentGlobalActionAuthRequest(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 DocumentUpdateDocumentDataTypedDict(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] - r"""The visibility of the document.""" - global_access_auth: NotRequired[List[DocumentUpdateDocumentGlobalAccessAuthRequest]] - global_action_auth: NotRequired[List[DocumentUpdateDocumentGlobalActionAuthRequest]] - use_legacy_field_insertion: NotRequired[bool] - - -class DocumentUpdateDocumentData(BaseModel): - title: Optional[str] = None - r"""The title of the document.""" - - external_id: Annotated[ - OptionalNullable[str], pydantic.Field(alias="externalId") - ] = UNSET - r"""The external ID of the document.""" - - visibility: Optional[DocumentUpdateDocumentVisibilityRequest] = None - r"""The visibility of the document.""" - - global_access_auth: Annotated[ - Optional[List[DocumentUpdateDocumentGlobalAccessAuthRequest]], - pydantic.Field(alias="globalAccessAuth"), - ] = None - - global_action_auth: Annotated[ - Optional[List[DocumentUpdateDocumentGlobalActionAuthRequest]], - pydantic.Field(alias="globalActionAuth"), - ] = None - - use_legacy_field_insertion: Annotated[ - Optional[bool], pydantic.Field(alias="useLegacyFieldInsertion") - ] = None - - @model_serializer(mode="wrap") - def serialize_model(self, handler): - optional_fields = [ - "title", - "externalId", - "visibility", - "globalAccessAuth", - "globalActionAuth", - "useLegacyFieldInsertion", - ] - 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 DocumentUpdateDocumentDateFormat(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): - r"""The distribution method to use when sending the document to the recipients.""" - - EMAIL = "EMAIL" - NONE = "NONE" - - -class DocumentUpdateDocumentSigningOrder(str, Enum): - PARALLEL = "PARALLEL" - SEQUENTIAL = "SEQUENTIAL" - - -class DocumentUpdateDocumentLanguage(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 DocumentUpdateDocumentEmailSettingsTypedDict(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 DocumentUpdateDocumentEmailSettings(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 DocumentUpdateDocumentMetaTypedDict(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] - r"""The date format to use for date fields and signing the document.""" - distribution_method: NotRequired[DocumentUpdateDocumentDistributionMethod] - r"""The distribution method to use when sending the document to the recipients.""" - signing_order: NotRequired[DocumentUpdateDocumentSigningOrder] - 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] - 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.""" - email_settings: NotRequired[DocumentUpdateDocumentEmailSettingsTypedDict] - - -class DocumentUpdateDocumentMeta(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[DocumentUpdateDocumentDateFormat], pydantic.Field(alias="dateFormat") - ] = None - r"""The date format to use for date fields and signing the document.""" - - distribution_method: Annotated[ - Optional[DocumentUpdateDocumentDistributionMethod], - 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"), - ] = 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.""" - - language: Optional[DocumentUpdateDocumentLanguage] = 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.""" - - email_settings: Annotated[ - Optional[DocumentUpdateDocumentEmailSettings], - pydantic.Field(alias="emailSettings"), - ] = None - - -class DocumentUpdateDocumentRequestTypedDict(TypedDict): - document_id: float - data: NotRequired[DocumentUpdateDocumentDataTypedDict] - meta: NotRequired[DocumentUpdateDocumentMetaTypedDict] - - -class DocumentUpdateDocumentRequest(BaseModel): - document_id: Annotated[float, pydantic.Field(alias="documentId")] - - data: Optional[DocumentUpdateDocumentData] = None - - meta: Optional[DocumentUpdateDocumentMeta] = None - - -class DocumentUpdateDocumentInternalServerErrorIssueTypedDict(TypedDict): - message: str - - -class DocumentUpdateDocumentInternalServerErrorIssue(BaseModel): - message: str - - -class DocumentUpdateDocumentInternalServerErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentUpdateDocumentInternalServerErrorIssue]] = None - - -class DocumentUpdateDocumentInternalServerError(DocumensoError): - r"""Internal server error""" - - data: DocumentUpdateDocumentInternalServerErrorData - - def __init__( - self, - data: DocumentUpdateDocumentInternalServerErrorData, - 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 DocumentUpdateDocumentBadRequestIssueTypedDict(TypedDict): - message: str - - -class DocumentUpdateDocumentBadRequestIssue(BaseModel): - message: str - - -class DocumentUpdateDocumentBadRequestErrorData(BaseModel): - message: str - - code: str - - issues: Optional[List[DocumentUpdateDocumentBadRequestIssue]] = None - - -class DocumentUpdateDocumentBadRequestError(DocumensoError): - r"""Invalid input data""" - - data: DocumentUpdateDocumentBadRequestErrorData - - def __init__( - self, - data: DocumentUpdateDocumentBadRequestErrorData, - 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 DocumentUpdateDocumentVisibilityResponse(str, Enum): - EVERYONE = "EVERYONE" - MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" - ADMIN = "ADMIN" - - -class DocumentUpdateDocumentStatus(str, Enum): - DRAFT = "DRAFT" - PENDING = "PENDING" - COMPLETED = "COMPLETED" - REJECTED = "REJECTED" - - -class DocumentUpdateDocumentSource(str, Enum): - DOCUMENT = "DOCUMENT" - TEMPLATE = "TEMPLATE" - TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" - - -class DocumentUpdateDocumentGlobalAccessAuthResponse(str, Enum): - r"""The type of authentication required for the recipient to access the document.""" - - ACCOUNT = "ACCOUNT" - - -class DocumentUpdateDocumentGlobalActionAuthResponse(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 DocumentUpdateDocumentAuthOptionsTypedDict(TypedDict): - global_access_auth: List[DocumentUpdateDocumentGlobalAccessAuthResponse] - global_action_auth: List[DocumentUpdateDocumentGlobalActionAuthResponse] - - -class DocumentUpdateDocumentAuthOptions(BaseModel): - global_access_auth: Annotated[ - List[DocumentUpdateDocumentGlobalAccessAuthResponse], - pydantic.Field(alias="globalAccessAuth"), - ] - - global_action_auth: Annotated[ - List[DocumentUpdateDocumentGlobalActionAuthResponse], - pydantic.Field(alias="globalActionAuth"), - ] - - -DocumentUpdateDocumentFormValuesTypedDict = TypeAliasType( - "DocumentUpdateDocumentFormValuesTypedDict", Union[str, bool, float] -) - - -DocumentUpdateDocumentFormValues = TypeAliasType( - "DocumentUpdateDocumentFormValues", Union[str, bool, float] -) - - -class DocumentUpdateDocumentResponseTypedDict(TypedDict): - r"""Successful response""" - - visibility: DocumentUpdateDocumentVisibilityResponse - status: DocumentUpdateDocumentStatus - source: DocumentUpdateDocumentSource - 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]] - 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 - - -class DocumentUpdateDocumentResponse(BaseModel): - r"""Successful response""" - - visibility: DocumentUpdateDocumentVisibilityResponse - - status: DocumentUpdateDocumentStatus - - source: DocumentUpdateDocumentSource - - id: float - - external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] - r"""A custom external ID you can use to identify the document.""" - - user_id: Annotated[float, pydantic.Field(alias="userId")] - r"""The ID of the user that created this document.""" - - auth_options: Annotated[ - Nullable[DocumentUpdateDocumentAuthOptions], pydantic.Field(alias="authOptions") - ] - - form_values: Annotated[ - Nullable[Dict[str, DocumentUpdateDocumentFormValues]], - 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")] - - completed_at: Annotated[Nullable[str], pydantic.Field(alias="completedAt")] - - deleted_at: Annotated[Nullable[str], pydantic.Field(alias="deletedAt")] - - 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") - ] - - @model_serializer(mode="wrap") - def serialize_model(self, handler): - optional_fields = [] - nullable_fields = [ - "externalId", - "authOptions", - "formValues", - "completedAt", - "deletedAt", - "templateId", - "folderId", - ] - 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 diff --git a/src/documenso_sdk/models/document_updateop.py b/src/documenso_sdk/models/document_updateop.py new file mode 100644 index 0000000..021434d --- /dev/null +++ b/src/documenso_sdk/models/document_updateop.py @@ -0,0 +1,638 @@ +"""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 Dict, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict + + +class DocumentUpdateDataVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class DocumentUpdateDataGlobalAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class DocumentUpdateDataGlobalActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class DocumentUpdateDataTypedDict(TypedDict): + title: NotRequired[str] + external_id: NotRequired[Nullable[str]] + visibility: NotRequired[DocumentUpdateDataVisibility] + global_access_auth: NotRequired[List[DocumentUpdateDataGlobalAccessAuth]] + global_action_auth: NotRequired[List[DocumentUpdateDataGlobalActionAuth]] + use_legacy_field_insertion: NotRequired[bool] + folder_id: NotRequired[Nullable[str]] + + +class DocumentUpdateData(BaseModel): + title: Optional[str] = None + + external_id: Annotated[ + OptionalNullable[str], pydantic.Field(alias="externalId") + ] = UNSET + + visibility: Optional[DocumentUpdateDataVisibility] = None + + global_access_auth: Annotated[ + Optional[List[DocumentUpdateDataGlobalAccessAuth]], + pydantic.Field(alias="globalAccessAuth"), + ] = None + + global_action_auth: Annotated[ + Optional[List[DocumentUpdateDataGlobalActionAuth]], + pydantic.Field(alias="globalActionAuth"), + ] = None + + use_legacy_field_insertion: Annotated[ + 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 = [ + "title", + "externalId", + "visibility", + "globalAccessAuth", + "globalActionAuth", + "useLegacyFieldInsertion", + "folderId", + ] + nullable_fields = ["externalId", "folderId"] + 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 DocumentUpdateDateFormat(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): + EMAIL = "EMAIL" + NONE = "NONE" + + +class DocumentUpdateSigningOrder(str, Enum): + PARALLEL = "PARALLEL" + SEQUENTIAL = "SEQUENTIAL" + + +class DocumentUpdateLanguage(str, Enum): + DE = "de" + EN = "en" + FR = "fr" + ES = "es" + IT = "it" + PL = "pl" + + +class DocumentUpdateEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class DocumentUpdateEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class DocumentUpdateMetaTypedDict(TypedDict): + subject: NotRequired[str] + message: NotRequired[str] + timezone: NotRequired[str] + date_format: NotRequired[DocumentUpdateDateFormat] + distribution_method: NotRequired[DocumentUpdateDistributionMethod] + signing_order: NotRequired[DocumentUpdateSigningOrder] + allow_dictate_next_signer: NotRequired[bool] + redirect_url: NotRequired[str] + language: NotRequired[DocumentUpdateLanguage] + typed_signature_enabled: NotRequired[bool] + upload_signature_enabled: NotRequired[bool] + draw_signature_enabled: NotRequired[bool] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[Nullable[DocumentUpdateEmailSettingsTypedDict]] + + +class DocumentUpdateMeta(BaseModel): + subject: Optional[str] = None + + message: Optional[str] = None + + timezone: Optional[str] = None + + date_format: Annotated[ + Optional[DocumentUpdateDateFormat], pydantic.Field(alias="dateFormat") + ] = None + + distribution_method: Annotated[ + Optional[DocumentUpdateDistributionMethod], + pydantic.Field(alias="distributionMethod"), + ] = None + + signing_order: Annotated[ + Optional[DocumentUpdateSigningOrder], 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 + + language: Optional[DocumentUpdateLanguage] = None + + typed_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="typedSignatureEnabled") + ] = None + + upload_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="uploadSignatureEnabled") + ] = None + + draw_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="drawSignatureEnabled") + ] = None + + email_id: Annotated[OptionalNullable[str], pydantic.Field(alias="emailId")] = UNSET + + email_reply_to: Annotated[ + OptionalNullable[str], pydantic.Field(alias="emailReplyTo") + ] = UNSET + + email_settings: Annotated[ + OptionalNullable[DocumentUpdateEmailSettings], + pydantic.Field(alias="emailSettings"), + ] = 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 DocumentUpdateRequestTypedDict(TypedDict): + document_id: float + data: NotRequired[DocumentUpdateDataTypedDict] + meta: NotRequired[DocumentUpdateMetaTypedDict] + + +class DocumentUpdateRequest(BaseModel): + document_id: Annotated[float, pydantic.Field(alias="documentId")] + + data: Optional[DocumentUpdateData] = None + + meta: Optional[DocumentUpdateMeta] = None + + +class DocumentUpdateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class DocumentUpdateInternalServerErrorIssue(BaseModel): + message: str + + +class DocumentUpdateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentUpdateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentUpdateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: DocumentUpdateInternalServerErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentUpdateForbiddenIssueTypedDict(TypedDict): + message: str + + +class DocumentUpdateForbiddenIssue(BaseModel): + message: str + + +class DocumentUpdateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentUpdateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentUpdateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: DocumentUpdateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: DocumentUpdateForbiddenErrorData, + 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 DocumentUpdateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class DocumentUpdateUnauthorizedIssue(BaseModel): + message: str + + +class DocumentUpdateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentUpdateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentUpdateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: DocumentUpdateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: DocumentUpdateUnauthorizedErrorData, + 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 DocumentUpdateBadRequestIssueTypedDict(TypedDict): + message: str + + +class DocumentUpdateBadRequestIssue(BaseModel): + message: str + + +class DocumentUpdateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[DocumentUpdateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class DocumentUpdateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: DocumentUpdateBadRequestErrorData = field(hash=False) + + def __init__( + self, + 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) + object.__setattr__(self, "data", data) + + +class DocumentUpdateVisibilityResponse(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class DocumentUpdateStatus(str, Enum): + DRAFT = "DRAFT" + PENDING = "PENDING" + COMPLETED = "COMPLETED" + REJECTED = "REJECTED" + + +class DocumentUpdateSource(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" + + +class DocumentUpdateGlobalAccessAuthResponse(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class DocumentUpdateGlobalActionAuthResponse(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class DocumentUpdateAuthOptionsTypedDict(TypedDict): + global_access_auth: List[DocumentUpdateGlobalAccessAuthResponse] + global_action_auth: List[DocumentUpdateGlobalActionAuthResponse] + + +class DocumentUpdateAuthOptions(BaseModel): + global_access_auth: Annotated[ + List[DocumentUpdateGlobalAccessAuthResponse], + pydantic.Field(alias="globalAccessAuth"), + ] + + global_action_auth: Annotated[ + List[DocumentUpdateGlobalActionAuthResponse], + pydantic.Field(alias="globalActionAuth"), + ] + + +DocumentUpdateFormValuesTypedDict = TypeAliasType( + "DocumentUpdateFormValuesTypedDict", Union[str, bool, float] +) + + +DocumentUpdateFormValues = TypeAliasType( + "DocumentUpdateFormValues", Union[str, bool, float] +) + + +class DocumentUpdateResponseTypedDict(TypedDict): + r"""Successful response""" + + visibility: DocumentUpdateVisibilityResponse + status: DocumentUpdateStatus + source: DocumentUpdateSource + id: float + external_id: Nullable[str] + user_id: float + auth_options: Nullable[DocumentUpdateAuthOptionsTypedDict] + form_values: Nullable[Dict[str, DocumentUpdateFormValuesTypedDict]] + title: str + created_at: str + updated_at: str + completed_at: Nullable[str] + deleted_at: Nullable[str] + team_id: float + folder_id: Nullable[str] + use_legacy_field_insertion: bool + envelope_id: str + internal_version: float + document_data_id: NotRequired[str] + template_id: NotRequired[Nullable[float]] + + +class DocumentUpdateResponse(BaseModel): + r"""Successful response""" + + visibility: DocumentUpdateVisibilityResponse + + status: DocumentUpdateStatus + + source: DocumentUpdateSource + + id: float + + external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] + + user_id: Annotated[float, pydantic.Field(alias="userId")] + + auth_options: Annotated[ + Nullable[DocumentUpdateAuthOptions], pydantic.Field(alias="authOptions") + ] + + form_values: Annotated[ + Nullable[Dict[str, DocumentUpdateFormValues]], + pydantic.Field(alias="formValues"), + ] + + title: str + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] + + completed_at: Annotated[Nullable[str], pydantic.Field(alias="completedAt")] + + deleted_at: Annotated[Nullable[str], pydantic.Field(alias="deletedAt")] + + team_id: Annotated[float, pydantic.Field(alias="teamId")] + + 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")] + + internal_version: Annotated[float, pydantic.Field(alias="internalVersion")] + + document_data_id: Annotated[ + Optional[str], pydantic.Field(alias="documentDataId") + ] = "" + + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["documentDataId", "templateId"] + nullable_fields = [ + "externalId", + "authOptions", + "formValues", + "completedAt", + "deletedAt", + "folderId", + "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 diff --git a/src/documenso_sdk/models/embeddingpresign_createembeddingpresigntokenop.py b/src/documenso_sdk/models/embeddingpresign_createembeddingpresigntokenop.py index c23a9a1..c5ee227 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 @@ -11,12 +12,10 @@ class EmbeddingPresignCreateEmbeddingPresignTokenRequestTypedDict(TypedDict): expires_in: NotRequired[float] - r"""Expiration time in minutes (default: 60, max: 10,080)""" class EmbeddingPresignCreateEmbeddingPresignTokenRequest(BaseModel): expires_in: Annotated[Optional[float], pydantic.Field(alias="expiresIn")] = 60 - r"""Expiration time in minutes (default: 60, max: 10,080)""" class EmbeddingPresignCreateEmbeddingPresignTokenInternalServerErrorIssueTypedDict( @@ -39,10 +38,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 +55,83 @@ 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 EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssueTypedDict(TypedDict): + message: str + + +class EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssue(BaseModel): + message: str + + +class EmbeddingPresignCreateEmbeddingPresignTokenForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[ + List[EmbeddingPresignCreateEmbeddingPresignTokenForbiddenIssue] + ] = None + + +@dataclass(unsafe_hash=True) +class EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EmbeddingPresignCreateEmbeddingPresignTokenForbiddenErrorData = field( + hash=False + ) + + def __init__( + self, + data: EmbeddingPresignCreateEmbeddingPresignTokenForbiddenErrorData, + 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 EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssue(BaseModel): + message: str + + +class EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[ + List[EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedIssue] + ] = None + + +@dataclass(unsafe_hash=True) +class EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedErrorData = field( + hash=False + ) + + def __init__( + self, + data: EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedErrorData, + 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 EmbeddingPresignCreateEmbeddingPresignTokenBadRequestIssueTypedDict(TypedDict): @@ -74,10 +152,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 +169,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): @@ -97,7 +178,6 @@ class EmbeddingPresignCreateEmbeddingPresignTokenResponseTypedDict(TypedDict): token: str expires_at: str expires_in: float - r"""Expiration time in seconds""" class EmbeddingPresignCreateEmbeddingPresignTokenResponse(BaseModel): @@ -108,4 +188,3 @@ class EmbeddingPresignCreateEmbeddingPresignTokenResponse(BaseModel): expires_at: Annotated[str, pydantic.Field(alias="expiresAt")] expires_in: Annotated[float, pydantic.Field(alias="expiresIn")] - r"""Expiration time in seconds""" diff --git a/src/documenso_sdk/models/embeddingpresign_verifyembeddingpresigntokenop.py b/src/documenso_sdk/models/embeddingpresign_verifyembeddingpresigntokenop.py index 5a5f8ce..c0b1974 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 @@ -10,12 +11,10 @@ class EmbeddingPresignVerifyEmbeddingPresignTokenRequestTypedDict(TypedDict): token: str - r"""The presign token to verify""" class EmbeddingPresignVerifyEmbeddingPresignTokenRequest(BaseModel): token: str - r"""The presign token to verify""" class EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerErrorIssueTypedDict( @@ -38,10 +37,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 +54,83 @@ 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 EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssueTypedDict(TypedDict): + message: str + + +class EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssue(BaseModel): + message: str + + +class EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[ + List[EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenIssue] + ] = None + + +@dataclass(unsafe_hash=True) +class EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenErrorData = field( + hash=False + ) + + def __init__( + self, + data: EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenErrorData, + 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 EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssue(BaseModel): + message: str + + +class EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[ + List[EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedIssue] + ] = None + + +@dataclass(unsafe_hash=True) +class EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedErrorData = field( + hash=False + ) + + def __init__( + self, + data: EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedErrorData, + 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 EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestIssueTypedDict(TypedDict): @@ -73,10 +151,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 +168,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/envelope_attachment_createop.py b/src/documenso_sdk/models/envelope_attachment_createop.py new file mode 100644 index 0000000..bca802b --- /dev/null +++ b/src/documenso_sdk/models/envelope_attachment_createop.py @@ -0,0 +1,180 @@ +"""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 EnvelopeAttachmentCreateDataTypedDict(TypedDict): + label: str + data: str + + +class EnvelopeAttachmentCreateData(BaseModel): + label: str + + data: str + + +class EnvelopeAttachmentCreateRequestTypedDict(TypedDict): + envelope_id: str + data: EnvelopeAttachmentCreateDataTypedDict + + +class EnvelopeAttachmentCreateRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + data: EnvelopeAttachmentCreateData + + +class EnvelopeAttachmentCreateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentCreateInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeAttachmentCreateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentCreateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentCreateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeAttachmentCreateInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentCreateInternalServerErrorData, + 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 EnvelopeAttachmentCreateForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentCreateForbiddenIssue(BaseModel): + message: str + + +class EnvelopeAttachmentCreateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentCreateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentCreateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeAttachmentCreateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentCreateForbiddenErrorData, + 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 EnvelopeAttachmentCreateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentCreateUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeAttachmentCreateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentCreateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentCreateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeAttachmentCreateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentCreateUnauthorizedErrorData, + 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 EnvelopeAttachmentCreateBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentCreateBadRequestIssue(BaseModel): + message: str + + +class EnvelopeAttachmentCreateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentCreateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentCreateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeAttachmentCreateBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentCreateBadRequestErrorData, + 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 EnvelopeAttachmentCreateResponseTypedDict(TypedDict): + r"""Successful response""" + + id: str + + +class EnvelopeAttachmentCreateResponse(BaseModel): + r"""Successful response""" + + id: str diff --git a/src/documenso_sdk/models/envelope_attachment_deleteop.py b/src/documenso_sdk/models/envelope_attachment_deleteop.py new file mode 100644 index 0000000..b2c2761 --- /dev/null +++ b/src/documenso_sdk/models/envelope_attachment_deleteop.py @@ -0,0 +1,165 @@ +"""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 +from typing import List, Optional +from typing_extensions import TypedDict + + +class EnvelopeAttachmentDeleteRequestTypedDict(TypedDict): + id: str + + +class EnvelopeAttachmentDeleteRequest(BaseModel): + id: str + + +class EnvelopeAttachmentDeleteInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentDeleteInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeAttachmentDeleteInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentDeleteInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentDeleteInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeAttachmentDeleteInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentDeleteInternalServerErrorData, + 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 EnvelopeAttachmentDeleteForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentDeleteForbiddenIssue(BaseModel): + message: str + + +class EnvelopeAttachmentDeleteForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentDeleteForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentDeleteForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeAttachmentDeleteForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentDeleteForbiddenErrorData, + 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 EnvelopeAttachmentDeleteUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentDeleteUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeAttachmentDeleteUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentDeleteUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentDeleteUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeAttachmentDeleteUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentDeleteUnauthorizedErrorData, + 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 EnvelopeAttachmentDeleteBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentDeleteBadRequestIssue(BaseModel): + message: str + + +class EnvelopeAttachmentDeleteBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentDeleteBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentDeleteBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeAttachmentDeleteBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentDeleteBadRequestErrorData, + 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 EnvelopeAttachmentDeleteResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class EnvelopeAttachmentDeleteResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/envelope_attachment_findop.py b/src/documenso_sdk/models/envelope_attachment_findop.py new file mode 100644 index 0000000..4abb76f --- /dev/null +++ b/src/documenso_sdk/models/envelope_attachment_findop.py @@ -0,0 +1,233 @@ +"""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, QueryParamMetadata +from enum import Enum +import httpx +import pydantic +from typing import List, Optional +from typing_extensions import Annotated, NotRequired, TypedDict + + +class EnvelopeAttachmentFindRequestTypedDict(TypedDict): + envelope_id: str + token: NotRequired[str] + + +class EnvelopeAttachmentFindRequest(BaseModel): + envelope_id: Annotated[ + str, + pydantic.Field(alias="envelopeId"), + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] + + token: Annotated[ + Optional[str], + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = None + + +class EnvelopeAttachmentFindInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentFindInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeAttachmentFindInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentFindInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentFindInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeAttachmentFindInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentFindInternalServerErrorData, + 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 EnvelopeAttachmentFindNotFoundIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentFindNotFoundIssue(BaseModel): + message: str + + +class EnvelopeAttachmentFindNotFoundErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentFindNotFoundIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentFindNotFoundError(DocumensoError): + r"""Not found""" + + data: EnvelopeAttachmentFindNotFoundErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentFindNotFoundErrorData, + 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 EnvelopeAttachmentFindForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentFindForbiddenIssue(BaseModel): + message: str + + +class EnvelopeAttachmentFindForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentFindForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentFindForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeAttachmentFindForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentFindForbiddenErrorData, + 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 EnvelopeAttachmentFindUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentFindUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeAttachmentFindUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentFindUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentFindUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeAttachmentFindUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentFindUnauthorizedErrorData, + 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 EnvelopeAttachmentFindBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentFindBadRequestIssue(BaseModel): + message: str + + +class EnvelopeAttachmentFindBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentFindBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentFindBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeAttachmentFindBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentFindBadRequestErrorData, + 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 EnvelopeAttachmentFindType(str, Enum): + LINK = "link" + + +class EnvelopeAttachmentFindDataTypedDict(TypedDict): + id: str + type: EnvelopeAttachmentFindType + label: str + data: str + + +class EnvelopeAttachmentFindData(BaseModel): + id: str + + type: EnvelopeAttachmentFindType + + label: str + + data: str + + +class EnvelopeAttachmentFindResponseTypedDict(TypedDict): + r"""Successful response""" + + data: List[EnvelopeAttachmentFindDataTypedDict] + + +class EnvelopeAttachmentFindResponse(BaseModel): + r"""Successful response""" + + data: List[EnvelopeAttachmentFindData] diff --git a/src/documenso_sdk/models/envelope_attachment_updateop.py b/src/documenso_sdk/models/envelope_attachment_updateop.py new file mode 100644 index 0000000..ed2e84c --- /dev/null +++ b/src/documenso_sdk/models/envelope_attachment_updateop.py @@ -0,0 +1,179 @@ +"""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 +from typing import List, Optional +from typing_extensions import TypedDict + + +class EnvelopeAttachmentUpdateDataTypedDict(TypedDict): + label: str + data: str + + +class EnvelopeAttachmentUpdateData(BaseModel): + label: str + + data: str + + +class EnvelopeAttachmentUpdateRequestTypedDict(TypedDict): + id: str + data: EnvelopeAttachmentUpdateDataTypedDict + + +class EnvelopeAttachmentUpdateRequest(BaseModel): + id: str + + data: EnvelopeAttachmentUpdateData + + +class EnvelopeAttachmentUpdateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentUpdateInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeAttachmentUpdateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentUpdateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentUpdateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeAttachmentUpdateInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentUpdateInternalServerErrorData, + 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 EnvelopeAttachmentUpdateForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentUpdateForbiddenIssue(BaseModel): + message: str + + +class EnvelopeAttachmentUpdateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentUpdateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentUpdateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeAttachmentUpdateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentUpdateForbiddenErrorData, + 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 EnvelopeAttachmentUpdateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentUpdateUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeAttachmentUpdateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentUpdateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentUpdateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeAttachmentUpdateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentUpdateUnauthorizedErrorData, + 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 EnvelopeAttachmentUpdateBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeAttachmentUpdateBadRequestIssue(BaseModel): + message: str + + +class EnvelopeAttachmentUpdateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeAttachmentUpdateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeAttachmentUpdateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeAttachmentUpdateBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeAttachmentUpdateBadRequestErrorData, + 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 EnvelopeAttachmentUpdateResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class EnvelopeAttachmentUpdateResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/envelope_createop.py b/src/documenso_sdk/models/envelope_createop.py new file mode 100644 index 0000000..1d85db3 --- /dev/null +++ b/src/documenso_sdk/models/envelope_createop.py @@ -0,0 +1,1662 @@ +"""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 documenso_sdk.utils import FieldMetadata, MultipartFormMetadata +from enum import Enum +import httpx +import io +import pydantic +from pydantic import model_serializer +from typing import Dict, IO, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict + + +class EnvelopeCreateType(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + + +class EnvelopeCreateVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class EnvelopeCreateGlobalAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeCreateGlobalActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +EnvelopeCreateFormValuesTypedDict = TypeAliasType( + "EnvelopeCreateFormValuesTypedDict", Union[str, bool, float] +) + + +EnvelopeCreateFormValues = TypeAliasType( + "EnvelopeCreateFormValues", Union[str, bool, float] +) + + +class EnvelopeCreateRole(str, Enum): + CC = "CC" + SIGNER = "SIGNER" + VIEWER = "VIEWER" + APPROVER = "APPROVER" + ASSISTANT = "ASSISTANT" + + +class EnvelopeCreateAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeCreateActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + EXPLICIT_NONE = "EXPLICIT_NONE" + + +class EnvelopeCreateTypeDropdown1(str, Enum): + DROPDOWN = "DROPDOWN" + + +class EnvelopeCreateTypeDropdown2(str, Enum): + DROPDOWN = "dropdown" + + +class EnvelopeCreateValueDropdownTypedDict(TypedDict): + value: str + + +class EnvelopeCreateValueDropdown(BaseModel): + value: str + + +class EnvelopeCreateFieldMetaDropdownTypedDict(TypedDict): + type: EnvelopeCreateTypeDropdown2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeCreateValueDropdownTypedDict]] + default_value: NotRequired[str] + + +class EnvelopeCreateFieldMetaDropdown(BaseModel): + type: EnvelopeCreateTypeDropdown2 + + 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")] = 12 + + values: Optional[List[EnvelopeCreateValueDropdown]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +EnvelopeCreateIdentifier11TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier11TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier11 = TypeAliasType( + "EnvelopeCreateIdentifier11", Union[str, float] +) + + +class EnvelopeCreateFieldDropdownTypedDict(TypedDict): + type: EnvelopeCreateTypeDropdown1 + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeCreateFieldMetaDropdownTypedDict] + identifier: NotRequired[EnvelopeCreateIdentifier11TypedDict] + + +class EnvelopeCreateFieldDropdown(BaseModel): + type: EnvelopeCreateTypeDropdown1 + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeCreateFieldMetaDropdown], pydantic.Field(alias="fieldMeta") + ] = None + + identifier: Optional[EnvelopeCreateIdentifier11] = None + + +class EnvelopeCreateTypeCheckbox1(str, Enum): + CHECKBOX = "CHECKBOX" + + +class EnvelopeCreateTypeCheckbox2(str, Enum): + CHECKBOX = "checkbox" + + +class EnvelopeCreateValueCheckboxTypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeCreateValueCheckbox(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeCreateDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeCreateFieldMetaCheckboxTypedDict(TypedDict): + type: EnvelopeCreateTypeCheckbox2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeCreateValueCheckboxTypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[EnvelopeCreateDirectionCheckbox] + + +class EnvelopeCreateFieldMetaCheckbox(BaseModel): + type: EnvelopeCreateTypeCheckbox2 + + 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")] = 12 + + values: Optional[List[EnvelopeCreateValueCheckbox]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[EnvelopeCreateDirectionCheckbox] = ( + EnvelopeCreateDirectionCheckbox.VERTICAL + ) + + +EnvelopeCreateIdentifier10TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier10TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier10 = TypeAliasType( + "EnvelopeCreateIdentifier10", Union[str, float] +) + + +class EnvelopeCreateFieldCheckboxTypedDict(TypedDict): + type: EnvelopeCreateTypeCheckbox1 + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeCreateFieldMetaCheckboxTypedDict] + identifier: NotRequired[EnvelopeCreateIdentifier10TypedDict] + + +class EnvelopeCreateFieldCheckbox(BaseModel): + type: EnvelopeCreateTypeCheckbox1 + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeCreateFieldMetaCheckbox], pydantic.Field(alias="fieldMeta") + ] = None + + identifier: Optional[EnvelopeCreateIdentifier10] = None + + +class EnvelopeCreateTypeRadio1(str, Enum): + RADIO = "RADIO" + + +class EnvelopeCreateTypeRadio2(str, Enum): + RADIO = "radio" + + +class EnvelopeCreateValueRadioTypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeCreateValueRadio(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeCreateDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeCreateFieldMetaRadioTypedDict(TypedDict): + type: EnvelopeCreateTypeRadio2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeCreateValueRadioTypedDict]] + direction: NotRequired[EnvelopeCreateDirectionRadio] + + +class EnvelopeCreateFieldMetaRadio(BaseModel): + type: EnvelopeCreateTypeRadio2 + + 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")] = 12 + + values: Optional[List[EnvelopeCreateValueRadio]] = None + + direction: Optional[EnvelopeCreateDirectionRadio] = ( + EnvelopeCreateDirectionRadio.VERTICAL + ) + + +EnvelopeCreateIdentifier9TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier9TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier9 = TypeAliasType( + "EnvelopeCreateIdentifier9", Union[str, float] +) + + +class EnvelopeCreateFieldRadioTypedDict(TypedDict): + type: EnvelopeCreateTypeRadio1 + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeCreateFieldMetaRadioTypedDict] + identifier: NotRequired[EnvelopeCreateIdentifier9TypedDict] + + +class EnvelopeCreateFieldRadio(BaseModel): + type: EnvelopeCreateTypeRadio1 + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeCreateFieldMetaRadio], pydantic.Field(alias="fieldMeta") + ] = None + + identifier: Optional[EnvelopeCreateIdentifier9] = None + + +class EnvelopeCreateTypeNumber1(str, Enum): + NUMBER = "NUMBER" + + +class EnvelopeCreateTypeNumber2(str, Enum): + NUMBER = "number" + + +class EnvelopeCreateTextAlignNumber(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeCreateVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeCreateFieldMetaNumberTypedDict(TypedDict): + type: EnvelopeCreateTypeNumber2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[EnvelopeCreateTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeCreateVerticalAlignNumber]] + + +class EnvelopeCreateFieldMetaNumber(BaseModel): + type: EnvelopeCreateTypeNumber2 + + 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")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[EnvelopeCreateTextAlignNumber], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeCreateVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 + + +EnvelopeCreateIdentifier8TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier8TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier8 = TypeAliasType( + "EnvelopeCreateIdentifier8", Union[str, float] +) + + +class EnvelopeCreateFieldNumberTypedDict(TypedDict): + type: EnvelopeCreateTypeNumber1 + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeCreateFieldMetaNumberTypedDict] + identifier: NotRequired[EnvelopeCreateIdentifier8TypedDict] + + +class EnvelopeCreateFieldNumber(BaseModel): + type: EnvelopeCreateTypeNumber1 + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeCreateFieldMetaNumber], pydantic.Field(alias="fieldMeta") + ] = None + + identifier: Optional[EnvelopeCreateIdentifier8] = None + + +class EnvelopeCreateTypeText1(str, Enum): + TEXT = "TEXT" + + +class EnvelopeCreateTypeText2(str, Enum): + TEXT = "text" + + +class EnvelopeCreateTextAlignText(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeCreateVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeCreateFieldMetaTextTypedDict(TypedDict): + type: EnvelopeCreateTypeText2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[EnvelopeCreateTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeCreateVerticalAlignText]] + + +class EnvelopeCreateFieldMetaText(BaseModel): + type: EnvelopeCreateTypeText2 + + 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")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[EnvelopeCreateTextAlignText], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeCreateVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 + + +EnvelopeCreateIdentifier7TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier7TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier7 = TypeAliasType( + "EnvelopeCreateIdentifier7", Union[str, float] +) + + +class EnvelopeCreateFieldTextTypedDict(TypedDict): + type: EnvelopeCreateTypeText1 + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeCreateFieldMetaTextTypedDict] + identifier: NotRequired[EnvelopeCreateIdentifier7TypedDict] + + +class EnvelopeCreateFieldText(BaseModel): + type: EnvelopeCreateTypeText1 + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeCreateFieldMetaText], pydantic.Field(alias="fieldMeta") + ] = None + + identifier: Optional[EnvelopeCreateIdentifier7] = None + + +class EnvelopeCreateTypeDate1(str, Enum): + DATE = "DATE" + + +class EnvelopeCreateTypeDate2(str, Enum): + DATE = "date" + + +class EnvelopeCreateTextAlignDate(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeCreateFieldMetaDateTypedDict(TypedDict): + type: EnvelopeCreateTypeDate2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeCreateTextAlignDate] + + +class EnvelopeCreateFieldMetaDate(BaseModel): + type: EnvelopeCreateTypeDate2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeCreateTextAlignDate], pydantic.Field(alias="textAlign") + ] = None + + +EnvelopeCreateIdentifier6TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier6TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier6 = TypeAliasType( + "EnvelopeCreateIdentifier6", Union[str, float] +) + + +class EnvelopeCreateFieldDateTypedDict(TypedDict): + type: EnvelopeCreateTypeDate1 + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeCreateFieldMetaDateTypedDict] + identifier: NotRequired[EnvelopeCreateIdentifier6TypedDict] + + +class EnvelopeCreateFieldDate(BaseModel): + type: EnvelopeCreateTypeDate1 + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeCreateFieldMetaDate], pydantic.Field(alias="fieldMeta") + ] = None + + identifier: Optional[EnvelopeCreateIdentifier6] = None + + +class EnvelopeCreateTypeEmail1(str, Enum): + EMAIL = "EMAIL" + + +class EnvelopeCreateTypeEmail2(str, Enum): + EMAIL = "email" + + +class EnvelopeCreateTextAlignEmail(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeCreateFieldMetaEmailTypedDict(TypedDict): + type: EnvelopeCreateTypeEmail2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeCreateTextAlignEmail] + + +class EnvelopeCreateFieldMetaEmail(BaseModel): + type: EnvelopeCreateTypeEmail2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeCreateTextAlignEmail], pydantic.Field(alias="textAlign") + ] = None + + +EnvelopeCreateIdentifier5TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier5TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier5 = TypeAliasType( + "EnvelopeCreateIdentifier5", Union[str, float] +) + + +class EnvelopeCreateFieldEmailTypedDict(TypedDict): + type: EnvelopeCreateTypeEmail1 + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeCreateFieldMetaEmailTypedDict] + identifier: NotRequired[EnvelopeCreateIdentifier5TypedDict] + + +class EnvelopeCreateFieldEmail(BaseModel): + type: EnvelopeCreateTypeEmail1 + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeCreateFieldMetaEmail], pydantic.Field(alias="fieldMeta") + ] = None + + identifier: Optional[EnvelopeCreateIdentifier5] = None + + +class EnvelopeCreateTypeName1(str, Enum): + NAME = "NAME" + + +class EnvelopeCreateTypeName2(str, Enum): + NAME = "name" + + +class EnvelopeCreateTextAlignName(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeCreateFieldMetaNameTypedDict(TypedDict): + type: EnvelopeCreateTypeName2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeCreateTextAlignName] + + +class EnvelopeCreateFieldMetaName(BaseModel): + type: EnvelopeCreateTypeName2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeCreateTextAlignName], pydantic.Field(alias="textAlign") + ] = None + + +EnvelopeCreateIdentifier4TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier4TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier4 = TypeAliasType( + "EnvelopeCreateIdentifier4", Union[str, float] +) + + +class EnvelopeCreateFieldNameTypedDict(TypedDict): + type: EnvelopeCreateTypeName1 + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeCreateFieldMetaNameTypedDict] + identifier: NotRequired[EnvelopeCreateIdentifier4TypedDict] + + +class EnvelopeCreateFieldName(BaseModel): + type: EnvelopeCreateTypeName1 + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeCreateFieldMetaName], pydantic.Field(alias="fieldMeta") + ] = None + + identifier: Optional[EnvelopeCreateIdentifier4] = None + + +class EnvelopeCreateTypeInitials1(str, Enum): + INITIALS = "INITIALS" + + +class EnvelopeCreateTypeInitials2(str, Enum): + INITIALS = "initials" + + +class EnvelopeCreateTextAlignInitials(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeCreateFieldMetaInitialsTypedDict(TypedDict): + type: EnvelopeCreateTypeInitials2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeCreateTextAlignInitials] + + +class EnvelopeCreateFieldMetaInitials(BaseModel): + type: EnvelopeCreateTypeInitials2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeCreateTextAlignInitials], pydantic.Field(alias="textAlign") + ] = None + + +EnvelopeCreateIdentifier3TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier3TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier3 = TypeAliasType( + "EnvelopeCreateIdentifier3", Union[str, float] +) + + +class EnvelopeCreateFieldInitialsTypedDict(TypedDict): + type: EnvelopeCreateTypeInitials1 + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeCreateFieldMetaInitialsTypedDict] + identifier: NotRequired[EnvelopeCreateIdentifier3TypedDict] + + +class EnvelopeCreateFieldInitials(BaseModel): + type: EnvelopeCreateTypeInitials1 + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeCreateFieldMetaInitials], pydantic.Field(alias="fieldMeta") + ] = None + + identifier: Optional[EnvelopeCreateIdentifier3] = None + + +class EnvelopeCreateTypeFreeSignature(str, Enum): + FREE_SIGNATURE = "FREE_SIGNATURE" + + +EnvelopeCreateIdentifier2TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier2TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier2 = TypeAliasType( + "EnvelopeCreateIdentifier2", Union[str, float] +) + + +class EnvelopeCreateFieldFreeSignatureTypedDict(TypedDict): + type: EnvelopeCreateTypeFreeSignature + page: float + position_x: float + position_y: float + width: float + height: float + identifier: NotRequired[EnvelopeCreateIdentifier2TypedDict] + + +class EnvelopeCreateFieldFreeSignature(BaseModel): + type: EnvelopeCreateTypeFreeSignature + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + identifier: Optional[EnvelopeCreateIdentifier2] = None + + +class EnvelopeCreateTypeSignature1(str, Enum): + SIGNATURE = "SIGNATURE" + + +class EnvelopeCreateTypeSignature2(str, Enum): + SIGNATURE = "signature" + + +class EnvelopeCreateFieldMetaSignatureTypedDict(TypedDict): + type: EnvelopeCreateTypeSignature2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class EnvelopeCreateFieldMetaSignature(BaseModel): + type: EnvelopeCreateTypeSignature2 + + 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")] = 12 + + +EnvelopeCreateIdentifier1TypedDict = TypeAliasType( + "EnvelopeCreateIdentifier1TypedDict", Union[str, float] +) + + +EnvelopeCreateIdentifier1 = TypeAliasType( + "EnvelopeCreateIdentifier1", Union[str, float] +) + + +class EnvelopeCreateFieldSignatureTypedDict(TypedDict): + type: EnvelopeCreateTypeSignature1 + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeCreateFieldMetaSignatureTypedDict] + identifier: NotRequired[EnvelopeCreateIdentifier1TypedDict] + + +class EnvelopeCreateFieldSignature(BaseModel): + type: EnvelopeCreateTypeSignature1 + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeCreateFieldMetaSignature], pydantic.Field(alias="fieldMeta") + ] = None + + identifier: Optional[EnvelopeCreateIdentifier1] = None + + +EnvelopeCreateFieldUnionTypedDict = TypeAliasType( + "EnvelopeCreateFieldUnionTypedDict", + Union[ + EnvelopeCreateFieldFreeSignatureTypedDict, + EnvelopeCreateFieldSignatureTypedDict, + EnvelopeCreateFieldInitialsTypedDict, + EnvelopeCreateFieldNameTypedDict, + EnvelopeCreateFieldEmailTypedDict, + EnvelopeCreateFieldDateTypedDict, + EnvelopeCreateFieldTextTypedDict, + EnvelopeCreateFieldNumberTypedDict, + EnvelopeCreateFieldRadioTypedDict, + EnvelopeCreateFieldCheckboxTypedDict, + EnvelopeCreateFieldDropdownTypedDict, + ], +) + + +EnvelopeCreateFieldUnion = TypeAliasType( + "EnvelopeCreateFieldUnion", + Union[ + EnvelopeCreateFieldFreeSignature, + EnvelopeCreateFieldSignature, + EnvelopeCreateFieldInitials, + EnvelopeCreateFieldName, + EnvelopeCreateFieldEmail, + EnvelopeCreateFieldDate, + EnvelopeCreateFieldText, + EnvelopeCreateFieldNumber, + EnvelopeCreateFieldRadio, + EnvelopeCreateFieldCheckbox, + EnvelopeCreateFieldDropdown, + ], +) + + +class EnvelopeCreateRecipientTypedDict(TypedDict): + email: str + name: str + role: EnvelopeCreateRole + signing_order: NotRequired[float] + access_auth: NotRequired[List[EnvelopeCreateAccessAuth]] + action_auth: NotRequired[List[EnvelopeCreateActionAuth]] + fields: NotRequired[List[EnvelopeCreateFieldUnionTypedDict]] + + +class EnvelopeCreateRecipient(BaseModel): + email: str + + name: str + + role: EnvelopeCreateRole + + signing_order: Annotated[Optional[float], pydantic.Field(alias="signingOrder")] = ( + None + ) + + access_auth: Annotated[ + Optional[List[EnvelopeCreateAccessAuth]], pydantic.Field(alias="accessAuth") + ] = None + + action_auth: Annotated[ + Optional[List[EnvelopeCreateActionAuth]], pydantic.Field(alias="actionAuth") + ] = None + + fields: Optional[List[EnvelopeCreateFieldUnion]] = None + + +class EnvelopeCreateDateFormat(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 EnvelopeCreateDistributionMethod(str, Enum): + EMAIL = "EMAIL" + NONE = "NONE" + + +class EnvelopeCreateSigningOrder(str, Enum): + PARALLEL = "PARALLEL" + SEQUENTIAL = "SEQUENTIAL" + + +class EnvelopeCreateLanguage(str, Enum): + DE = "de" + EN = "en" + FR = "fr" + ES = "es" + IT = "it" + PL = "pl" + + +class EnvelopeCreateEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class EnvelopeCreateEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class EnvelopeCreateMetaTypedDict(TypedDict): + subject: NotRequired[str] + message: NotRequired[str] + timezone: NotRequired[str] + date_format: NotRequired[EnvelopeCreateDateFormat] + distribution_method: NotRequired[EnvelopeCreateDistributionMethod] + signing_order: NotRequired[EnvelopeCreateSigningOrder] + allow_dictate_next_signer: NotRequired[bool] + redirect_url: NotRequired[str] + language: NotRequired[EnvelopeCreateLanguage] + typed_signature_enabled: NotRequired[bool] + upload_signature_enabled: NotRequired[bool] + draw_signature_enabled: NotRequired[bool] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[Nullable[EnvelopeCreateEmailSettingsTypedDict]] + + +class EnvelopeCreateMeta(BaseModel): + subject: Optional[str] = None + + message: Optional[str] = None + + timezone: Optional[str] = None + + date_format: Annotated[ + Optional[EnvelopeCreateDateFormat], pydantic.Field(alias="dateFormat") + ] = None + + distribution_method: Annotated[ + Optional[EnvelopeCreateDistributionMethod], + pydantic.Field(alias="distributionMethod"), + ] = None + + signing_order: Annotated[ + Optional[EnvelopeCreateSigningOrder], 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 + + language: Optional[EnvelopeCreateLanguage] = None + + typed_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="typedSignatureEnabled") + ] = None + + upload_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="uploadSignatureEnabled") + ] = None + + draw_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="drawSignatureEnabled") + ] = None + + email_id: Annotated[OptionalNullable[str], pydantic.Field(alias="emailId")] = UNSET + + email_reply_to: Annotated[ + OptionalNullable[str], pydantic.Field(alias="emailReplyTo") + ] = UNSET + + email_settings: Annotated[ + OptionalNullable[EnvelopeCreateEmailSettings], + pydantic.Field(alias="emailSettings"), + ] = 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 EnvelopeCreateTypeLink(str, Enum): + LINK = "link" + + +class EnvelopeCreateAttachmentTypedDict(TypedDict): + label: str + data: str + type: NotRequired[EnvelopeCreateTypeLink] + + +class EnvelopeCreateAttachment(BaseModel): + label: str + + data: str + + type: Optional[EnvelopeCreateTypeLink] = EnvelopeCreateTypeLink.LINK + + +class EnvelopeCreatePayloadTypedDict(TypedDict): + title: str + type: EnvelopeCreateType + external_id: NotRequired[str] + visibility: NotRequired[EnvelopeCreateVisibility] + global_access_auth: NotRequired[List[EnvelopeCreateGlobalAccessAuth]] + global_action_auth: NotRequired[List[EnvelopeCreateGlobalActionAuth]] + form_values: NotRequired[Dict[str, EnvelopeCreateFormValuesTypedDict]] + folder_id: NotRequired[str] + recipients: NotRequired[List[EnvelopeCreateRecipientTypedDict]] + meta: NotRequired[EnvelopeCreateMetaTypedDict] + attachments: NotRequired[List[EnvelopeCreateAttachmentTypedDict]] + + +class EnvelopeCreatePayload(BaseModel): + title: str + + type: EnvelopeCreateType + + external_id: Annotated[Optional[str], pydantic.Field(alias="externalId")] = None + + visibility: Optional[EnvelopeCreateVisibility] = None + + global_access_auth: Annotated[ + Optional[List[EnvelopeCreateGlobalAccessAuth]], + pydantic.Field(alias="globalAccessAuth"), + ] = None + + global_action_auth: Annotated[ + Optional[List[EnvelopeCreateGlobalActionAuth]], + pydantic.Field(alias="globalActionAuth"), + ] = None + + form_values: Annotated[ + Optional[Dict[str, EnvelopeCreateFormValues]], + pydantic.Field(alias="formValues"), + ] = None + + folder_id: Annotated[Optional[str], pydantic.Field(alias="folderId")] = None + + recipients: Optional[List[EnvelopeCreateRecipient]] = None + + meta: Optional[EnvelopeCreateMeta] = None + + attachments: Optional[List[EnvelopeCreateAttachment]] = None + + +class EnvelopeCreateFileTypedDict(TypedDict): + file_name: str + content: Union[bytes, IO[bytes], io.BufferedReader] + content_type: NotRequired[str] + + +class EnvelopeCreateFile(BaseModel): + file_name: Annotated[ + str, pydantic.Field(alias="fileName"), FieldMetadata(multipart=True) + ] + + content: Annotated[ + Union[bytes, IO[bytes], io.BufferedReader], + pydantic.Field(alias=""), + FieldMetadata(multipart=MultipartFormMetadata(content=True)), + ] + + content_type: Annotated[ + Optional[str], + pydantic.Field(alias="Content-Type"), + FieldMetadata(multipart=True), + ] = None + + +class EnvelopeCreateRequestTypedDict(TypedDict): + payload: EnvelopeCreatePayloadTypedDict + files: NotRequired[List[EnvelopeCreateFileTypedDict]] + + +class EnvelopeCreateRequest(BaseModel): + payload: Annotated[ + EnvelopeCreatePayload, FieldMetadata(multipart=MultipartFormMetadata(json=True)) + ] + + files: Annotated[ + Optional[List[EnvelopeCreateFile]], + FieldMetadata(multipart=MultipartFormMetadata(file=True)), + ] = None + + +class EnvelopeCreateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeCreateInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeCreateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeCreateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeCreateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeCreateInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeCreateInternalServerErrorData, + 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 EnvelopeCreateForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeCreateForbiddenIssue(BaseModel): + message: str + + +class EnvelopeCreateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeCreateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeCreateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeCreateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeCreateForbiddenErrorData, + 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 EnvelopeCreateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeCreateUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeCreateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeCreateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeCreateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeCreateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeCreateUnauthorizedErrorData, + 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 EnvelopeCreateBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeCreateBadRequestIssue(BaseModel): + message: str + + +class EnvelopeCreateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeCreateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeCreateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeCreateBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeCreateBadRequestErrorData, + 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 EnvelopeCreateResponseTypedDict(TypedDict): + r"""Successful response""" + + id: str + + +class EnvelopeCreateResponse(BaseModel): + r"""Successful response""" + + id: str diff --git a/src/documenso_sdk/models/envelope_deleteop.py b/src/documenso_sdk/models/envelope_deleteop.py new file mode 100644 index 0000000..7b03354 --- /dev/null +++ b/src/documenso_sdk/models/envelope_deleteop.py @@ -0,0 +1,166 @@ +"""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 EnvelopeDeleteRequestTypedDict(TypedDict): + envelope_id: str + + +class EnvelopeDeleteRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + +class EnvelopeDeleteInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDeleteInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeDeleteInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDeleteInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDeleteInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeDeleteInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDeleteInternalServerErrorData, + 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 EnvelopeDeleteForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDeleteForbiddenIssue(BaseModel): + message: str + + +class EnvelopeDeleteForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDeleteForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDeleteForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeDeleteForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDeleteForbiddenErrorData, + 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 EnvelopeDeleteUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDeleteUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeDeleteUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDeleteUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDeleteUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeDeleteUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDeleteUnauthorizedErrorData, + 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 EnvelopeDeleteBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDeleteBadRequestIssue(BaseModel): + message: str + + +class EnvelopeDeleteBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDeleteBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDeleteBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeDeleteBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDeleteBadRequestErrorData, + 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 EnvelopeDeleteResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class EnvelopeDeleteResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/envelope_distributeop.py b/src/documenso_sdk/models/envelope_distributeop.py new file mode 100644 index 0000000..f5bcdf5 --- /dev/null +++ b/src/documenso_sdk/models/envelope_distributeop.py @@ -0,0 +1,342 @@ +"""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 List, Optional +from typing_extensions import Annotated, NotRequired, TypedDict + + +class EnvelopeDistributeDateFormat(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 EnvelopeDistributeDistributionMethod(str, Enum): + EMAIL = "EMAIL" + NONE = "NONE" + + +class EnvelopeDistributeLanguage(str, Enum): + DE = "de" + EN = "en" + FR = "fr" + ES = "es" + IT = "it" + PL = "pl" + + +class EnvelopeDistributeEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class EnvelopeDistributeEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class EnvelopeDistributeMetaTypedDict(TypedDict): + subject: NotRequired[str] + message: NotRequired[str] + timezone: NotRequired[str] + date_format: NotRequired[EnvelopeDistributeDateFormat] + distribution_method: NotRequired[EnvelopeDistributeDistributionMethod] + redirect_url: NotRequired[str] + language: NotRequired[EnvelopeDistributeLanguage] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[Nullable[EnvelopeDistributeEmailSettingsTypedDict]] + + +class EnvelopeDistributeMeta(BaseModel): + subject: Optional[str] = None + + message: Optional[str] = None + + timezone: Optional[str] = None + + date_format: Annotated[ + Optional[EnvelopeDistributeDateFormat], pydantic.Field(alias="dateFormat") + ] = None + + distribution_method: Annotated[ + Optional[EnvelopeDistributeDistributionMethod], + pydantic.Field(alias="distributionMethod"), + ] = None + + redirect_url: Annotated[Optional[str], pydantic.Field(alias="redirectUrl")] = None + + language: Optional[EnvelopeDistributeLanguage] = None + + email_id: Annotated[OptionalNullable[str], pydantic.Field(alias="emailId")] = UNSET + + email_reply_to: Annotated[ + OptionalNullable[str], pydantic.Field(alias="emailReplyTo") + ] = UNSET + + email_settings: Annotated[ + OptionalNullable[EnvelopeDistributeEmailSettings], + pydantic.Field(alias="emailSettings"), + ] = UNSET + + @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", "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 EnvelopeDistributeRequestTypedDict(TypedDict): + envelope_id: str + meta: NotRequired[EnvelopeDistributeMetaTypedDict] + + +class EnvelopeDistributeRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + meta: Optional[EnvelopeDistributeMeta] = None + + +class EnvelopeDistributeInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDistributeInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeDistributeInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDistributeInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDistributeInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeDistributeInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDistributeInternalServerErrorData, + 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 EnvelopeDistributeForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDistributeForbiddenIssue(BaseModel): + message: str + + +class EnvelopeDistributeForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDistributeForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDistributeForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeDistributeForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDistributeForbiddenErrorData, + 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 EnvelopeDistributeUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDistributeUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeDistributeUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDistributeUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDistributeUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeDistributeUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDistributeUnauthorizedErrorData, + 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 EnvelopeDistributeBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDistributeBadRequestIssue(BaseModel): + message: str + + +class EnvelopeDistributeBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDistributeBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDistributeBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeDistributeBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDistributeBadRequestErrorData, + 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 EnvelopeDistributeResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class EnvelopeDistributeResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/envelope_duplicateop.py b/src/documenso_sdk/models/envelope_duplicateop.py new file mode 100644 index 0000000..5af2014 --- /dev/null +++ b/src/documenso_sdk/models/envelope_duplicateop.py @@ -0,0 +1,166 @@ +"""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 EnvelopeDuplicateRequestTypedDict(TypedDict): + envelope_id: str + + +class EnvelopeDuplicateRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + +class EnvelopeDuplicateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDuplicateInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeDuplicateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDuplicateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDuplicateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeDuplicateInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDuplicateInternalServerErrorData, + 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 EnvelopeDuplicateForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDuplicateForbiddenIssue(BaseModel): + message: str + + +class EnvelopeDuplicateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDuplicateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDuplicateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeDuplicateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDuplicateForbiddenErrorData, + 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 EnvelopeDuplicateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDuplicateUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeDuplicateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDuplicateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDuplicateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeDuplicateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDuplicateUnauthorizedErrorData, + 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 EnvelopeDuplicateBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeDuplicateBadRequestIssue(BaseModel): + message: str + + +class EnvelopeDuplicateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeDuplicateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeDuplicateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeDuplicateBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeDuplicateBadRequestErrorData, + 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 EnvelopeDuplicateResponseTypedDict(TypedDict): + r"""Successful response""" + + id: str + + +class EnvelopeDuplicateResponse(BaseModel): + r"""Successful response""" + + id: str diff --git a/src/documenso_sdk/models/envelope_field_createmanyop.py b/src/documenso_sdk/models/envelope_field_createmanyop.py new file mode 100644 index 0000000..0db3b7b --- /dev/null +++ b/src/documenso_sdk/models/envelope_field_createmanyop.py @@ -0,0 +1,1962 @@ +"""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 EnvelopeFieldCreateManyTypeDropdownRequest1(str, Enum): + DROPDOWN = "DROPDOWN" + + +class EnvelopeFieldCreateManyTypeDropdownRequest2(str, Enum): + DROPDOWN = "dropdown" + + +class EnvelopeFieldCreateManyValueDropdownTypedDict(TypedDict): + value: str + + +class EnvelopeFieldCreateManyValueDropdown(BaseModel): + value: str + + +class EnvelopeFieldCreateManyFieldMetaDropdownRequestTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeDropdownRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldCreateManyValueDropdownTypedDict]] + default_value: NotRequired[str] + + +class EnvelopeFieldCreateManyFieldMetaDropdownRequest(BaseModel): + type: EnvelopeFieldCreateManyTypeDropdownRequest2 + + 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")] = 12 + + values: Optional[List[EnvelopeFieldCreateManyValueDropdown]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +class EnvelopeFieldCreateManyDataDropdownTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeDropdownRequest1 + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeFieldCreateManyFieldMetaDropdownRequestTypedDict] + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataDropdown(BaseModel): + type: EnvelopeFieldCreateManyTypeDropdownRequest1 + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeFieldCreateManyFieldMetaDropdownRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +class EnvelopeFieldCreateManyTypeCheckboxRequest1(str, Enum): + CHECKBOX = "CHECKBOX" + + +class EnvelopeFieldCreateManyTypeCheckboxRequest2(str, Enum): + CHECKBOX = "checkbox" + + +class EnvelopeFieldCreateManyValueCheckboxTypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeFieldCreateManyValueCheckbox(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeFieldCreateManyDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeFieldCreateManyFieldMetaCheckboxRequestTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeCheckboxRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldCreateManyValueCheckboxTypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[EnvelopeFieldCreateManyDirectionCheckbox] + + +class EnvelopeFieldCreateManyFieldMetaCheckboxRequest(BaseModel): + type: EnvelopeFieldCreateManyTypeCheckboxRequest2 + + 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")] = 12 + + values: Optional[List[EnvelopeFieldCreateManyValueCheckbox]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[EnvelopeFieldCreateManyDirectionCheckbox] = ( + EnvelopeFieldCreateManyDirectionCheckbox.VERTICAL + ) + + +class EnvelopeFieldCreateManyDataCheckboxTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeCheckboxRequest1 + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeFieldCreateManyFieldMetaCheckboxRequestTypedDict] + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataCheckbox(BaseModel): + type: EnvelopeFieldCreateManyTypeCheckboxRequest1 + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeFieldCreateManyFieldMetaCheckboxRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +class EnvelopeFieldCreateManyTypeRadioRequest1(str, Enum): + RADIO = "RADIO" + + +class EnvelopeFieldCreateManyTypeRadioRequest2(str, Enum): + RADIO = "radio" + + +class EnvelopeFieldCreateManyValueRadioTypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeFieldCreateManyValueRadio(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeFieldCreateManyDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeFieldCreateManyFieldMetaRadioRequestTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeRadioRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldCreateManyValueRadioTypedDict]] + direction: NotRequired[EnvelopeFieldCreateManyDirectionRadio] + + +class EnvelopeFieldCreateManyFieldMetaRadioRequest(BaseModel): + type: EnvelopeFieldCreateManyTypeRadioRequest2 + + 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")] = 12 + + values: Optional[List[EnvelopeFieldCreateManyValueRadio]] = None + + direction: Optional[EnvelopeFieldCreateManyDirectionRadio] = ( + EnvelopeFieldCreateManyDirectionRadio.VERTICAL + ) + + +class EnvelopeFieldCreateManyDataRadioTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeRadioRequest1 + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeFieldCreateManyFieldMetaRadioRequestTypedDict] + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataRadio(BaseModel): + type: EnvelopeFieldCreateManyTypeRadioRequest1 + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeFieldCreateManyFieldMetaRadioRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +class EnvelopeFieldCreateManyTypeNumberRequest1(str, Enum): + NUMBER = "NUMBER" + + +class EnvelopeFieldCreateManyTypeNumberRequest2(str, Enum): + NUMBER = "number" + + +class EnvelopeFieldCreateManyTextAlignNumber(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeFieldCreateManyFieldMetaNumberRequestTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeNumberRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeFieldCreateManyVerticalAlignNumber]] + + +class EnvelopeFieldCreateManyFieldMetaNumberRequest(BaseModel): + type: EnvelopeFieldCreateManyTypeNumberRequest2 + + 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")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignNumber], + pydantic.Field(alias="textAlign"), + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeFieldCreateManyVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 EnvelopeFieldCreateManyDataNumberTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeNumberRequest1 + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeFieldCreateManyFieldMetaNumberRequestTypedDict] + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataNumber(BaseModel): + type: EnvelopeFieldCreateManyTypeNumberRequest1 + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeFieldCreateManyFieldMetaNumberRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +class EnvelopeFieldCreateManyTypeTextRequest1(str, Enum): + TEXT = "TEXT" + + +class EnvelopeFieldCreateManyTypeTextRequest2(str, Enum): + TEXT = "text" + + +class EnvelopeFieldCreateManyTextAlignText(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeFieldCreateManyFieldMetaTextRequestTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeTextRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeFieldCreateManyVerticalAlignText]] + + +class EnvelopeFieldCreateManyFieldMetaTextRequest(BaseModel): + type: EnvelopeFieldCreateManyTypeTextRequest2 + + 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")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignText], + pydantic.Field(alias="textAlign"), + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeFieldCreateManyVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 EnvelopeFieldCreateManyDataTextTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeTextRequest1 + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeFieldCreateManyFieldMetaTextRequestTypedDict] + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataText(BaseModel): + type: EnvelopeFieldCreateManyTypeTextRequest1 + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeFieldCreateManyFieldMetaTextRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +class EnvelopeFieldCreateManyTypeDateRequest1(str, Enum): + DATE = "DATE" + + +class EnvelopeFieldCreateManyTypeDateRequest2(str, Enum): + DATE = "date" + + +class EnvelopeFieldCreateManyTextAlignDate(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyFieldMetaDateRequestTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeDateRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignDate] + + +class EnvelopeFieldCreateManyFieldMetaDateRequest(BaseModel): + type: EnvelopeFieldCreateManyTypeDateRequest2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignDate], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldCreateManyDataDateTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeDateRequest1 + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeFieldCreateManyFieldMetaDateRequestTypedDict] + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataDate(BaseModel): + type: EnvelopeFieldCreateManyTypeDateRequest1 + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeFieldCreateManyFieldMetaDateRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +class EnvelopeFieldCreateManyTypeEmailRequest1(str, Enum): + EMAIL = "EMAIL" + + +class EnvelopeFieldCreateManyTypeEmailRequest2(str, Enum): + EMAIL = "email" + + +class EnvelopeFieldCreateManyTextAlignEmail(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyFieldMetaEmailRequestTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeEmailRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignEmail] + + +class EnvelopeFieldCreateManyFieldMetaEmailRequest(BaseModel): + type: EnvelopeFieldCreateManyTypeEmailRequest2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignEmail], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldCreateManyDataEmailTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeEmailRequest1 + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeFieldCreateManyFieldMetaEmailRequestTypedDict] + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataEmail(BaseModel): + type: EnvelopeFieldCreateManyTypeEmailRequest1 + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeFieldCreateManyFieldMetaEmailRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +class EnvelopeFieldCreateManyTypeNameRequest1(str, Enum): + NAME = "NAME" + + +class EnvelopeFieldCreateManyTypeNameRequest2(str, Enum): + NAME = "name" + + +class EnvelopeFieldCreateManyTextAlignName(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyFieldMetaNameRequestTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeNameRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignName] + + +class EnvelopeFieldCreateManyFieldMetaNameRequest(BaseModel): + type: EnvelopeFieldCreateManyTypeNameRequest2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignName], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldCreateManyDataNameTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeNameRequest1 + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeFieldCreateManyFieldMetaNameRequestTypedDict] + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataName(BaseModel): + type: EnvelopeFieldCreateManyTypeNameRequest1 + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeFieldCreateManyFieldMetaNameRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +class EnvelopeFieldCreateManyTypeInitialsRequest1(str, Enum): + INITIALS = "INITIALS" + + +class EnvelopeFieldCreateManyTypeInitialsRequest2(str, Enum): + INITIALS = "initials" + + +class EnvelopeFieldCreateManyTextAlignInitials(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyFieldMetaInitialsRequestTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeInitialsRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignInitials] + + +class EnvelopeFieldCreateManyFieldMetaInitialsRequest(BaseModel): + type: EnvelopeFieldCreateManyTypeInitialsRequest2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignInitials], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldCreateManyDataInitialsTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeInitialsRequest1 + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeFieldCreateManyFieldMetaInitialsRequestTypedDict] + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataInitials(BaseModel): + type: EnvelopeFieldCreateManyTypeInitialsRequest1 + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeFieldCreateManyFieldMetaInitialsRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +class EnvelopeFieldCreateManyTypeFreeSignature(str, Enum): + FREE_SIGNATURE = "FREE_SIGNATURE" + + +class EnvelopeFieldCreateManyDataFreeSignatureTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeFreeSignature + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataFreeSignature(BaseModel): + type: EnvelopeFieldCreateManyTypeFreeSignature + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +class EnvelopeFieldCreateManyTypeSignatureRequest1(str, Enum): + SIGNATURE = "SIGNATURE" + + +class EnvelopeFieldCreateManyTypeSignatureRequest2(str, Enum): + SIGNATURE = "signature" + + +class EnvelopeFieldCreateManyFieldMetaSignatureRequestTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeSignatureRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class EnvelopeFieldCreateManyFieldMetaSignatureRequest(BaseModel): + type: EnvelopeFieldCreateManyTypeSignatureRequest2 + + 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")] = 12 + + +class EnvelopeFieldCreateManyDataSignatureTypedDict(TypedDict): + type: EnvelopeFieldCreateManyTypeSignatureRequest1 + recipient_id: float + page: float + position_x: float + position_y: float + width: float + height: float + field_meta: NotRequired[EnvelopeFieldCreateManyFieldMetaSignatureRequestTypedDict] + envelope_item_id: NotRequired[str] + + +class EnvelopeFieldCreateManyDataSignature(BaseModel): + type: EnvelopeFieldCreateManyTypeSignatureRequest1 + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[float, pydantic.Field(alias="positionX")] + + position_y: Annotated[float, pydantic.Field(alias="positionY")] + + width: float + + height: float + + field_meta: Annotated[ + Optional[EnvelopeFieldCreateManyFieldMetaSignatureRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + +EnvelopeFieldCreateManyDataUnionTypedDict = TypeAliasType( + "EnvelopeFieldCreateManyDataUnionTypedDict", + Union[ + EnvelopeFieldCreateManyDataFreeSignatureTypedDict, + EnvelopeFieldCreateManyDataSignatureTypedDict, + EnvelopeFieldCreateManyDataInitialsTypedDict, + EnvelopeFieldCreateManyDataNameTypedDict, + EnvelopeFieldCreateManyDataEmailTypedDict, + EnvelopeFieldCreateManyDataDateTypedDict, + EnvelopeFieldCreateManyDataTextTypedDict, + EnvelopeFieldCreateManyDataNumberTypedDict, + EnvelopeFieldCreateManyDataRadioTypedDict, + EnvelopeFieldCreateManyDataCheckboxTypedDict, + EnvelopeFieldCreateManyDataDropdownTypedDict, + ], +) + + +EnvelopeFieldCreateManyDataUnion = TypeAliasType( + "EnvelopeFieldCreateManyDataUnion", + Union[ + EnvelopeFieldCreateManyDataFreeSignature, + EnvelopeFieldCreateManyDataSignature, + EnvelopeFieldCreateManyDataInitials, + EnvelopeFieldCreateManyDataName, + EnvelopeFieldCreateManyDataEmail, + EnvelopeFieldCreateManyDataDate, + EnvelopeFieldCreateManyDataText, + EnvelopeFieldCreateManyDataNumber, + EnvelopeFieldCreateManyDataRadio, + EnvelopeFieldCreateManyDataCheckbox, + EnvelopeFieldCreateManyDataDropdown, + ], +) + + +class EnvelopeFieldCreateManyRequestTypedDict(TypedDict): + envelope_id: str + data: List[EnvelopeFieldCreateManyDataUnionTypedDict] + + +class EnvelopeFieldCreateManyRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + data: List[EnvelopeFieldCreateManyDataUnion] + + +class EnvelopeFieldCreateManyInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldCreateManyInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeFieldCreateManyInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldCreateManyInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldCreateManyInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeFieldCreateManyInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldCreateManyInternalServerErrorData, + 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 EnvelopeFieldCreateManyForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldCreateManyForbiddenIssue(BaseModel): + message: str + + +class EnvelopeFieldCreateManyForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldCreateManyForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldCreateManyForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeFieldCreateManyForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldCreateManyForbiddenErrorData, + 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 EnvelopeFieldCreateManyUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldCreateManyUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeFieldCreateManyUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldCreateManyUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldCreateManyUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeFieldCreateManyUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldCreateManyUnauthorizedErrorData, + 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 EnvelopeFieldCreateManyBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldCreateManyBadRequestIssue(BaseModel): + message: str + + +class EnvelopeFieldCreateManyBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldCreateManyBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldCreateManyBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeFieldCreateManyBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldCreateManyBadRequestErrorData, + 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 EnvelopeFieldCreateManyTypeResponse(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 EnvelopeFieldCreateManyFieldMetaTypeDropdown(str, Enum): + DROPDOWN = "dropdown" + + +class EnvelopeFieldCreateManyValueResponse3TypedDict(TypedDict): + value: str + + +class EnvelopeFieldCreateManyValueResponse3(BaseModel): + value: str + + +class EnvelopeFieldCreateManyFieldMetaDropdownResponseTypedDict(TypedDict): + type: EnvelopeFieldCreateManyFieldMetaTypeDropdown + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldCreateManyValueResponse3TypedDict]] + default_value: NotRequired[str] + + +class EnvelopeFieldCreateManyFieldMetaDropdownResponse(BaseModel): + type: EnvelopeFieldCreateManyFieldMetaTypeDropdown + + 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")] = 12 + + values: Optional[List[EnvelopeFieldCreateManyValueResponse3]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +class EnvelopeFieldCreateManyFieldMetaTypeCheckbox(str, Enum): + CHECKBOX = "checkbox" + + +class EnvelopeFieldCreateManyValueResponse2TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeFieldCreateManyValueResponse2(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeFieldCreateManyDirectionResponse2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeFieldCreateManyFieldMetaCheckboxResponseTypedDict(TypedDict): + type: EnvelopeFieldCreateManyFieldMetaTypeCheckbox + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldCreateManyValueResponse2TypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[EnvelopeFieldCreateManyDirectionResponse2] + + +class EnvelopeFieldCreateManyFieldMetaCheckboxResponse(BaseModel): + type: EnvelopeFieldCreateManyFieldMetaTypeCheckbox + + 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")] = 12 + + values: Optional[List[EnvelopeFieldCreateManyValueResponse2]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[EnvelopeFieldCreateManyDirectionResponse2] = ( + EnvelopeFieldCreateManyDirectionResponse2.VERTICAL + ) + + +class EnvelopeFieldCreateManyFieldMetaTypeRadio(str, Enum): + RADIO = "radio" + + +class EnvelopeFieldCreateManyValueResponse1TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeFieldCreateManyValueResponse1(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeFieldCreateManyDirectionResponse1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeFieldCreateManyFieldMetaRadioResponseTypedDict(TypedDict): + type: EnvelopeFieldCreateManyFieldMetaTypeRadio + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldCreateManyValueResponse1TypedDict]] + direction: NotRequired[EnvelopeFieldCreateManyDirectionResponse1] + + +class EnvelopeFieldCreateManyFieldMetaRadioResponse(BaseModel): + type: EnvelopeFieldCreateManyFieldMetaTypeRadio + + 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")] = 12 + + values: Optional[List[EnvelopeFieldCreateManyValueResponse1]] = None + + direction: Optional[EnvelopeFieldCreateManyDirectionResponse1] = ( + EnvelopeFieldCreateManyDirectionResponse1.VERTICAL + ) + + +class EnvelopeFieldCreateManyFieldMetaTypeNumber(str, Enum): + NUMBER = "number" + + +class EnvelopeFieldCreateManyTextAlignResponse6(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyVerticalAlignResponse2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeFieldCreateManyFieldMetaNumberResponseTypedDict(TypedDict): + type: EnvelopeFieldCreateManyFieldMetaTypeNumber + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignResponse6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeFieldCreateManyVerticalAlignResponse2]] + + +class EnvelopeFieldCreateManyFieldMetaNumberResponse(BaseModel): + type: EnvelopeFieldCreateManyFieldMetaTypeNumber + + 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")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignResponse6], + pydantic.Field(alias="textAlign"), + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeFieldCreateManyVerticalAlignResponse2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 EnvelopeFieldCreateManyFieldMetaTypeText(str, Enum): + TEXT = "text" + + +class EnvelopeFieldCreateManyTextAlignResponse5(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyVerticalAlignResponse1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeFieldCreateManyFieldMetaTextResponseTypedDict(TypedDict): + type: EnvelopeFieldCreateManyFieldMetaTypeText + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignResponse5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeFieldCreateManyVerticalAlignResponse1]] + + +class EnvelopeFieldCreateManyFieldMetaTextResponse(BaseModel): + type: EnvelopeFieldCreateManyFieldMetaTypeText + + 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")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignResponse5], + pydantic.Field(alias="textAlign"), + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeFieldCreateManyVerticalAlignResponse1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 EnvelopeFieldCreateManyFieldMetaTypeDate(str, Enum): + DATE = "date" + + +class EnvelopeFieldCreateManyTextAlignResponse4(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyFieldMetaDateResponseTypedDict(TypedDict): + type: EnvelopeFieldCreateManyFieldMetaTypeDate + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignResponse4] + + +class EnvelopeFieldCreateManyFieldMetaDateResponse(BaseModel): + type: EnvelopeFieldCreateManyFieldMetaTypeDate + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignResponse4], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldCreateManyFieldMetaTypeEmail(str, Enum): + EMAIL = "email" + + +class EnvelopeFieldCreateManyTextAlignResponse3(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyFieldMetaEmailResponseTypedDict(TypedDict): + type: EnvelopeFieldCreateManyFieldMetaTypeEmail + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignResponse3] + + +class EnvelopeFieldCreateManyFieldMetaEmailResponse(BaseModel): + type: EnvelopeFieldCreateManyFieldMetaTypeEmail + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignResponse3], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldCreateManyFieldMetaTypeName(str, Enum): + NAME = "name" + + +class EnvelopeFieldCreateManyTextAlignResponse2(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyFieldMetaNameResponseTypedDict(TypedDict): + type: EnvelopeFieldCreateManyFieldMetaTypeName + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignResponse2] + + +class EnvelopeFieldCreateManyFieldMetaNameResponse(BaseModel): + type: EnvelopeFieldCreateManyFieldMetaTypeName + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignResponse2], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldCreateManyFieldMetaTypeInitials(str, Enum): + INITIALS = "initials" + + +class EnvelopeFieldCreateManyTextAlignResponse1(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldCreateManyFieldMetaInitialsResponseTypedDict(TypedDict): + type: EnvelopeFieldCreateManyFieldMetaTypeInitials + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldCreateManyTextAlignResponse1] + + +class EnvelopeFieldCreateManyFieldMetaInitialsResponse(BaseModel): + type: EnvelopeFieldCreateManyFieldMetaTypeInitials + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldCreateManyTextAlignResponse1], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldCreateManyFieldMetaTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class EnvelopeFieldCreateManyFieldMetaSignatureResponseTypedDict(TypedDict): + type: EnvelopeFieldCreateManyFieldMetaTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class EnvelopeFieldCreateManyFieldMetaSignatureResponse(BaseModel): + type: EnvelopeFieldCreateManyFieldMetaTypeSignature + + 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")] = 12 + + +EnvelopeFieldCreateManyFieldMetaUnionTypedDict = TypeAliasType( + "EnvelopeFieldCreateManyFieldMetaUnionTypedDict", + Union[ + EnvelopeFieldCreateManyFieldMetaSignatureResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaInitialsResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaNameResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaEmailResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaDateResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaRadioResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaDropdownResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaCheckboxResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaTextResponseTypedDict, + EnvelopeFieldCreateManyFieldMetaNumberResponseTypedDict, + ], +) + + +EnvelopeFieldCreateManyFieldMetaUnion = TypeAliasType( + "EnvelopeFieldCreateManyFieldMetaUnion", + Union[ + EnvelopeFieldCreateManyFieldMetaSignatureResponse, + EnvelopeFieldCreateManyFieldMetaInitialsResponse, + EnvelopeFieldCreateManyFieldMetaNameResponse, + EnvelopeFieldCreateManyFieldMetaEmailResponse, + EnvelopeFieldCreateManyFieldMetaDateResponse, + EnvelopeFieldCreateManyFieldMetaRadioResponse, + EnvelopeFieldCreateManyFieldMetaDropdownResponse, + EnvelopeFieldCreateManyFieldMetaCheckboxResponse, + EnvelopeFieldCreateManyFieldMetaTextResponse, + EnvelopeFieldCreateManyFieldMetaNumberResponse, + ], +) + + +class EnvelopeFieldCreateManyDataResponseTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str + type: EnvelopeFieldCreateManyTypeResponse + id: float + secondary_id: str + recipient_id: float + page: float + position_x: Any + position_y: Any + width: Any + height: Any + custom_text: str + inserted: bool + field_meta: Nullable[EnvelopeFieldCreateManyFieldMetaUnionTypedDict] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] + + +class EnvelopeFieldCreateManyDataResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + type: EnvelopeFieldCreateManyTypeResponse + + id: float + + secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any + + custom_text: Annotated[str, pydantic.Field(alias="customText")] + + inserted: bool + + field_meta: Annotated[ + Nullable[EnvelopeFieldCreateManyFieldMetaUnion], + pydantic.Field(alias="fieldMeta"), + ] + + 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 = ["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 EnvelopeFieldCreateManyResponseTypedDict(TypedDict): + r"""Successful response""" + + data: List[EnvelopeFieldCreateManyDataResponseTypedDict] + + +class EnvelopeFieldCreateManyResponse(BaseModel): + r"""Successful response""" + + data: List[EnvelopeFieldCreateManyDataResponse] diff --git a/src/documenso_sdk/models/envelope_field_deleteop.py b/src/documenso_sdk/models/envelope_field_deleteop.py new file mode 100644 index 0000000..41b8d7d --- /dev/null +++ b/src/documenso_sdk/models/envelope_field_deleteop.py @@ -0,0 +1,166 @@ +"""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 EnvelopeFieldDeleteRequestTypedDict(TypedDict): + field_id: float + + +class EnvelopeFieldDeleteRequest(BaseModel): + field_id: Annotated[float, pydantic.Field(alias="fieldId")] + + +class EnvelopeFieldDeleteInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldDeleteInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeFieldDeleteInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldDeleteInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldDeleteInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeFieldDeleteInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldDeleteInternalServerErrorData, + 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 EnvelopeFieldDeleteForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldDeleteForbiddenIssue(BaseModel): + message: str + + +class EnvelopeFieldDeleteForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldDeleteForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldDeleteForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeFieldDeleteForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldDeleteForbiddenErrorData, + 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 EnvelopeFieldDeleteUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldDeleteUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeFieldDeleteUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldDeleteUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldDeleteUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeFieldDeleteUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldDeleteUnauthorizedErrorData, + 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 EnvelopeFieldDeleteBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldDeleteBadRequestIssue(BaseModel): + message: str + + +class EnvelopeFieldDeleteBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldDeleteBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldDeleteBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeFieldDeleteBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldDeleteBadRequestErrorData, + 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 EnvelopeFieldDeleteResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class EnvelopeFieldDeleteResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/envelope_field_getop.py b/src/documenso_sdk/models/envelope_field_getop.py new file mode 100644 index 0000000..7e79f47 --- /dev/null +++ b/src/documenso_sdk/models/envelope_field_getop.py @@ -0,0 +1,909 @@ +"""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 documenso_sdk.utils import FieldMetadata, PathParamMetadata +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 EnvelopeFieldGetRequestTypedDict(TypedDict): + field_id: float + + +class EnvelopeFieldGetRequest(BaseModel): + field_id: Annotated[ + float, + pydantic.Field(alias="fieldId"), + FieldMetadata(path=PathParamMetadata(style="simple", explode=False)), + ] + + +class EnvelopeFieldGetInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldGetInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeFieldGetInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldGetInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldGetInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeFieldGetInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldGetInternalServerErrorData, + 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 EnvelopeFieldGetNotFoundIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldGetNotFoundIssue(BaseModel): + message: str + + +class EnvelopeFieldGetNotFoundErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldGetNotFoundIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldGetNotFoundError(DocumensoError): + r"""Not found""" + + data: EnvelopeFieldGetNotFoundErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldGetNotFoundErrorData, + 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 EnvelopeFieldGetForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldGetForbiddenIssue(BaseModel): + message: str + + +class EnvelopeFieldGetForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldGetForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldGetForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeFieldGetForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldGetForbiddenErrorData, + 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 EnvelopeFieldGetUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldGetUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeFieldGetUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldGetUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldGetUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeFieldGetUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldGetUnauthorizedErrorData, + 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 EnvelopeFieldGetBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldGetBadRequestIssue(BaseModel): + message: str + + +class EnvelopeFieldGetBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldGetBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldGetBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeFieldGetBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldGetBadRequestErrorData, + 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 EnvelopeFieldGetType(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 EnvelopeFieldGetTypeDropdown(str, Enum): + DROPDOWN = "dropdown" + + +class EnvelopeFieldGetValue3TypedDict(TypedDict): + value: str + + +class EnvelopeFieldGetValue3(BaseModel): + value: str + + +class EnvelopeFieldGetFieldMetaDropdownTypedDict(TypedDict): + type: EnvelopeFieldGetTypeDropdown + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldGetValue3TypedDict]] + default_value: NotRequired[str] + + +class EnvelopeFieldGetFieldMetaDropdown(BaseModel): + type: EnvelopeFieldGetTypeDropdown + + 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")] = 12 + + values: Optional[List[EnvelopeFieldGetValue3]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +class EnvelopeFieldGetTypeCheckbox(str, Enum): + CHECKBOX = "checkbox" + + +class EnvelopeFieldGetValue2TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeFieldGetValue2(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeFieldGetDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeFieldGetFieldMetaCheckboxTypedDict(TypedDict): + type: EnvelopeFieldGetTypeCheckbox + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldGetValue2TypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[EnvelopeFieldGetDirection2] + + +class EnvelopeFieldGetFieldMetaCheckbox(BaseModel): + type: EnvelopeFieldGetTypeCheckbox + + 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")] = 12 + + values: Optional[List[EnvelopeFieldGetValue2]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[EnvelopeFieldGetDirection2] = ( + EnvelopeFieldGetDirection2.VERTICAL + ) + + +class EnvelopeFieldGetTypeRadio(str, Enum): + RADIO = "radio" + + +class EnvelopeFieldGetValue1TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeFieldGetValue1(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeFieldGetDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeFieldGetFieldMetaRadioTypedDict(TypedDict): + type: EnvelopeFieldGetTypeRadio + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldGetValue1TypedDict]] + direction: NotRequired[EnvelopeFieldGetDirection1] + + +class EnvelopeFieldGetFieldMetaRadio(BaseModel): + type: EnvelopeFieldGetTypeRadio + + 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")] = 12 + + values: Optional[List[EnvelopeFieldGetValue1]] = None + + direction: Optional[EnvelopeFieldGetDirection1] = ( + EnvelopeFieldGetDirection1.VERTICAL + ) + + +class EnvelopeFieldGetTypeNumber(str, Enum): + NUMBER = "number" + + +class EnvelopeFieldGetTextAlign6(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldGetVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeFieldGetFieldMetaNumberTypedDict(TypedDict): + type: EnvelopeFieldGetTypeNumber + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[EnvelopeFieldGetTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeFieldGetVerticalAlign2]] + + +class EnvelopeFieldGetFieldMetaNumber(BaseModel): + type: EnvelopeFieldGetTypeNumber + + 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")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[EnvelopeFieldGetTextAlign6], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeFieldGetVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 EnvelopeFieldGetTypeText(str, Enum): + TEXT = "text" + + +class EnvelopeFieldGetTextAlign5(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldGetVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeFieldGetFieldMetaTextTypedDict(TypedDict): + type: EnvelopeFieldGetTypeText + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[EnvelopeFieldGetTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeFieldGetVerticalAlign1]] + + +class EnvelopeFieldGetFieldMetaText(BaseModel): + type: EnvelopeFieldGetTypeText + + 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")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[EnvelopeFieldGetTextAlign5], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeFieldGetVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 EnvelopeFieldGetTypeDate(str, Enum): + DATE = "date" + + +class EnvelopeFieldGetTextAlign4(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldGetFieldMetaDateTypedDict(TypedDict): + type: EnvelopeFieldGetTypeDate + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldGetTextAlign4] + + +class EnvelopeFieldGetFieldMetaDate(BaseModel): + type: EnvelopeFieldGetTypeDate + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldGetTextAlign4], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeFieldGetTypeEmail(str, Enum): + EMAIL = "email" + + +class EnvelopeFieldGetTextAlign3(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldGetFieldMetaEmailTypedDict(TypedDict): + type: EnvelopeFieldGetTypeEmail + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldGetTextAlign3] + + +class EnvelopeFieldGetFieldMetaEmail(BaseModel): + type: EnvelopeFieldGetTypeEmail + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldGetTextAlign3], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeFieldGetTypeName(str, Enum): + NAME = "name" + + +class EnvelopeFieldGetTextAlign2(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldGetFieldMetaNameTypedDict(TypedDict): + type: EnvelopeFieldGetTypeName + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldGetTextAlign2] + + +class EnvelopeFieldGetFieldMetaName(BaseModel): + type: EnvelopeFieldGetTypeName + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldGetTextAlign2], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeFieldGetTypeInitials(str, Enum): + INITIALS = "initials" + + +class EnvelopeFieldGetTextAlign1(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldGetFieldMetaInitialsTypedDict(TypedDict): + type: EnvelopeFieldGetTypeInitials + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldGetTextAlign1] + + +class EnvelopeFieldGetFieldMetaInitials(BaseModel): + type: EnvelopeFieldGetTypeInitials + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldGetTextAlign1], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeFieldGetTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class EnvelopeFieldGetFieldMetaSignatureTypedDict(TypedDict): + type: EnvelopeFieldGetTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class EnvelopeFieldGetFieldMetaSignature(BaseModel): + type: EnvelopeFieldGetTypeSignature + + 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")] = 12 + + +EnvelopeFieldGetFieldMetaUnionTypedDict = TypeAliasType( + "EnvelopeFieldGetFieldMetaUnionTypedDict", + Union[ + EnvelopeFieldGetFieldMetaSignatureTypedDict, + EnvelopeFieldGetFieldMetaInitialsTypedDict, + EnvelopeFieldGetFieldMetaNameTypedDict, + EnvelopeFieldGetFieldMetaEmailTypedDict, + EnvelopeFieldGetFieldMetaDateTypedDict, + EnvelopeFieldGetFieldMetaRadioTypedDict, + EnvelopeFieldGetFieldMetaDropdownTypedDict, + EnvelopeFieldGetFieldMetaCheckboxTypedDict, + EnvelopeFieldGetFieldMetaTextTypedDict, + EnvelopeFieldGetFieldMetaNumberTypedDict, + ], +) + + +EnvelopeFieldGetFieldMetaUnion = TypeAliasType( + "EnvelopeFieldGetFieldMetaUnion", + Union[ + EnvelopeFieldGetFieldMetaSignature, + EnvelopeFieldGetFieldMetaInitials, + EnvelopeFieldGetFieldMetaName, + EnvelopeFieldGetFieldMetaEmail, + EnvelopeFieldGetFieldMetaDate, + EnvelopeFieldGetFieldMetaRadio, + EnvelopeFieldGetFieldMetaDropdown, + EnvelopeFieldGetFieldMetaCheckbox, + EnvelopeFieldGetFieldMetaText, + EnvelopeFieldGetFieldMetaNumber, + ], +) + + +class EnvelopeFieldGetResponseTypedDict(TypedDict): + r"""Successful response""" + + envelope_id: str + envelope_item_id: str + type: EnvelopeFieldGetType + id: float + secondary_id: str + recipient_id: float + page: float + position_x: Any + position_y: Any + width: Any + height: Any + custom_text: str + inserted: bool + field_meta: Nullable[EnvelopeFieldGetFieldMetaUnionTypedDict] + + +class EnvelopeFieldGetResponse(BaseModel): + r"""Successful response""" + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + type: EnvelopeFieldGetType + + id: float + + secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any + + custom_text: Annotated[str, pydantic.Field(alias="customText")] + + inserted: bool + + field_meta: Annotated[ + Nullable[EnvelopeFieldGetFieldMetaUnion], pydantic.Field(alias="fieldMeta") + ] + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = ["fieldMeta"] + 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 diff --git a/src/documenso_sdk/models/envelope_field_updatemanyop.py b/src/documenso_sdk/models/envelope_field_updatemanyop.py new file mode 100644 index 0000000..0b2b231 --- /dev/null +++ b/src/documenso_sdk/models/envelope_field_updatemanyop.py @@ -0,0 +1,1962 @@ +"""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 EnvelopeFieldUpdateManyTypeDropdownRequest1(str, Enum): + DROPDOWN = "DROPDOWN" + + +class EnvelopeFieldUpdateManyTypeDropdownRequest2(str, Enum): + DROPDOWN = "dropdown" + + +class EnvelopeFieldUpdateManyValueDropdownTypedDict(TypedDict): + value: str + + +class EnvelopeFieldUpdateManyValueDropdown(BaseModel): + value: str + + +class EnvelopeFieldUpdateManyFieldMetaDropdownRequestTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeDropdownRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldUpdateManyValueDropdownTypedDict]] + default_value: NotRequired[str] + + +class EnvelopeFieldUpdateManyFieldMetaDropdownRequest(BaseModel): + type: EnvelopeFieldUpdateManyTypeDropdownRequest2 + + 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")] = 12 + + values: Optional[List[EnvelopeFieldUpdateManyValueDropdown]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +class EnvelopeFieldUpdateManyDataDropdownTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeDropdownRequest1 + id: float + field_meta: NotRequired[EnvelopeFieldUpdateManyFieldMetaDropdownRequestTypedDict] + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataDropdown(BaseModel): + type: EnvelopeFieldUpdateManyTypeDropdownRequest1 + + id: float + + field_meta: Annotated[ + Optional[EnvelopeFieldUpdateManyFieldMetaDropdownRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +class EnvelopeFieldUpdateManyTypeCheckboxRequest1(str, Enum): + CHECKBOX = "CHECKBOX" + + +class EnvelopeFieldUpdateManyTypeCheckboxRequest2(str, Enum): + CHECKBOX = "checkbox" + + +class EnvelopeFieldUpdateManyValueCheckboxTypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeFieldUpdateManyValueCheckbox(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeFieldUpdateManyDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeFieldUpdateManyFieldMetaCheckboxRequestTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeCheckboxRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldUpdateManyValueCheckboxTypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[EnvelopeFieldUpdateManyDirectionCheckbox] + + +class EnvelopeFieldUpdateManyFieldMetaCheckboxRequest(BaseModel): + type: EnvelopeFieldUpdateManyTypeCheckboxRequest2 + + 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")] = 12 + + values: Optional[List[EnvelopeFieldUpdateManyValueCheckbox]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[EnvelopeFieldUpdateManyDirectionCheckbox] = ( + EnvelopeFieldUpdateManyDirectionCheckbox.VERTICAL + ) + + +class EnvelopeFieldUpdateManyDataCheckboxTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeCheckboxRequest1 + id: float + field_meta: NotRequired[EnvelopeFieldUpdateManyFieldMetaCheckboxRequestTypedDict] + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataCheckbox(BaseModel): + type: EnvelopeFieldUpdateManyTypeCheckboxRequest1 + + id: float + + field_meta: Annotated[ + Optional[EnvelopeFieldUpdateManyFieldMetaCheckboxRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +class EnvelopeFieldUpdateManyTypeRadioRequest1(str, Enum): + RADIO = "RADIO" + + +class EnvelopeFieldUpdateManyTypeRadioRequest2(str, Enum): + RADIO = "radio" + + +class EnvelopeFieldUpdateManyValueRadioTypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeFieldUpdateManyValueRadio(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeFieldUpdateManyDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeFieldUpdateManyFieldMetaRadioRequestTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeRadioRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldUpdateManyValueRadioTypedDict]] + direction: NotRequired[EnvelopeFieldUpdateManyDirectionRadio] + + +class EnvelopeFieldUpdateManyFieldMetaRadioRequest(BaseModel): + type: EnvelopeFieldUpdateManyTypeRadioRequest2 + + 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")] = 12 + + values: Optional[List[EnvelopeFieldUpdateManyValueRadio]] = None + + direction: Optional[EnvelopeFieldUpdateManyDirectionRadio] = ( + EnvelopeFieldUpdateManyDirectionRadio.VERTICAL + ) + + +class EnvelopeFieldUpdateManyDataRadioTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeRadioRequest1 + id: float + field_meta: NotRequired[EnvelopeFieldUpdateManyFieldMetaRadioRequestTypedDict] + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataRadio(BaseModel): + type: EnvelopeFieldUpdateManyTypeRadioRequest1 + + id: float + + field_meta: Annotated[ + Optional[EnvelopeFieldUpdateManyFieldMetaRadioRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +class EnvelopeFieldUpdateManyTypeNumberRequest1(str, Enum): + NUMBER = "NUMBER" + + +class EnvelopeFieldUpdateManyTypeNumberRequest2(str, Enum): + NUMBER = "number" + + +class EnvelopeFieldUpdateManyTextAlignNumber(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeFieldUpdateManyFieldMetaNumberRequestTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeNumberRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeFieldUpdateManyVerticalAlignNumber]] + + +class EnvelopeFieldUpdateManyFieldMetaNumberRequest(BaseModel): + type: EnvelopeFieldUpdateManyTypeNumberRequest2 + + 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")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignNumber], + pydantic.Field(alias="textAlign"), + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeFieldUpdateManyVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 EnvelopeFieldUpdateManyDataNumberTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeNumberRequest1 + id: float + field_meta: NotRequired[EnvelopeFieldUpdateManyFieldMetaNumberRequestTypedDict] + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataNumber(BaseModel): + type: EnvelopeFieldUpdateManyTypeNumberRequest1 + + id: float + + field_meta: Annotated[ + Optional[EnvelopeFieldUpdateManyFieldMetaNumberRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +class EnvelopeFieldUpdateManyTypeTextRequest1(str, Enum): + TEXT = "TEXT" + + +class EnvelopeFieldUpdateManyTypeTextRequest2(str, Enum): + TEXT = "text" + + +class EnvelopeFieldUpdateManyTextAlignText(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeFieldUpdateManyFieldMetaTextRequestTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeTextRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeFieldUpdateManyVerticalAlignText]] + + +class EnvelopeFieldUpdateManyFieldMetaTextRequest(BaseModel): + type: EnvelopeFieldUpdateManyTypeTextRequest2 + + 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")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignText], + pydantic.Field(alias="textAlign"), + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeFieldUpdateManyVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 EnvelopeFieldUpdateManyDataTextTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeTextRequest1 + id: float + field_meta: NotRequired[EnvelopeFieldUpdateManyFieldMetaTextRequestTypedDict] + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataText(BaseModel): + type: EnvelopeFieldUpdateManyTypeTextRequest1 + + id: float + + field_meta: Annotated[ + Optional[EnvelopeFieldUpdateManyFieldMetaTextRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +class EnvelopeFieldUpdateManyTypeDateRequest1(str, Enum): + DATE = "DATE" + + +class EnvelopeFieldUpdateManyTypeDateRequest2(str, Enum): + DATE = "date" + + +class EnvelopeFieldUpdateManyTextAlignDate(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyFieldMetaDateRequestTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeDateRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignDate] + + +class EnvelopeFieldUpdateManyFieldMetaDateRequest(BaseModel): + type: EnvelopeFieldUpdateManyTypeDateRequest2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignDate], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldUpdateManyDataDateTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeDateRequest1 + id: float + field_meta: NotRequired[EnvelopeFieldUpdateManyFieldMetaDateRequestTypedDict] + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataDate(BaseModel): + type: EnvelopeFieldUpdateManyTypeDateRequest1 + + id: float + + field_meta: Annotated[ + Optional[EnvelopeFieldUpdateManyFieldMetaDateRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +class EnvelopeFieldUpdateManyTypeEmailRequest1(str, Enum): + EMAIL = "EMAIL" + + +class EnvelopeFieldUpdateManyTypeEmailRequest2(str, Enum): + EMAIL = "email" + + +class EnvelopeFieldUpdateManyTextAlignEmail(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyFieldMetaEmailRequestTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeEmailRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignEmail] + + +class EnvelopeFieldUpdateManyFieldMetaEmailRequest(BaseModel): + type: EnvelopeFieldUpdateManyTypeEmailRequest2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignEmail], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldUpdateManyDataEmailTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeEmailRequest1 + id: float + field_meta: NotRequired[EnvelopeFieldUpdateManyFieldMetaEmailRequestTypedDict] + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataEmail(BaseModel): + type: EnvelopeFieldUpdateManyTypeEmailRequest1 + + id: float + + field_meta: Annotated[ + Optional[EnvelopeFieldUpdateManyFieldMetaEmailRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +class EnvelopeFieldUpdateManyTypeNameRequest1(str, Enum): + NAME = "NAME" + + +class EnvelopeFieldUpdateManyTypeNameRequest2(str, Enum): + NAME = "name" + + +class EnvelopeFieldUpdateManyTextAlignName(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyFieldMetaNameRequestTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeNameRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignName] + + +class EnvelopeFieldUpdateManyFieldMetaNameRequest(BaseModel): + type: EnvelopeFieldUpdateManyTypeNameRequest2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignName], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldUpdateManyDataNameTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeNameRequest1 + id: float + field_meta: NotRequired[EnvelopeFieldUpdateManyFieldMetaNameRequestTypedDict] + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataName(BaseModel): + type: EnvelopeFieldUpdateManyTypeNameRequest1 + + id: float + + field_meta: Annotated[ + Optional[EnvelopeFieldUpdateManyFieldMetaNameRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +class EnvelopeFieldUpdateManyTypeInitialsRequest1(str, Enum): + INITIALS = "INITIALS" + + +class EnvelopeFieldUpdateManyTypeInitialsRequest2(str, Enum): + INITIALS = "initials" + + +class EnvelopeFieldUpdateManyTextAlignInitials(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyFieldMetaInitialsRequestTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeInitialsRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignInitials] + + +class EnvelopeFieldUpdateManyFieldMetaInitialsRequest(BaseModel): + type: EnvelopeFieldUpdateManyTypeInitialsRequest2 + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignInitials], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldUpdateManyDataInitialsTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeInitialsRequest1 + id: float + field_meta: NotRequired[EnvelopeFieldUpdateManyFieldMetaInitialsRequestTypedDict] + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataInitials(BaseModel): + type: EnvelopeFieldUpdateManyTypeInitialsRequest1 + + id: float + + field_meta: Annotated[ + Optional[EnvelopeFieldUpdateManyFieldMetaInitialsRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +class EnvelopeFieldUpdateManyTypeFreeSignature(str, Enum): + FREE_SIGNATURE = "FREE_SIGNATURE" + + +class EnvelopeFieldUpdateManyDataFreeSignatureTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeFreeSignature + id: float + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataFreeSignature(BaseModel): + type: EnvelopeFieldUpdateManyTypeFreeSignature + + id: float + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +class EnvelopeFieldUpdateManyTypeSignatureRequest1(str, Enum): + SIGNATURE = "SIGNATURE" + + +class EnvelopeFieldUpdateManyTypeSignatureRequest2(str, Enum): + SIGNATURE = "signature" + + +class EnvelopeFieldUpdateManyFieldMetaSignatureRequestTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeSignatureRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class EnvelopeFieldUpdateManyFieldMetaSignatureRequest(BaseModel): + type: EnvelopeFieldUpdateManyTypeSignatureRequest2 + + 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")] = 12 + + +class EnvelopeFieldUpdateManyDataSignatureTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyTypeSignatureRequest1 + id: float + field_meta: NotRequired[EnvelopeFieldUpdateManyFieldMetaSignatureRequestTypedDict] + envelope_item_id: NotRequired[str] + page: NotRequired[float] + position_x: NotRequired[float] + position_y: NotRequired[float] + width: NotRequired[float] + height: NotRequired[float] + + +class EnvelopeFieldUpdateManyDataSignature(BaseModel): + type: EnvelopeFieldUpdateManyTypeSignatureRequest1 + + id: float + + field_meta: Annotated[ + Optional[EnvelopeFieldUpdateManyFieldMetaSignatureRequest], + pydantic.Field(alias="fieldMeta"), + ] = None + + envelope_item_id: Annotated[ + Optional[str], pydantic.Field(alias="envelopeItemId") + ] = None + + page: Optional[float] = None + + position_x: Annotated[Optional[float], pydantic.Field(alias="positionX")] = None + + position_y: Annotated[Optional[float], pydantic.Field(alias="positionY")] = None + + width: Optional[float] = None + + height: Optional[float] = None + + +EnvelopeFieldUpdateManyDataUnionTypedDict = TypeAliasType( + "EnvelopeFieldUpdateManyDataUnionTypedDict", + Union[ + EnvelopeFieldUpdateManyDataFreeSignatureTypedDict, + EnvelopeFieldUpdateManyDataSignatureTypedDict, + EnvelopeFieldUpdateManyDataInitialsTypedDict, + EnvelopeFieldUpdateManyDataNameTypedDict, + EnvelopeFieldUpdateManyDataEmailTypedDict, + EnvelopeFieldUpdateManyDataDateTypedDict, + EnvelopeFieldUpdateManyDataTextTypedDict, + EnvelopeFieldUpdateManyDataNumberTypedDict, + EnvelopeFieldUpdateManyDataRadioTypedDict, + EnvelopeFieldUpdateManyDataCheckboxTypedDict, + EnvelopeFieldUpdateManyDataDropdownTypedDict, + ], +) + + +EnvelopeFieldUpdateManyDataUnion = TypeAliasType( + "EnvelopeFieldUpdateManyDataUnion", + Union[ + EnvelopeFieldUpdateManyDataFreeSignature, + EnvelopeFieldUpdateManyDataSignature, + EnvelopeFieldUpdateManyDataInitials, + EnvelopeFieldUpdateManyDataName, + EnvelopeFieldUpdateManyDataEmail, + EnvelopeFieldUpdateManyDataDate, + EnvelopeFieldUpdateManyDataText, + EnvelopeFieldUpdateManyDataNumber, + EnvelopeFieldUpdateManyDataRadio, + EnvelopeFieldUpdateManyDataCheckbox, + EnvelopeFieldUpdateManyDataDropdown, + ], +) + + +class EnvelopeFieldUpdateManyRequestTypedDict(TypedDict): + envelope_id: str + data: List[EnvelopeFieldUpdateManyDataUnionTypedDict] + + +class EnvelopeFieldUpdateManyRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + data: List[EnvelopeFieldUpdateManyDataUnion] + + +class EnvelopeFieldUpdateManyInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldUpdateManyInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeFieldUpdateManyInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldUpdateManyInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldUpdateManyInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeFieldUpdateManyInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldUpdateManyInternalServerErrorData, + 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 EnvelopeFieldUpdateManyForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldUpdateManyForbiddenIssue(BaseModel): + message: str + + +class EnvelopeFieldUpdateManyForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldUpdateManyForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldUpdateManyForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeFieldUpdateManyForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldUpdateManyForbiddenErrorData, + 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 EnvelopeFieldUpdateManyUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldUpdateManyUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeFieldUpdateManyUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldUpdateManyUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldUpdateManyUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeFieldUpdateManyUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldUpdateManyUnauthorizedErrorData, + 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 EnvelopeFieldUpdateManyBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeFieldUpdateManyBadRequestIssue(BaseModel): + message: str + + +class EnvelopeFieldUpdateManyBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeFieldUpdateManyBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeFieldUpdateManyBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeFieldUpdateManyBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeFieldUpdateManyBadRequestErrorData, + 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 EnvelopeFieldUpdateManyTypeResponse(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 EnvelopeFieldUpdateManyFieldMetaTypeDropdown(str, Enum): + DROPDOWN = "dropdown" + + +class EnvelopeFieldUpdateManyValueResponse3TypedDict(TypedDict): + value: str + + +class EnvelopeFieldUpdateManyValueResponse3(BaseModel): + value: str + + +class EnvelopeFieldUpdateManyFieldMetaDropdownResponseTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyFieldMetaTypeDropdown + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldUpdateManyValueResponse3TypedDict]] + default_value: NotRequired[str] + + +class EnvelopeFieldUpdateManyFieldMetaDropdownResponse(BaseModel): + type: EnvelopeFieldUpdateManyFieldMetaTypeDropdown + + 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")] = 12 + + values: Optional[List[EnvelopeFieldUpdateManyValueResponse3]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +class EnvelopeFieldUpdateManyFieldMetaTypeCheckbox(str, Enum): + CHECKBOX = "checkbox" + + +class EnvelopeFieldUpdateManyValueResponse2TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeFieldUpdateManyValueResponse2(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeFieldUpdateManyDirectionResponse2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeFieldUpdateManyFieldMetaCheckboxResponseTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyFieldMetaTypeCheckbox + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldUpdateManyValueResponse2TypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[EnvelopeFieldUpdateManyDirectionResponse2] + + +class EnvelopeFieldUpdateManyFieldMetaCheckboxResponse(BaseModel): + type: EnvelopeFieldUpdateManyFieldMetaTypeCheckbox + + 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")] = 12 + + values: Optional[List[EnvelopeFieldUpdateManyValueResponse2]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[EnvelopeFieldUpdateManyDirectionResponse2] = ( + EnvelopeFieldUpdateManyDirectionResponse2.VERTICAL + ) + + +class EnvelopeFieldUpdateManyFieldMetaTypeRadio(str, Enum): + RADIO = "radio" + + +class EnvelopeFieldUpdateManyValueResponse1TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeFieldUpdateManyValueResponse1(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeFieldUpdateManyDirectionResponse1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeFieldUpdateManyFieldMetaRadioResponseTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyFieldMetaTypeRadio + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeFieldUpdateManyValueResponse1TypedDict]] + direction: NotRequired[EnvelopeFieldUpdateManyDirectionResponse1] + + +class EnvelopeFieldUpdateManyFieldMetaRadioResponse(BaseModel): + type: EnvelopeFieldUpdateManyFieldMetaTypeRadio + + 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")] = 12 + + values: Optional[List[EnvelopeFieldUpdateManyValueResponse1]] = None + + direction: Optional[EnvelopeFieldUpdateManyDirectionResponse1] = ( + EnvelopeFieldUpdateManyDirectionResponse1.VERTICAL + ) + + +class EnvelopeFieldUpdateManyFieldMetaTypeNumber(str, Enum): + NUMBER = "number" + + +class EnvelopeFieldUpdateManyTextAlignResponse6(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyVerticalAlignResponse2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeFieldUpdateManyFieldMetaNumberResponseTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyFieldMetaTypeNumber + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignResponse6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeFieldUpdateManyVerticalAlignResponse2]] + + +class EnvelopeFieldUpdateManyFieldMetaNumberResponse(BaseModel): + type: EnvelopeFieldUpdateManyFieldMetaTypeNumber + + 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")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignResponse6], + pydantic.Field(alias="textAlign"), + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeFieldUpdateManyVerticalAlignResponse2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 EnvelopeFieldUpdateManyFieldMetaTypeText(str, Enum): + TEXT = "text" + + +class EnvelopeFieldUpdateManyTextAlignResponse5(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyVerticalAlignResponse1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeFieldUpdateManyFieldMetaTextResponseTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyFieldMetaTypeText + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignResponse5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeFieldUpdateManyVerticalAlignResponse1]] + + +class EnvelopeFieldUpdateManyFieldMetaTextResponse(BaseModel): + type: EnvelopeFieldUpdateManyFieldMetaTypeText + + 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")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignResponse5], + pydantic.Field(alias="textAlign"), + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeFieldUpdateManyVerticalAlignResponse1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 EnvelopeFieldUpdateManyFieldMetaTypeDate(str, Enum): + DATE = "date" + + +class EnvelopeFieldUpdateManyTextAlignResponse4(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyFieldMetaDateResponseTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyFieldMetaTypeDate + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignResponse4] + + +class EnvelopeFieldUpdateManyFieldMetaDateResponse(BaseModel): + type: EnvelopeFieldUpdateManyFieldMetaTypeDate + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignResponse4], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldUpdateManyFieldMetaTypeEmail(str, Enum): + EMAIL = "email" + + +class EnvelopeFieldUpdateManyTextAlignResponse3(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyFieldMetaEmailResponseTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyFieldMetaTypeEmail + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignResponse3] + + +class EnvelopeFieldUpdateManyFieldMetaEmailResponse(BaseModel): + type: EnvelopeFieldUpdateManyFieldMetaTypeEmail + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignResponse3], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldUpdateManyFieldMetaTypeName(str, Enum): + NAME = "name" + + +class EnvelopeFieldUpdateManyTextAlignResponse2(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyFieldMetaNameResponseTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyFieldMetaTypeName + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignResponse2] + + +class EnvelopeFieldUpdateManyFieldMetaNameResponse(BaseModel): + type: EnvelopeFieldUpdateManyFieldMetaTypeName + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignResponse2], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldUpdateManyFieldMetaTypeInitials(str, Enum): + INITIALS = "initials" + + +class EnvelopeFieldUpdateManyTextAlignResponse1(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeFieldUpdateManyFieldMetaInitialsResponseTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyFieldMetaTypeInitials + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeFieldUpdateManyTextAlignResponse1] + + +class EnvelopeFieldUpdateManyFieldMetaInitialsResponse(BaseModel): + type: EnvelopeFieldUpdateManyFieldMetaTypeInitials + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeFieldUpdateManyTextAlignResponse1], + pydantic.Field(alias="textAlign"), + ] = None + + +class EnvelopeFieldUpdateManyFieldMetaTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class EnvelopeFieldUpdateManyFieldMetaSignatureResponseTypedDict(TypedDict): + type: EnvelopeFieldUpdateManyFieldMetaTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class EnvelopeFieldUpdateManyFieldMetaSignatureResponse(BaseModel): + type: EnvelopeFieldUpdateManyFieldMetaTypeSignature + + 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")] = 12 + + +EnvelopeFieldUpdateManyFieldMetaUnionTypedDict = TypeAliasType( + "EnvelopeFieldUpdateManyFieldMetaUnionTypedDict", + Union[ + EnvelopeFieldUpdateManyFieldMetaSignatureResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaInitialsResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaNameResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaEmailResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaDateResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaRadioResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaDropdownResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaCheckboxResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaTextResponseTypedDict, + EnvelopeFieldUpdateManyFieldMetaNumberResponseTypedDict, + ], +) + + +EnvelopeFieldUpdateManyFieldMetaUnion = TypeAliasType( + "EnvelopeFieldUpdateManyFieldMetaUnion", + Union[ + EnvelopeFieldUpdateManyFieldMetaSignatureResponse, + EnvelopeFieldUpdateManyFieldMetaInitialsResponse, + EnvelopeFieldUpdateManyFieldMetaNameResponse, + EnvelopeFieldUpdateManyFieldMetaEmailResponse, + EnvelopeFieldUpdateManyFieldMetaDateResponse, + EnvelopeFieldUpdateManyFieldMetaRadioResponse, + EnvelopeFieldUpdateManyFieldMetaDropdownResponse, + EnvelopeFieldUpdateManyFieldMetaCheckboxResponse, + EnvelopeFieldUpdateManyFieldMetaTextResponse, + EnvelopeFieldUpdateManyFieldMetaNumberResponse, + ], +) + + +class EnvelopeFieldUpdateManyDataResponseTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str + type: EnvelopeFieldUpdateManyTypeResponse + id: float + secondary_id: str + recipient_id: float + page: float + position_x: Any + position_y: Any + width: Any + height: Any + custom_text: str + inserted: bool + field_meta: Nullable[EnvelopeFieldUpdateManyFieldMetaUnionTypedDict] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] + + +class EnvelopeFieldUpdateManyDataResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + type: EnvelopeFieldUpdateManyTypeResponse + + id: float + + secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any + + custom_text: Annotated[str, pydantic.Field(alias="customText")] + + inserted: bool + + field_meta: Annotated[ + Nullable[EnvelopeFieldUpdateManyFieldMetaUnion], + pydantic.Field(alias="fieldMeta"), + ] + + 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 = ["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 EnvelopeFieldUpdateManyResponseTypedDict(TypedDict): + r"""Successful response""" + + data: List[EnvelopeFieldUpdateManyDataResponseTypedDict] + + +class EnvelopeFieldUpdateManyResponse(BaseModel): + r"""Successful response""" + + data: List[EnvelopeFieldUpdateManyDataResponse] diff --git a/src/documenso_sdk/models/envelope_getop.py b/src/documenso_sdk/models/envelope_getop.py new file mode 100644 index 0000000..0619a21 --- /dev/null +++ b/src/documenso_sdk/models/envelope_getop.py @@ -0,0 +1,1474 @@ +"""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 documenso_sdk.utils import FieldMetadata, PathParamMetadata +from enum import Enum +import httpx +import pydantic +from pydantic import model_serializer +from typing import Any, Dict, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict + + +class EnvelopeGetRequestTypedDict(TypedDict): + envelope_id: str + + +class EnvelopeGetRequest(BaseModel): + envelope_id: Annotated[ + str, + pydantic.Field(alias="envelopeId"), + FieldMetadata(path=PathParamMetadata(style="simple", explode=False)), + ] + + +class EnvelopeGetInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeGetInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeGetInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeGetInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeGetInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeGetInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeGetInternalServerErrorData, + 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 EnvelopeGetNotFoundIssueTypedDict(TypedDict): + message: str + + +class EnvelopeGetNotFoundIssue(BaseModel): + message: str + + +class EnvelopeGetNotFoundErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeGetNotFoundIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeGetNotFoundError(DocumensoError): + r"""Not found""" + + data: EnvelopeGetNotFoundErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeGetNotFoundErrorData, + 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 EnvelopeGetForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeGetForbiddenIssue(BaseModel): + message: str + + +class EnvelopeGetForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeGetForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeGetForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeGetForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeGetForbiddenErrorData, + 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 EnvelopeGetUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeGetUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeGetUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeGetUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeGetUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeGetUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeGetUnauthorizedErrorData, + 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 EnvelopeGetBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeGetBadRequestIssue(BaseModel): + message: str + + +class EnvelopeGetBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeGetBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeGetBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeGetBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeGetBadRequestErrorData, + 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 EnvelopeGetType(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + + +class EnvelopeGetStatus(str, Enum): + DRAFT = "DRAFT" + PENDING = "PENDING" + COMPLETED = "COMPLETED" + REJECTED = "REJECTED" + + +class EnvelopeGetSource(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" + + +class EnvelopeGetVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class EnvelopeGetTemplateType(str, Enum): + PUBLIC = "PUBLIC" + PRIVATE = "PRIVATE" + + +class EnvelopeGetGlobalAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeGetGlobalActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class EnvelopeGetAuthOptionsTypedDict(TypedDict): + global_access_auth: List[EnvelopeGetGlobalAccessAuth] + global_action_auth: List[EnvelopeGetGlobalActionAuth] + + +class EnvelopeGetAuthOptions(BaseModel): + global_access_auth: Annotated[ + List[EnvelopeGetGlobalAccessAuth], pydantic.Field(alias="globalAccessAuth") + ] + + global_action_auth: Annotated[ + List[EnvelopeGetGlobalActionAuth], pydantic.Field(alias="globalActionAuth") + ] + + +EnvelopeGetFormValuesTypedDict = TypeAliasType( + "EnvelopeGetFormValuesTypedDict", Union[str, bool, float] +) + + +EnvelopeGetFormValues = TypeAliasType("EnvelopeGetFormValues", Union[str, bool, float]) + + +class EnvelopeGetSigningOrder(str, Enum): + PARALLEL = "PARALLEL" + SEQUENTIAL = "SEQUENTIAL" + + +class EnvelopeGetDistributionMethod(str, Enum): + EMAIL = "EMAIL" + NONE = "NONE" + + +class EnvelopeGetEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class EnvelopeGetEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class EnvelopeGetDocumentMetaTypedDict(TypedDict): + signing_order: EnvelopeGetSigningOrder + distribution_method: EnvelopeGetDistributionMethod + id: str + subject: Nullable[str] + message: Nullable[str] + timezone: Nullable[str] + date_format: Nullable[str] + 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[EnvelopeGetEmailSettingsTypedDict] + email_id: Nullable[str] + email_reply_to: Nullable[str] + + +class EnvelopeGetDocumentMeta(BaseModel): + signing_order: Annotated[ + EnvelopeGetSigningOrder, pydantic.Field(alias="signingOrder") + ] + + distribution_method: Annotated[ + EnvelopeGetDistributionMethod, pydantic.Field(alias="distributionMethod") + ] + + id: str + + subject: Nullable[str] + + message: Nullable[str] + + timezone: Nullable[str] + + date_format: Annotated[Nullable[str], pydantic.Field(alias="dateFormat")] + + redirect_url: Annotated[Nullable[str], pydantic.Field(alias="redirectUrl")] + + 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") + ] + + language: str + + email_settings: Annotated[ + Nullable[EnvelopeGetEmailSettings], pydantic.Field(alias="emailSettings") + ] + + email_id: Annotated[Nullable[str], pydantic.Field(alias="emailId")] + + email_reply_to: Annotated[Nullable[str], pydantic.Field(alias="emailReplyTo")] + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = [ + "subject", + "message", + "timezone", + "dateFormat", + "redirectUrl", + "emailSettings", + "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 EnvelopeGetRole(str, Enum): + CC = "CC" + SIGNER = "SIGNER" + VIEWER = "VIEWER" + APPROVER = "APPROVER" + ASSISTANT = "ASSISTANT" + + +class EnvelopeGetReadStatus(str, Enum): + NOT_OPENED = "NOT_OPENED" + OPENED = "OPENED" + + +class EnvelopeGetSigningStatus(str, Enum): + NOT_SIGNED = "NOT_SIGNED" + SIGNED = "SIGNED" + REJECTED = "REJECTED" + + +class EnvelopeGetSendStatus(str, Enum): + NOT_SENT = "NOT_SENT" + SENT = "SENT" + + +class EnvelopeGetAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeGetActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + EXPLICIT_NONE = "EXPLICIT_NONE" + + +class EnvelopeGetRecipientAuthOptionsTypedDict(TypedDict): + access_auth: List[EnvelopeGetAccessAuth] + action_auth: List[EnvelopeGetActionAuth] + + +class EnvelopeGetRecipientAuthOptions(BaseModel): + access_auth: Annotated[ + List[EnvelopeGetAccessAuth], pydantic.Field(alias="accessAuth") + ] + + action_auth: Annotated[ + List[EnvelopeGetActionAuth], pydantic.Field(alias="actionAuth") + ] + + +class EnvelopeGetRecipientTypedDict(TypedDict): + envelope_id: str + role: EnvelopeGetRole + read_status: EnvelopeGetReadStatus + signing_status: EnvelopeGetSigningStatus + send_status: EnvelopeGetSendStatus + id: float + email: str + name: str + token: str + document_deleted_at: Nullable[str] + expired: Nullable[str] + signed_at: Nullable[str] + auth_options: Nullable[EnvelopeGetRecipientAuthOptionsTypedDict] + signing_order: Nullable[float] + rejection_reason: Nullable[str] + + +class EnvelopeGetRecipient(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + role: EnvelopeGetRole + + read_status: Annotated[EnvelopeGetReadStatus, pydantic.Field(alias="readStatus")] + + signing_status: Annotated[ + EnvelopeGetSigningStatus, pydantic.Field(alias="signingStatus") + ] + + send_status: Annotated[EnvelopeGetSendStatus, 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[EnvelopeGetRecipientAuthOptions], pydantic.Field(alias="authOptions") + ] + + signing_order: Annotated[Nullable[float], pydantic.Field(alias="signingOrder")] + + rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = [ + "documentDeletedAt", + "expired", + "signedAt", + "authOptions", + "signingOrder", + "rejectionReason", + ] + 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 EnvelopeGetFieldType(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 EnvelopeGetTypeDropdown(str, Enum): + DROPDOWN = "dropdown" + + +class EnvelopeGetValue3TypedDict(TypedDict): + value: str + + +class EnvelopeGetValue3(BaseModel): + value: str + + +class EnvelopeGetFieldMetaDropdownTypedDict(TypedDict): + type: EnvelopeGetTypeDropdown + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeGetValue3TypedDict]] + default_value: NotRequired[str] + + +class EnvelopeGetFieldMetaDropdown(BaseModel): + type: EnvelopeGetTypeDropdown + + 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")] = 12 + + values: Optional[List[EnvelopeGetValue3]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +class EnvelopeGetTypeCheckbox(str, Enum): + CHECKBOX = "checkbox" + + +class EnvelopeGetValue2TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeGetValue2(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeGetDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeGetFieldMetaCheckboxTypedDict(TypedDict): + type: EnvelopeGetTypeCheckbox + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeGetValue2TypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[EnvelopeGetDirection2] + + +class EnvelopeGetFieldMetaCheckbox(BaseModel): + type: EnvelopeGetTypeCheckbox + + 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")] = 12 + + values: Optional[List[EnvelopeGetValue2]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[EnvelopeGetDirection2] = EnvelopeGetDirection2.VERTICAL + + +class EnvelopeGetTypeRadio(str, Enum): + RADIO = "radio" + + +class EnvelopeGetValue1TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeGetValue1(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeGetDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeGetFieldMetaRadioTypedDict(TypedDict): + type: EnvelopeGetTypeRadio + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeGetValue1TypedDict]] + direction: NotRequired[EnvelopeGetDirection1] + + +class EnvelopeGetFieldMetaRadio(BaseModel): + type: EnvelopeGetTypeRadio + + 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")] = 12 + + values: Optional[List[EnvelopeGetValue1]] = None + + direction: Optional[EnvelopeGetDirection1] = EnvelopeGetDirection1.VERTICAL + + +class EnvelopeGetTypeNumber(str, Enum): + NUMBER = "number" + + +class EnvelopeGetTextAlign6(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeGetVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeGetFieldMetaNumberTypedDict(TypedDict): + type: EnvelopeGetTypeNumber + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[EnvelopeGetTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeGetVerticalAlign2]] + + +class EnvelopeGetFieldMetaNumber(BaseModel): + type: EnvelopeGetTypeNumber + + 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")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[EnvelopeGetTextAlign6], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeGetVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 EnvelopeGetTypeText(str, Enum): + TEXT = "text" + + +class EnvelopeGetTextAlign5(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeGetVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeGetFieldMetaTextTypedDict(TypedDict): + type: EnvelopeGetTypeText + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[EnvelopeGetTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeGetVerticalAlign1]] + + +class EnvelopeGetFieldMetaText(BaseModel): + type: EnvelopeGetTypeText + + 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")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[EnvelopeGetTextAlign5], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeGetVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 EnvelopeGetTypeDate(str, Enum): + DATE = "date" + + +class EnvelopeGetTextAlign4(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeGetFieldMetaDateTypedDict(TypedDict): + type: EnvelopeGetTypeDate + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeGetTextAlign4] + + +class EnvelopeGetFieldMetaDate(BaseModel): + type: EnvelopeGetTypeDate + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeGetTextAlign4], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeGetTypeEmail(str, Enum): + EMAIL = "email" + + +class EnvelopeGetTextAlign3(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeGetFieldMetaEmailTypedDict(TypedDict): + type: EnvelopeGetTypeEmail + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeGetTextAlign3] + + +class EnvelopeGetFieldMetaEmail(BaseModel): + type: EnvelopeGetTypeEmail + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeGetTextAlign3], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeGetTypeName(str, Enum): + NAME = "name" + + +class EnvelopeGetTextAlign2(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeGetFieldMetaNameTypedDict(TypedDict): + type: EnvelopeGetTypeName + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeGetTextAlign2] + + +class EnvelopeGetFieldMetaName(BaseModel): + type: EnvelopeGetTypeName + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeGetTextAlign2], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeGetTypeInitials(str, Enum): + INITIALS = "initials" + + +class EnvelopeGetTextAlign1(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeGetFieldMetaInitialsTypedDict(TypedDict): + type: EnvelopeGetTypeInitials + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeGetTextAlign1] + + +class EnvelopeGetFieldMetaInitials(BaseModel): + type: EnvelopeGetTypeInitials + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeGetTextAlign1], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeGetTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class EnvelopeGetFieldMetaSignatureTypedDict(TypedDict): + type: EnvelopeGetTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class EnvelopeGetFieldMetaSignature(BaseModel): + type: EnvelopeGetTypeSignature + + 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")] = 12 + + +EnvelopeGetFieldMetaUnionTypedDict = TypeAliasType( + "EnvelopeGetFieldMetaUnionTypedDict", + Union[ + EnvelopeGetFieldMetaSignatureTypedDict, + EnvelopeGetFieldMetaInitialsTypedDict, + EnvelopeGetFieldMetaNameTypedDict, + EnvelopeGetFieldMetaEmailTypedDict, + EnvelopeGetFieldMetaDateTypedDict, + EnvelopeGetFieldMetaRadioTypedDict, + EnvelopeGetFieldMetaDropdownTypedDict, + EnvelopeGetFieldMetaCheckboxTypedDict, + EnvelopeGetFieldMetaTextTypedDict, + EnvelopeGetFieldMetaNumberTypedDict, + ], +) + + +EnvelopeGetFieldMetaUnion = TypeAliasType( + "EnvelopeGetFieldMetaUnion", + Union[ + EnvelopeGetFieldMetaSignature, + EnvelopeGetFieldMetaInitials, + EnvelopeGetFieldMetaName, + EnvelopeGetFieldMetaEmail, + EnvelopeGetFieldMetaDate, + EnvelopeGetFieldMetaRadio, + EnvelopeGetFieldMetaDropdown, + EnvelopeGetFieldMetaCheckbox, + EnvelopeGetFieldMetaText, + EnvelopeGetFieldMetaNumber, + ], +) + + +class EnvelopeGetFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str + type: EnvelopeGetFieldType + id: float + secondary_id: str + recipient_id: float + page: float + position_x: Any + position_y: Any + width: Any + height: Any + custom_text: str + inserted: bool + field_meta: Nullable[EnvelopeGetFieldMetaUnionTypedDict] + + +class EnvelopeGetField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + type: EnvelopeGetFieldType + + id: float + + secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any + + custom_text: Annotated[str, pydantic.Field(alias="customText")] + + inserted: bool + + field_meta: Annotated[ + Nullable[EnvelopeGetFieldMetaUnion], pydantic.Field(alias="fieldMeta") + ] + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = ["fieldMeta"] + 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 EnvelopeGetEnvelopeItemTypedDict(TypedDict): + envelope_id: str + id: str + title: str + order: float + + +class EnvelopeGetEnvelopeItem(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + id: str + + title: str + + order: float + + +class EnvelopeGetDirectLinkTypedDict(TypedDict): + direct_template_recipient_id: float + enabled: bool + id: str + token: str + + +class EnvelopeGetDirectLink(BaseModel): + direct_template_recipient_id: Annotated[ + float, pydantic.Field(alias="directTemplateRecipientId") + ] + + enabled: bool + + id: str + + token: str + + +class EnvelopeGetTeamTypedDict(TypedDict): + id: float + url: str + + +class EnvelopeGetTeam(BaseModel): + id: float + + url: str + + +class EnvelopeGetUserTypedDict(TypedDict): + id: float + name: str + email: str + + +class EnvelopeGetUser(BaseModel): + id: float + + name: str + + email: str + + +class EnvelopeGetResponseTypedDict(TypedDict): + r"""Successful response""" + + internal_version: float + type: EnvelopeGetType + status: EnvelopeGetStatus + source: EnvelopeGetSource + visibility: EnvelopeGetVisibility + template_type: EnvelopeGetTemplateType + id: str + secondary_id: str + external_id: Nullable[str] + created_at: str + updated_at: str + completed_at: Nullable[str] + deleted_at: Nullable[str] + title: str + auth_options: Nullable[EnvelopeGetAuthOptionsTypedDict] + form_values: Nullable[Dict[str, EnvelopeGetFormValuesTypedDict]] + public_title: str + public_description: str + user_id: float + team_id: float + folder_id: Nullable[str] + template_id: Nullable[float] + document_meta: EnvelopeGetDocumentMetaTypedDict + recipients: List[EnvelopeGetRecipientTypedDict] + fields: List[EnvelopeGetFieldTypedDict] + envelope_items: List[EnvelopeGetEnvelopeItemTypedDict] + direct_link: Nullable[EnvelopeGetDirectLinkTypedDict] + team: EnvelopeGetTeamTypedDict + user: EnvelopeGetUserTypedDict + + +class EnvelopeGetResponse(BaseModel): + r"""Successful response""" + + internal_version: Annotated[float, pydantic.Field(alias="internalVersion")] + + type: EnvelopeGetType + + status: EnvelopeGetStatus + + source: EnvelopeGetSource + + visibility: EnvelopeGetVisibility + + template_type: Annotated[ + EnvelopeGetTemplateType, pydantic.Field(alias="templateType") + ] + + id: str + + secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] + + external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] + + completed_at: Annotated[Nullable[str], pydantic.Field(alias="completedAt")] + + deleted_at: Annotated[Nullable[str], pydantic.Field(alias="deletedAt")] + + title: str + + auth_options: Annotated[ + Nullable[EnvelopeGetAuthOptions], pydantic.Field(alias="authOptions") + ] + + form_values: Annotated[ + Nullable[Dict[str, EnvelopeGetFormValues]], pydantic.Field(alias="formValues") + ] + + public_title: Annotated[str, pydantic.Field(alias="publicTitle")] + + public_description: Annotated[str, pydantic.Field(alias="publicDescription")] + + user_id: Annotated[float, pydantic.Field(alias="userId")] + + team_id: Annotated[float, pydantic.Field(alias="teamId")] + + folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] + + template_id: Annotated[Nullable[float], pydantic.Field(alias="templateId")] + + document_meta: Annotated[ + EnvelopeGetDocumentMeta, pydantic.Field(alias="documentMeta") + ] + + recipients: List[EnvelopeGetRecipient] + + fields: List[EnvelopeGetField] + + envelope_items: Annotated[ + List[EnvelopeGetEnvelopeItem], pydantic.Field(alias="envelopeItems") + ] + + direct_link: Annotated[ + Nullable[EnvelopeGetDirectLink], pydantic.Field(alias="directLink") + ] + + team: EnvelopeGetTeam + + user: EnvelopeGetUser + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = [ + "externalId", + "completedAt", + "deletedAt", + "authOptions", + "formValues", + "folderId", + "templateId", + "directLink", + ] + 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 diff --git a/src/documenso_sdk/models/envelope_item_createmanyop.py b/src/documenso_sdk/models/envelope_item_createmanyop.py new file mode 100644 index 0000000..0c55aa5 --- /dev/null +++ b/src/documenso_sdk/models/envelope_item_createmanyop.py @@ -0,0 +1,226 @@ +"""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, MultipartFormMetadata +import httpx +import io +import pydantic +from typing import IO, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypedDict + + +class EnvelopeItemCreateManyPayloadTypedDict(TypedDict): + envelope_id: str + + +class EnvelopeItemCreateManyPayload(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + +class EnvelopeItemCreateManyFileTypedDict(TypedDict): + file_name: str + content: Union[bytes, IO[bytes], io.BufferedReader] + content_type: NotRequired[str] + + +class EnvelopeItemCreateManyFile(BaseModel): + file_name: Annotated[ + str, pydantic.Field(alias="fileName"), FieldMetadata(multipart=True) + ] + + content: Annotated[ + Union[bytes, IO[bytes], io.BufferedReader], + pydantic.Field(alias=""), + FieldMetadata(multipart=MultipartFormMetadata(content=True)), + ] + + content_type: Annotated[ + Optional[str], + pydantic.Field(alias="Content-Type"), + FieldMetadata(multipart=True), + ] = None + + +class EnvelopeItemCreateManyRequestTypedDict(TypedDict): + payload: EnvelopeItemCreateManyPayloadTypedDict + files: NotRequired[List[EnvelopeItemCreateManyFileTypedDict]] + + +class EnvelopeItemCreateManyRequest(BaseModel): + payload: Annotated[ + EnvelopeItemCreateManyPayload, + FieldMetadata(multipart=MultipartFormMetadata(json=True)), + ] + + files: Annotated[ + Optional[List[EnvelopeItemCreateManyFile]], + FieldMetadata(multipart=MultipartFormMetadata(file=True)), + ] = None + + +class EnvelopeItemCreateManyInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemCreateManyInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeItemCreateManyInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemCreateManyInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemCreateManyInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeItemCreateManyInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemCreateManyInternalServerErrorData, + 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 EnvelopeItemCreateManyForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemCreateManyForbiddenIssue(BaseModel): + message: str + + +class EnvelopeItemCreateManyForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemCreateManyForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemCreateManyForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeItemCreateManyForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemCreateManyForbiddenErrorData, + 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 EnvelopeItemCreateManyUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemCreateManyUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeItemCreateManyUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemCreateManyUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemCreateManyUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeItemCreateManyUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemCreateManyUnauthorizedErrorData, + 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 EnvelopeItemCreateManyBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemCreateManyBadRequestIssue(BaseModel): + message: str + + +class EnvelopeItemCreateManyBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemCreateManyBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemCreateManyBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeItemCreateManyBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemCreateManyBadRequestErrorData, + 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 EnvelopeItemCreateManyDataTypedDict(TypedDict): + id: str + title: str + envelope_id: str + order: float + + +class EnvelopeItemCreateManyData(BaseModel): + id: str + + title: str + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + order: float + + +class EnvelopeItemCreateManyResponseTypedDict(TypedDict): + r"""Successful response""" + + data: List[EnvelopeItemCreateManyDataTypedDict] + + +class EnvelopeItemCreateManyResponse(BaseModel): + r"""Successful response""" + + data: List[EnvelopeItemCreateManyData] diff --git a/src/documenso_sdk/models/envelope_item_deleteop.py b/src/documenso_sdk/models/envelope_item_deleteop.py new file mode 100644 index 0000000..858e2ce --- /dev/null +++ b/src/documenso_sdk/models/envelope_item_deleteop.py @@ -0,0 +1,169 @@ +"""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 EnvelopeItemDeleteRequestTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str + + +class EnvelopeItemDeleteRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + +class EnvelopeItemDeleteInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemDeleteInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeItemDeleteInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemDeleteInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemDeleteInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeItemDeleteInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemDeleteInternalServerErrorData, + 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 EnvelopeItemDeleteForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemDeleteForbiddenIssue(BaseModel): + message: str + + +class EnvelopeItemDeleteForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemDeleteForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemDeleteForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeItemDeleteForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemDeleteForbiddenErrorData, + 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 EnvelopeItemDeleteUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemDeleteUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeItemDeleteUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemDeleteUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemDeleteUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeItemDeleteUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemDeleteUnauthorizedErrorData, + 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 EnvelopeItemDeleteBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemDeleteBadRequestIssue(BaseModel): + message: str + + +class EnvelopeItemDeleteBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemDeleteBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemDeleteBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeItemDeleteBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemDeleteBadRequestErrorData, + 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 EnvelopeItemDeleteResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class EnvelopeItemDeleteResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/envelope_item_downloadop.py b/src/documenso_sdk/models/envelope_item_downloadop.py new file mode 100644 index 0000000..cb7d700 --- /dev/null +++ b/src/documenso_sdk/models/envelope_item_downloadop.py @@ -0,0 +1,222 @@ +"""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 Any, Dict, List, Optional +from typing_extensions import Annotated, NotRequired, TypedDict + + +class EnvelopeItemDownloadVersion(str, Enum): + r"""The version of the envelope item to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.""" + + ORIGINAL = "original" + SIGNED = "signed" + + +class EnvelopeItemDownloadRequestTypedDict(TypedDict): + envelope_item_id: str + r"""The ID of the envelope item to download.""" + version: NotRequired[EnvelopeItemDownloadVersion] + r"""The version of the envelope item to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.""" + + +class EnvelopeItemDownloadRequest(BaseModel): + envelope_item_id: Annotated[ + str, + pydantic.Field(alias="envelopeItemId"), + FieldMetadata(path=PathParamMetadata(style="simple", explode=False)), + ] + r"""The ID of the envelope item to download.""" + + version: Annotated[ + Optional[EnvelopeItemDownloadVersion], + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = EnvelopeItemDownloadVersion.SIGNED + r"""The version of the envelope item to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.""" + + +class EnvelopeItemDownloadInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemDownloadInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeItemDownloadInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemDownloadInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemDownloadInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeItemDownloadInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemDownloadInternalServerErrorData, + 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 EnvelopeItemDownloadNotFoundIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemDownloadNotFoundIssue(BaseModel): + message: str + + +class EnvelopeItemDownloadNotFoundErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemDownloadNotFoundIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemDownloadNotFoundError(DocumensoError): + r"""Not found""" + + data: EnvelopeItemDownloadNotFoundErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemDownloadNotFoundErrorData, + 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 EnvelopeItemDownloadForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemDownloadForbiddenIssue(BaseModel): + message: str + + +class EnvelopeItemDownloadForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemDownloadForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemDownloadForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeItemDownloadForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemDownloadForbiddenErrorData, + 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 EnvelopeItemDownloadUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemDownloadUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeItemDownloadUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemDownloadUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemDownloadUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeItemDownloadUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemDownloadUnauthorizedErrorData, + 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 EnvelopeItemDownloadBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemDownloadBadRequestIssue(BaseModel): + message: str + + +class EnvelopeItemDownloadBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemDownloadBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemDownloadBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeItemDownloadBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemDownloadBadRequestErrorData, + 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 EnvelopeItemDownloadResponseTypedDict(TypedDict): + headers: Dict[str, List[str]] + result: Any + + +class EnvelopeItemDownloadResponse(BaseModel): + headers: Dict[str, List[str]] + + result: Any diff --git a/src/documenso_sdk/models/envelope_item_updatemanyop.py b/src/documenso_sdk/models/envelope_item_updatemanyop.py new file mode 100644 index 0000000..40efd92 --- /dev/null +++ b/src/documenso_sdk/models/envelope_item_updatemanyop.py @@ -0,0 +1,200 @@ +"""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, NotRequired, TypedDict + + +class EnvelopeItemUpdateManyDataRequestTypedDict(TypedDict): + envelope_item_id: str + order: NotRequired[int] + title: NotRequired[str] + + +class EnvelopeItemUpdateManyDataRequest(BaseModel): + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + order: Optional[int] = None + + title: Optional[str] = None + + +class EnvelopeItemUpdateManyRequestTypedDict(TypedDict): + envelope_id: str + data: List[EnvelopeItemUpdateManyDataRequestTypedDict] + + +class EnvelopeItemUpdateManyRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + data: List[EnvelopeItemUpdateManyDataRequest] + + +class EnvelopeItemUpdateManyInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemUpdateManyInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeItemUpdateManyInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemUpdateManyInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemUpdateManyInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeItemUpdateManyInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemUpdateManyInternalServerErrorData, + 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 EnvelopeItemUpdateManyForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemUpdateManyForbiddenIssue(BaseModel): + message: str + + +class EnvelopeItemUpdateManyForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemUpdateManyForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemUpdateManyForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeItemUpdateManyForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemUpdateManyForbiddenErrorData, + 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 EnvelopeItemUpdateManyUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemUpdateManyUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeItemUpdateManyUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemUpdateManyUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemUpdateManyUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeItemUpdateManyUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemUpdateManyUnauthorizedErrorData, + 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 EnvelopeItemUpdateManyBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeItemUpdateManyBadRequestIssue(BaseModel): + message: str + + +class EnvelopeItemUpdateManyBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeItemUpdateManyBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeItemUpdateManyBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeItemUpdateManyBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeItemUpdateManyBadRequestErrorData, + 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 EnvelopeItemUpdateManyDataResponseTypedDict(TypedDict): + id: str + order: float + title: str + envelope_id: str + + +class EnvelopeItemUpdateManyDataResponse(BaseModel): + id: str + + order: float + + title: str + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + +class EnvelopeItemUpdateManyResponseTypedDict(TypedDict): + r"""Successful response""" + + data: List[EnvelopeItemUpdateManyDataResponseTypedDict] + + +class EnvelopeItemUpdateManyResponse(BaseModel): + r"""Successful response""" + + data: List[EnvelopeItemUpdateManyDataResponse] diff --git a/src/documenso_sdk/models/envelope_recipient_createmanyop.py b/src/documenso_sdk/models/envelope_recipient_createmanyop.py new file mode 100644 index 0000000..0cf940c --- /dev/null +++ b/src/documenso_sdk/models/envelope_recipient_createmanyop.py @@ -0,0 +1,375 @@ +"""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 +import httpx +import pydantic +from pydantic import model_serializer +from typing import List, Optional +from typing_extensions import Annotated, NotRequired, TypedDict + + +class EnvelopeRecipientCreateManyRoleRequest(str, Enum): + CC = "CC" + SIGNER = "SIGNER" + VIEWER = "VIEWER" + APPROVER = "APPROVER" + ASSISTANT = "ASSISTANT" + + +class EnvelopeRecipientCreateManyAccessAuthRequest(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeRecipientCreateManyActionAuthRequest(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + EXPLICIT_NONE = "EXPLICIT_NONE" + + +class EnvelopeRecipientCreateManyDataRequestTypedDict(TypedDict): + email: str + name: str + role: EnvelopeRecipientCreateManyRoleRequest + signing_order: NotRequired[float] + access_auth: NotRequired[List[EnvelopeRecipientCreateManyAccessAuthRequest]] + action_auth: NotRequired[List[EnvelopeRecipientCreateManyActionAuthRequest]] + + +class EnvelopeRecipientCreateManyDataRequest(BaseModel): + email: str + + name: str + + role: EnvelopeRecipientCreateManyRoleRequest + + signing_order: Annotated[Optional[float], pydantic.Field(alias="signingOrder")] = ( + None + ) + + access_auth: Annotated[ + Optional[List[EnvelopeRecipientCreateManyAccessAuthRequest]], + pydantic.Field(alias="accessAuth"), + ] = None + + action_auth: Annotated[ + Optional[List[EnvelopeRecipientCreateManyActionAuthRequest]], + pydantic.Field(alias="actionAuth"), + ] = None + + +class EnvelopeRecipientCreateManyRequestTypedDict(TypedDict): + envelope_id: str + data: List[EnvelopeRecipientCreateManyDataRequestTypedDict] + + +class EnvelopeRecipientCreateManyRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + data: List[EnvelopeRecipientCreateManyDataRequest] + + +class EnvelopeRecipientCreateManyInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientCreateManyInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeRecipientCreateManyInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientCreateManyInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientCreateManyInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeRecipientCreateManyInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientCreateManyInternalServerErrorData, + 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 EnvelopeRecipientCreateManyForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientCreateManyForbiddenIssue(BaseModel): + message: str + + +class EnvelopeRecipientCreateManyForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientCreateManyForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientCreateManyForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeRecipientCreateManyForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientCreateManyForbiddenErrorData, + 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 EnvelopeRecipientCreateManyUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientCreateManyUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeRecipientCreateManyUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientCreateManyUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientCreateManyUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeRecipientCreateManyUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientCreateManyUnauthorizedErrorData, + 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 EnvelopeRecipientCreateManyBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientCreateManyBadRequestIssue(BaseModel): + message: str + + +class EnvelopeRecipientCreateManyBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientCreateManyBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientCreateManyBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeRecipientCreateManyBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientCreateManyBadRequestErrorData, + 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 EnvelopeRecipientCreateManyRoleResponse(str, Enum): + CC = "CC" + SIGNER = "SIGNER" + VIEWER = "VIEWER" + APPROVER = "APPROVER" + ASSISTANT = "ASSISTANT" + + +class EnvelopeRecipientCreateManyReadStatus(str, Enum): + NOT_OPENED = "NOT_OPENED" + OPENED = "OPENED" + + +class EnvelopeRecipientCreateManySigningStatus(str, Enum): + NOT_SIGNED = "NOT_SIGNED" + SIGNED = "SIGNED" + REJECTED = "REJECTED" + + +class EnvelopeRecipientCreateManySendStatus(str, Enum): + NOT_SENT = "NOT_SENT" + SENT = "SENT" + + +class EnvelopeRecipientCreateManyAccessAuthResponse(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeRecipientCreateManyActionAuthResponse(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + EXPLICIT_NONE = "EXPLICIT_NONE" + + +class EnvelopeRecipientCreateManyAuthOptionsTypedDict(TypedDict): + access_auth: List[EnvelopeRecipientCreateManyAccessAuthResponse] + action_auth: List[EnvelopeRecipientCreateManyActionAuthResponse] + + +class EnvelopeRecipientCreateManyAuthOptions(BaseModel): + access_auth: Annotated[ + List[EnvelopeRecipientCreateManyAccessAuthResponse], + pydantic.Field(alias="accessAuth"), + ] + + action_auth: Annotated[ + List[EnvelopeRecipientCreateManyActionAuthResponse], + pydantic.Field(alias="actionAuth"), + ] + + +class EnvelopeRecipientCreateManyDataResponseTypedDict(TypedDict): + envelope_id: str + role: EnvelopeRecipientCreateManyRoleResponse + read_status: EnvelopeRecipientCreateManyReadStatus + signing_status: EnvelopeRecipientCreateManySigningStatus + send_status: EnvelopeRecipientCreateManySendStatus + id: float + email: str + name: str + token: str + document_deleted_at: Nullable[str] + expired: Nullable[str] + signed_at: Nullable[str] + auth_options: Nullable[EnvelopeRecipientCreateManyAuthOptionsTypedDict] + signing_order: Nullable[float] + rejection_reason: Nullable[str] + + +class EnvelopeRecipientCreateManyDataResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + role: EnvelopeRecipientCreateManyRoleResponse + + read_status: Annotated[ + EnvelopeRecipientCreateManyReadStatus, pydantic.Field(alias="readStatus") + ] + + signing_status: Annotated[ + EnvelopeRecipientCreateManySigningStatus, pydantic.Field(alias="signingStatus") + ] + + send_status: Annotated[ + EnvelopeRecipientCreateManySendStatus, 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[EnvelopeRecipientCreateManyAuthOptions], + pydantic.Field(alias="authOptions"), + ] + + signing_order: Annotated[Nullable[float], pydantic.Field(alias="signingOrder")] + + rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = [ + "documentDeletedAt", + "expired", + "signedAt", + "authOptions", + "signingOrder", + "rejectionReason", + ] + 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 EnvelopeRecipientCreateManyResponseTypedDict(TypedDict): + r"""Successful response""" + + data: List[EnvelopeRecipientCreateManyDataResponseTypedDict] + + +class EnvelopeRecipientCreateManyResponse(BaseModel): + r"""Successful response""" + + data: List[EnvelopeRecipientCreateManyDataResponse] diff --git a/src/documenso_sdk/models/envelope_recipient_deleteop.py b/src/documenso_sdk/models/envelope_recipient_deleteop.py new file mode 100644 index 0000000..ecffe6d --- /dev/null +++ b/src/documenso_sdk/models/envelope_recipient_deleteop.py @@ -0,0 +1,166 @@ +"""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 EnvelopeRecipientDeleteRequestTypedDict(TypedDict): + recipient_id: float + + +class EnvelopeRecipientDeleteRequest(BaseModel): + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + +class EnvelopeRecipientDeleteInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientDeleteInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeRecipientDeleteInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientDeleteInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientDeleteInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeRecipientDeleteInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientDeleteInternalServerErrorData, + 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 EnvelopeRecipientDeleteForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientDeleteForbiddenIssue(BaseModel): + message: str + + +class EnvelopeRecipientDeleteForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientDeleteForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientDeleteForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeRecipientDeleteForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientDeleteForbiddenErrorData, + 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 EnvelopeRecipientDeleteUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientDeleteUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeRecipientDeleteUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientDeleteUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientDeleteUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeRecipientDeleteUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientDeleteUnauthorizedErrorData, + 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 EnvelopeRecipientDeleteBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientDeleteBadRequestIssue(BaseModel): + message: str + + +class EnvelopeRecipientDeleteBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientDeleteBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientDeleteBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeRecipientDeleteBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientDeleteBadRequestErrorData, + 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 EnvelopeRecipientDeleteResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class EnvelopeRecipientDeleteResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/envelope_recipient_getop.py b/src/documenso_sdk/models/envelope_recipient_getop.py new file mode 100644 index 0000000..3a976ac --- /dev/null +++ b/src/documenso_sdk/models/envelope_recipient_getop.py @@ -0,0 +1,1071 @@ +"""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 documenso_sdk.utils import FieldMetadata, PathParamMetadata +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 EnvelopeRecipientGetRequestTypedDict(TypedDict): + recipient_id: float + + +class EnvelopeRecipientGetRequest(BaseModel): + recipient_id: Annotated[ + float, + pydantic.Field(alias="recipientId"), + FieldMetadata(path=PathParamMetadata(style="simple", explode=False)), + ] + + +class EnvelopeRecipientGetInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientGetInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeRecipientGetInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientGetInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientGetInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeRecipientGetInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientGetInternalServerErrorData, + 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 EnvelopeRecipientGetNotFoundIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientGetNotFoundIssue(BaseModel): + message: str + + +class EnvelopeRecipientGetNotFoundErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientGetNotFoundIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientGetNotFoundError(DocumensoError): + r"""Not found""" + + data: EnvelopeRecipientGetNotFoundErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientGetNotFoundErrorData, + 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 EnvelopeRecipientGetForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientGetForbiddenIssue(BaseModel): + message: str + + +class EnvelopeRecipientGetForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientGetForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientGetForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeRecipientGetForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientGetForbiddenErrorData, + 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 EnvelopeRecipientGetUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientGetUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeRecipientGetUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientGetUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientGetUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeRecipientGetUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientGetUnauthorizedErrorData, + 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 EnvelopeRecipientGetBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientGetBadRequestIssue(BaseModel): + message: str + + +class EnvelopeRecipientGetBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientGetBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientGetBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeRecipientGetBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientGetBadRequestErrorData, + 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 EnvelopeRecipientGetRole(str, Enum): + CC = "CC" + SIGNER = "SIGNER" + VIEWER = "VIEWER" + APPROVER = "APPROVER" + ASSISTANT = "ASSISTANT" + + +class EnvelopeRecipientGetReadStatus(str, Enum): + NOT_OPENED = "NOT_OPENED" + OPENED = "OPENED" + + +class EnvelopeRecipientGetSigningStatus(str, Enum): + NOT_SIGNED = "NOT_SIGNED" + SIGNED = "SIGNED" + REJECTED = "REJECTED" + + +class EnvelopeRecipientGetSendStatus(str, Enum): + NOT_SENT = "NOT_SENT" + SENT = "SENT" + + +class EnvelopeRecipientGetAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeRecipientGetActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + EXPLICIT_NONE = "EXPLICIT_NONE" + + +class EnvelopeRecipientGetAuthOptionsTypedDict(TypedDict): + access_auth: List[EnvelopeRecipientGetAccessAuth] + action_auth: List[EnvelopeRecipientGetActionAuth] + + +class EnvelopeRecipientGetAuthOptions(BaseModel): + access_auth: Annotated[ + List[EnvelopeRecipientGetAccessAuth], pydantic.Field(alias="accessAuth") + ] + + action_auth: Annotated[ + List[EnvelopeRecipientGetActionAuth], pydantic.Field(alias="actionAuth") + ] + + +class EnvelopeRecipientGetType(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 EnvelopeRecipientGetTypeDropdown(str, Enum): + DROPDOWN = "dropdown" + + +class EnvelopeRecipientGetValue3TypedDict(TypedDict): + value: str + + +class EnvelopeRecipientGetValue3(BaseModel): + value: str + + +class EnvelopeRecipientGetFieldMetaDropdownTypedDict(TypedDict): + type: EnvelopeRecipientGetTypeDropdown + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeRecipientGetValue3TypedDict]] + default_value: NotRequired[str] + + +class EnvelopeRecipientGetFieldMetaDropdown(BaseModel): + type: EnvelopeRecipientGetTypeDropdown + + 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")] = 12 + + values: Optional[List[EnvelopeRecipientGetValue3]] = None + + default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None + + +class EnvelopeRecipientGetTypeCheckbox(str, Enum): + CHECKBOX = "checkbox" + + +class EnvelopeRecipientGetValue2TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeRecipientGetValue2(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeRecipientGetDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeRecipientGetFieldMetaCheckboxTypedDict(TypedDict): + type: EnvelopeRecipientGetTypeCheckbox + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeRecipientGetValue2TypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[EnvelopeRecipientGetDirection2] + + +class EnvelopeRecipientGetFieldMetaCheckbox(BaseModel): + type: EnvelopeRecipientGetTypeCheckbox + + 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")] = 12 + + values: Optional[List[EnvelopeRecipientGetValue2]] = None + + validation_rule: Annotated[ + Optional[str], pydantic.Field(alias="validationRule") + ] = None + + validation_length: Annotated[ + Optional[float], pydantic.Field(alias="validationLength") + ] = None + + direction: Optional[EnvelopeRecipientGetDirection2] = ( + EnvelopeRecipientGetDirection2.VERTICAL + ) + + +class EnvelopeRecipientGetTypeRadio(str, Enum): + RADIO = "radio" + + +class EnvelopeRecipientGetValue1TypedDict(TypedDict): + id: float + checked: bool + value: str + + +class EnvelopeRecipientGetValue1(BaseModel): + id: float + + checked: bool + + value: str + + +class EnvelopeRecipientGetDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class EnvelopeRecipientGetFieldMetaRadioTypedDict(TypedDict): + type: EnvelopeRecipientGetTypeRadio + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[EnvelopeRecipientGetValue1TypedDict]] + direction: NotRequired[EnvelopeRecipientGetDirection1] + + +class EnvelopeRecipientGetFieldMetaRadio(BaseModel): + type: EnvelopeRecipientGetTypeRadio + + 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")] = 12 + + values: Optional[List[EnvelopeRecipientGetValue1]] = None + + direction: Optional[EnvelopeRecipientGetDirection1] = ( + EnvelopeRecipientGetDirection1.VERTICAL + ) + + +class EnvelopeRecipientGetTypeNumber(str, Enum): + NUMBER = "number" + + +class EnvelopeRecipientGetTextAlign6(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeRecipientGetVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeRecipientGetFieldMetaNumberTypedDict(TypedDict): + type: EnvelopeRecipientGetTypeNumber + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[EnvelopeRecipientGetTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeRecipientGetVerticalAlign2]] + + +class EnvelopeRecipientGetFieldMetaNumber(BaseModel): + type: EnvelopeRecipientGetTypeNumber + + 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")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[EnvelopeRecipientGetTextAlign6], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeRecipientGetVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 EnvelopeRecipientGetTypeText(str, Enum): + TEXT = "text" + + +class EnvelopeRecipientGetTextAlign5(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeRecipientGetVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class EnvelopeRecipientGetFieldMetaTextTypedDict(TypedDict): + type: EnvelopeRecipientGetTypeText + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[EnvelopeRecipientGetTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[EnvelopeRecipientGetVerticalAlign1]] + + +class EnvelopeRecipientGetFieldMetaText(BaseModel): + type: EnvelopeRecipientGetTypeText + + 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")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[EnvelopeRecipientGetTextAlign5], pydantic.Field(alias="textAlign") + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[EnvelopeRecipientGetVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 EnvelopeRecipientGetTypeDate(str, Enum): + DATE = "date" + + +class EnvelopeRecipientGetTextAlign4(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeRecipientGetFieldMetaDateTypedDict(TypedDict): + type: EnvelopeRecipientGetTypeDate + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeRecipientGetTextAlign4] + + +class EnvelopeRecipientGetFieldMetaDate(BaseModel): + type: EnvelopeRecipientGetTypeDate + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeRecipientGetTextAlign4], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeRecipientGetTypeEmail(str, Enum): + EMAIL = "email" + + +class EnvelopeRecipientGetTextAlign3(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeRecipientGetFieldMetaEmailTypedDict(TypedDict): + type: EnvelopeRecipientGetTypeEmail + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeRecipientGetTextAlign3] + + +class EnvelopeRecipientGetFieldMetaEmail(BaseModel): + type: EnvelopeRecipientGetTypeEmail + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeRecipientGetTextAlign3], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeRecipientGetTypeName(str, Enum): + NAME = "name" + + +class EnvelopeRecipientGetTextAlign2(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeRecipientGetFieldMetaNameTypedDict(TypedDict): + type: EnvelopeRecipientGetTypeName + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeRecipientGetTextAlign2] + + +class EnvelopeRecipientGetFieldMetaName(BaseModel): + type: EnvelopeRecipientGetTypeName + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeRecipientGetTextAlign2], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeRecipientGetTypeInitials(str, Enum): + INITIALS = "initials" + + +class EnvelopeRecipientGetTextAlign1(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class EnvelopeRecipientGetFieldMetaInitialsTypedDict(TypedDict): + type: EnvelopeRecipientGetTypeInitials + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text_align: NotRequired[EnvelopeRecipientGetTextAlign1] + + +class EnvelopeRecipientGetFieldMetaInitials(BaseModel): + type: EnvelopeRecipientGetTypeInitials + + 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")] = 12 + + text_align: Annotated[ + Optional[EnvelopeRecipientGetTextAlign1], pydantic.Field(alias="textAlign") + ] = None + + +class EnvelopeRecipientGetTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class EnvelopeRecipientGetFieldMetaSignatureTypedDict(TypedDict): + type: EnvelopeRecipientGetTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class EnvelopeRecipientGetFieldMetaSignature(BaseModel): + type: EnvelopeRecipientGetTypeSignature + + 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")] = 12 + + +EnvelopeRecipientGetFieldMetaUnionTypedDict = TypeAliasType( + "EnvelopeRecipientGetFieldMetaUnionTypedDict", + Union[ + EnvelopeRecipientGetFieldMetaSignatureTypedDict, + EnvelopeRecipientGetFieldMetaInitialsTypedDict, + EnvelopeRecipientGetFieldMetaNameTypedDict, + EnvelopeRecipientGetFieldMetaEmailTypedDict, + EnvelopeRecipientGetFieldMetaDateTypedDict, + EnvelopeRecipientGetFieldMetaRadioTypedDict, + EnvelopeRecipientGetFieldMetaDropdownTypedDict, + EnvelopeRecipientGetFieldMetaCheckboxTypedDict, + EnvelopeRecipientGetFieldMetaTextTypedDict, + EnvelopeRecipientGetFieldMetaNumberTypedDict, + ], +) + + +EnvelopeRecipientGetFieldMetaUnion = TypeAliasType( + "EnvelopeRecipientGetFieldMetaUnion", + Union[ + EnvelopeRecipientGetFieldMetaSignature, + EnvelopeRecipientGetFieldMetaInitials, + EnvelopeRecipientGetFieldMetaName, + EnvelopeRecipientGetFieldMetaEmail, + EnvelopeRecipientGetFieldMetaDate, + EnvelopeRecipientGetFieldMetaRadio, + EnvelopeRecipientGetFieldMetaDropdown, + EnvelopeRecipientGetFieldMetaCheckbox, + EnvelopeRecipientGetFieldMetaText, + EnvelopeRecipientGetFieldMetaNumber, + ], +) + + +class EnvelopeRecipientGetFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str + type: EnvelopeRecipientGetType + id: float + secondary_id: str + recipient_id: float + page: float + position_x: Any + position_y: Any + width: Any + height: Any + custom_text: str + inserted: bool + field_meta: Nullable[EnvelopeRecipientGetFieldMetaUnionTypedDict] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] + + +class EnvelopeRecipientGetField(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + type: EnvelopeRecipientGetType + + id: float + + secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] + + recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] + + page: float + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any + + custom_text: Annotated[str, pydantic.Field(alias="customText")] + + inserted: bool + + field_meta: Annotated[ + Nullable[EnvelopeRecipientGetFieldMetaUnion], pydantic.Field(alias="fieldMeta") + ] + + 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 = ["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 EnvelopeRecipientGetResponseTypedDict(TypedDict): + r"""Successful response""" + + envelope_id: str + role: EnvelopeRecipientGetRole + read_status: EnvelopeRecipientGetReadStatus + signing_status: EnvelopeRecipientGetSigningStatus + send_status: EnvelopeRecipientGetSendStatus + id: float + email: str + name: str + token: str + document_deleted_at: Nullable[str] + expired: Nullable[str] + signed_at: Nullable[str] + auth_options: Nullable[EnvelopeRecipientGetAuthOptionsTypedDict] + signing_order: Nullable[float] + rejection_reason: Nullable[str] + fields: List[EnvelopeRecipientGetFieldTypedDict] + + +class EnvelopeRecipientGetResponse(BaseModel): + r"""Successful response""" + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + role: EnvelopeRecipientGetRole + + read_status: Annotated[ + EnvelopeRecipientGetReadStatus, pydantic.Field(alias="readStatus") + ] + + signing_status: Annotated[ + EnvelopeRecipientGetSigningStatus, pydantic.Field(alias="signingStatus") + ] + + send_status: Annotated[ + EnvelopeRecipientGetSendStatus, 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[EnvelopeRecipientGetAuthOptions], pydantic.Field(alias="authOptions") + ] + + signing_order: Annotated[Nullable[float], pydantic.Field(alias="signingOrder")] + + rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")] + + fields: List[EnvelopeRecipientGetField] + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = [ + "documentDeletedAt", + "expired", + "signedAt", + "authOptions", + "signingOrder", + "rejectionReason", + ] + 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 diff --git a/src/documenso_sdk/models/envelope_recipient_updatemanyop.py b/src/documenso_sdk/models/envelope_recipient_updatemanyop.py new file mode 100644 index 0000000..9bdfd5d --- /dev/null +++ b/src/documenso_sdk/models/envelope_recipient_updatemanyop.py @@ -0,0 +1,396 @@ +"""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 List, Optional +from typing_extensions import Annotated, NotRequired, TypedDict + + +class EnvelopeRecipientUpdateManyRoleRequest(str, Enum): + CC = "CC" + SIGNER = "SIGNER" + VIEWER = "VIEWER" + APPROVER = "APPROVER" + ASSISTANT = "ASSISTANT" + + +class EnvelopeRecipientUpdateManyAccessAuthRequest(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeRecipientUpdateManyActionAuthRequest(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + EXPLICIT_NONE = "EXPLICIT_NONE" + + +class EnvelopeRecipientUpdateManyDataRequestTypedDict(TypedDict): + id: float + email: NotRequired[str] + name: NotRequired[str] + role: NotRequired[EnvelopeRecipientUpdateManyRoleRequest] + signing_order: NotRequired[float] + access_auth: NotRequired[List[EnvelopeRecipientUpdateManyAccessAuthRequest]] + action_auth: NotRequired[List[EnvelopeRecipientUpdateManyActionAuthRequest]] + + +class EnvelopeRecipientUpdateManyDataRequest(BaseModel): + id: float + + email: Optional[str] = None + + name: Optional[str] = None + + role: Optional[EnvelopeRecipientUpdateManyRoleRequest] = None + + signing_order: Annotated[Optional[float], pydantic.Field(alias="signingOrder")] = ( + None + ) + + access_auth: Annotated[ + Optional[List[EnvelopeRecipientUpdateManyAccessAuthRequest]], + pydantic.Field(alias="accessAuth"), + ] = None + + action_auth: Annotated[ + Optional[List[EnvelopeRecipientUpdateManyActionAuthRequest]], + pydantic.Field(alias="actionAuth"), + ] = None + + +class EnvelopeRecipientUpdateManyRequestTypedDict(TypedDict): + envelope_id: str + data: List[EnvelopeRecipientUpdateManyDataRequestTypedDict] + + +class EnvelopeRecipientUpdateManyRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + data: List[EnvelopeRecipientUpdateManyDataRequest] + + +class EnvelopeRecipientUpdateManyInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientUpdateManyInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeRecipientUpdateManyInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientUpdateManyInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientUpdateManyInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeRecipientUpdateManyInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientUpdateManyInternalServerErrorData, + 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 EnvelopeRecipientUpdateManyForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientUpdateManyForbiddenIssue(BaseModel): + message: str + + +class EnvelopeRecipientUpdateManyForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientUpdateManyForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientUpdateManyForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeRecipientUpdateManyForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientUpdateManyForbiddenErrorData, + 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 EnvelopeRecipientUpdateManyUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientUpdateManyUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeRecipientUpdateManyUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientUpdateManyUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientUpdateManyUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeRecipientUpdateManyUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientUpdateManyUnauthorizedErrorData, + 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 EnvelopeRecipientUpdateManyBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRecipientUpdateManyBadRequestIssue(BaseModel): + message: str + + +class EnvelopeRecipientUpdateManyBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRecipientUpdateManyBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRecipientUpdateManyBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeRecipientUpdateManyBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRecipientUpdateManyBadRequestErrorData, + 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 EnvelopeRecipientUpdateManyRoleResponse(str, Enum): + CC = "CC" + SIGNER = "SIGNER" + VIEWER = "VIEWER" + APPROVER = "APPROVER" + ASSISTANT = "ASSISTANT" + + +class EnvelopeRecipientUpdateManyReadStatus(str, Enum): + NOT_OPENED = "NOT_OPENED" + OPENED = "OPENED" + + +class EnvelopeRecipientUpdateManySigningStatus(str, Enum): + NOT_SIGNED = "NOT_SIGNED" + SIGNED = "SIGNED" + REJECTED = "REJECTED" + + +class EnvelopeRecipientUpdateManySendStatus(str, Enum): + NOT_SENT = "NOT_SENT" + SENT = "SENT" + + +class EnvelopeRecipientUpdateManyAccessAuthResponse(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeRecipientUpdateManyActionAuthResponse(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + EXPLICIT_NONE = "EXPLICIT_NONE" + + +class EnvelopeRecipientUpdateManyAuthOptionsTypedDict(TypedDict): + access_auth: List[EnvelopeRecipientUpdateManyAccessAuthResponse] + action_auth: List[EnvelopeRecipientUpdateManyActionAuthResponse] + + +class EnvelopeRecipientUpdateManyAuthOptions(BaseModel): + access_auth: Annotated[ + List[EnvelopeRecipientUpdateManyAccessAuthResponse], + pydantic.Field(alias="accessAuth"), + ] + + action_auth: Annotated[ + List[EnvelopeRecipientUpdateManyActionAuthResponse], + pydantic.Field(alias="actionAuth"), + ] + + +class EnvelopeRecipientUpdateManyDataResponseTypedDict(TypedDict): + envelope_id: str + role: EnvelopeRecipientUpdateManyRoleResponse + read_status: EnvelopeRecipientUpdateManyReadStatus + signing_status: EnvelopeRecipientUpdateManySigningStatus + send_status: EnvelopeRecipientUpdateManySendStatus + id: float + email: str + name: str + token: str + document_deleted_at: Nullable[str] + expired: Nullable[str] + signed_at: Nullable[str] + auth_options: Nullable[EnvelopeRecipientUpdateManyAuthOptionsTypedDict] + signing_order: Nullable[float] + rejection_reason: Nullable[str] + document_id: NotRequired[Nullable[float]] + template_id: NotRequired[Nullable[float]] + + +class EnvelopeRecipientUpdateManyDataResponse(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + role: EnvelopeRecipientUpdateManyRoleResponse + + read_status: Annotated[ + EnvelopeRecipientUpdateManyReadStatus, pydantic.Field(alias="readStatus") + ] + + signing_status: Annotated[ + EnvelopeRecipientUpdateManySigningStatus, pydantic.Field(alias="signingStatus") + ] + + send_status: Annotated[ + EnvelopeRecipientUpdateManySendStatus, 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[EnvelopeRecipientUpdateManyAuthOptions], + pydantic.Field(alias="authOptions"), + ] + + signing_order: Annotated[Nullable[float], pydantic.Field(alias="signingOrder")] + + 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 EnvelopeRecipientUpdateManyResponseTypedDict(TypedDict): + r"""Successful response""" + + data: List[EnvelopeRecipientUpdateManyDataResponseTypedDict] + + +class EnvelopeRecipientUpdateManyResponse(BaseModel): + r"""Successful response""" + + data: List[EnvelopeRecipientUpdateManyDataResponse] diff --git a/src/documenso_sdk/models/envelope_redistributeop.py b/src/documenso_sdk/models/envelope_redistributeop.py new file mode 100644 index 0000000..d991243 --- /dev/null +++ b/src/documenso_sdk/models/envelope_redistributeop.py @@ -0,0 +1,169 @@ +"""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 EnvelopeRedistributeRequestTypedDict(TypedDict): + envelope_id: str + recipients: List[float] + + +class EnvelopeRedistributeRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + recipients: List[float] + + +class EnvelopeRedistributeInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRedistributeInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeRedistributeInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRedistributeInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRedistributeInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeRedistributeInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRedistributeInternalServerErrorData, + 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 EnvelopeRedistributeForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRedistributeForbiddenIssue(BaseModel): + message: str + + +class EnvelopeRedistributeForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRedistributeForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRedistributeForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeRedistributeForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRedistributeForbiddenErrorData, + 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 EnvelopeRedistributeUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRedistributeUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeRedistributeUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRedistributeUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRedistributeUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeRedistributeUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRedistributeUnauthorizedErrorData, + 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 EnvelopeRedistributeBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeRedistributeBadRequestIssue(BaseModel): + message: str + + +class EnvelopeRedistributeBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeRedistributeBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeRedistributeBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeRedistributeBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeRedistributeBadRequestErrorData, + 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 EnvelopeRedistributeResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class EnvelopeRedistributeResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/envelope_updateop.py b/src/documenso_sdk/models/envelope_updateop.py new file mode 100644 index 0000000..772c612 --- /dev/null +++ b/src/documenso_sdk/models/envelope_updateop.py @@ -0,0 +1,640 @@ +"""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 Dict, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict + + +class EnvelopeUpdateDataVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class EnvelopeUpdateDataGlobalAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeUpdateDataGlobalActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class EnvelopeUpdateDataTypedDict(TypedDict): + title: NotRequired[str] + external_id: NotRequired[Nullable[str]] + visibility: NotRequired[EnvelopeUpdateDataVisibility] + global_access_auth: NotRequired[List[EnvelopeUpdateDataGlobalAccessAuth]] + global_action_auth: NotRequired[List[EnvelopeUpdateDataGlobalActionAuth]] + folder_id: NotRequired[Nullable[str]] + + +class EnvelopeUpdateData(BaseModel): + title: Optional[str] = None + + external_id: Annotated[ + OptionalNullable[str], pydantic.Field(alias="externalId") + ] = UNSET + + visibility: Optional[EnvelopeUpdateDataVisibility] = None + + global_access_auth: Annotated[ + Optional[List[EnvelopeUpdateDataGlobalAccessAuth]], + pydantic.Field(alias="globalAccessAuth"), + ] = None + + global_action_auth: Annotated[ + Optional[List[EnvelopeUpdateDataGlobalActionAuth]], + pydantic.Field(alias="globalActionAuth"), + ] = None + + folder_id: Annotated[OptionalNullable[str], pydantic.Field(alias="folderId")] = ( + UNSET + ) + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "title", + "externalId", + "visibility", + "globalAccessAuth", + "globalActionAuth", + "folderId", + ] + nullable_fields = ["externalId", "folderId"] + 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 EnvelopeUpdateDateFormat(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 EnvelopeUpdateDistributionMethod(str, Enum): + EMAIL = "EMAIL" + NONE = "NONE" + + +class EnvelopeUpdateSigningOrder(str, Enum): + PARALLEL = "PARALLEL" + SEQUENTIAL = "SEQUENTIAL" + + +class EnvelopeUpdateLanguage(str, Enum): + DE = "de" + EN = "en" + FR = "fr" + ES = "es" + IT = "it" + PL = "pl" + + +class EnvelopeUpdateEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class EnvelopeUpdateEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class EnvelopeUpdateMetaTypedDict(TypedDict): + subject: NotRequired[str] + message: NotRequired[str] + timezone: NotRequired[str] + date_format: NotRequired[EnvelopeUpdateDateFormat] + distribution_method: NotRequired[EnvelopeUpdateDistributionMethod] + signing_order: NotRequired[EnvelopeUpdateSigningOrder] + allow_dictate_next_signer: NotRequired[bool] + redirect_url: NotRequired[str] + language: NotRequired[EnvelopeUpdateLanguage] + typed_signature_enabled: NotRequired[bool] + upload_signature_enabled: NotRequired[bool] + draw_signature_enabled: NotRequired[bool] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[Nullable[EnvelopeUpdateEmailSettingsTypedDict]] + + +class EnvelopeUpdateMeta(BaseModel): + subject: Optional[str] = None + + message: Optional[str] = None + + timezone: Optional[str] = None + + date_format: Annotated[ + Optional[EnvelopeUpdateDateFormat], pydantic.Field(alias="dateFormat") + ] = None + + distribution_method: Annotated[ + Optional[EnvelopeUpdateDistributionMethod], + pydantic.Field(alias="distributionMethod"), + ] = None + + signing_order: Annotated[ + Optional[EnvelopeUpdateSigningOrder], 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 + + language: Optional[EnvelopeUpdateLanguage] = None + + typed_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="typedSignatureEnabled") + ] = None + + upload_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="uploadSignatureEnabled") + ] = None + + draw_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="drawSignatureEnabled") + ] = None + + email_id: Annotated[OptionalNullable[str], pydantic.Field(alias="emailId")] = UNSET + + email_reply_to: Annotated[ + OptionalNullable[str], pydantic.Field(alias="emailReplyTo") + ] = UNSET + + email_settings: Annotated[ + OptionalNullable[EnvelopeUpdateEmailSettings], + pydantic.Field(alias="emailSettings"), + ] = 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 EnvelopeUpdateRequestTypedDict(TypedDict): + envelope_id: str + data: NotRequired[EnvelopeUpdateDataTypedDict] + meta: NotRequired[EnvelopeUpdateMetaTypedDict] + + +class EnvelopeUpdateRequest(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + data: Optional[EnvelopeUpdateData] = None + + meta: Optional[EnvelopeUpdateMeta] = None + + +class EnvelopeUpdateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeUpdateInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeUpdateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeUpdateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeUpdateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeUpdateInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeUpdateInternalServerErrorData, + 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 EnvelopeUpdateForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeUpdateForbiddenIssue(BaseModel): + message: str + + +class EnvelopeUpdateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeUpdateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeUpdateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeUpdateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeUpdateForbiddenErrorData, + 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 EnvelopeUpdateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeUpdateUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeUpdateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeUpdateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeUpdateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeUpdateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeUpdateUnauthorizedErrorData, + 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 EnvelopeUpdateBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeUpdateBadRequestIssue(BaseModel): + message: str + + +class EnvelopeUpdateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeUpdateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeUpdateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeUpdateBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeUpdateBadRequestErrorData, + 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 EnvelopeUpdateType(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + + +class EnvelopeUpdateStatus(str, Enum): + DRAFT = "DRAFT" + PENDING = "PENDING" + COMPLETED = "COMPLETED" + REJECTED = "REJECTED" + + +class EnvelopeUpdateSource(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + TEMPLATE_DIRECT_LINK = "TEMPLATE_DIRECT_LINK" + + +class EnvelopeUpdateVisibilityResponse(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class EnvelopeUpdateTemplateType(str, Enum): + PUBLIC = "PUBLIC" + PRIVATE = "PRIVATE" + + +class EnvelopeUpdateGlobalAccessAuthResponse(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class EnvelopeUpdateGlobalActionAuthResponse(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class EnvelopeUpdateAuthOptionsTypedDict(TypedDict): + global_access_auth: List[EnvelopeUpdateGlobalAccessAuthResponse] + global_action_auth: List[EnvelopeUpdateGlobalActionAuthResponse] + + +class EnvelopeUpdateAuthOptions(BaseModel): + global_access_auth: Annotated[ + List[EnvelopeUpdateGlobalAccessAuthResponse], + pydantic.Field(alias="globalAccessAuth"), + ] + + global_action_auth: Annotated[ + List[EnvelopeUpdateGlobalActionAuthResponse], + pydantic.Field(alias="globalActionAuth"), + ] + + +EnvelopeUpdateFormValuesTypedDict = TypeAliasType( + "EnvelopeUpdateFormValuesTypedDict", Union[str, bool, float] +) + + +EnvelopeUpdateFormValues = TypeAliasType( + "EnvelopeUpdateFormValues", Union[str, bool, float] +) + + +class EnvelopeUpdateResponseTypedDict(TypedDict): + r"""Successful response""" + + internal_version: float + type: EnvelopeUpdateType + status: EnvelopeUpdateStatus + source: EnvelopeUpdateSource + visibility: EnvelopeUpdateVisibilityResponse + template_type: EnvelopeUpdateTemplateType + id: str + secondary_id: str + external_id: Nullable[str] + created_at: str + updated_at: str + completed_at: Nullable[str] + deleted_at: Nullable[str] + title: str + auth_options: Nullable[EnvelopeUpdateAuthOptionsTypedDict] + form_values: Nullable[Dict[str, EnvelopeUpdateFormValuesTypedDict]] + public_title: str + public_description: str + user_id: float + team_id: float + folder_id: Nullable[str] + + +class EnvelopeUpdateResponse(BaseModel): + r"""Successful response""" + + internal_version: Annotated[float, pydantic.Field(alias="internalVersion")] + + type: EnvelopeUpdateType + + status: EnvelopeUpdateStatus + + source: EnvelopeUpdateSource + + visibility: EnvelopeUpdateVisibilityResponse + + template_type: Annotated[ + EnvelopeUpdateTemplateType, pydantic.Field(alias="templateType") + ] + + id: str + + secondary_id: Annotated[str, pydantic.Field(alias="secondaryId")] + + external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] + + completed_at: Annotated[Nullable[str], pydantic.Field(alias="completedAt")] + + deleted_at: Annotated[Nullable[str], pydantic.Field(alias="deletedAt")] + + title: str + + auth_options: Annotated[ + Nullable[EnvelopeUpdateAuthOptions], pydantic.Field(alias="authOptions") + ] + + form_values: Annotated[ + Nullable[Dict[str, EnvelopeUpdateFormValues]], + pydantic.Field(alias="formValues"), + ] + + public_title: Annotated[str, pydantic.Field(alias="publicTitle")] + + public_description: Annotated[str, pydantic.Field(alias="publicDescription")] + + user_id: Annotated[float, pydantic.Field(alias="userId")] + + team_id: Annotated[float, pydantic.Field(alias="teamId")] + + folder_id: Annotated[Nullable[str], pydantic.Field(alias="folderId")] + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = [ + "externalId", + "completedAt", + "deletedAt", + "authOptions", + "formValues", + "folderId", + ] + 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 diff --git a/src/documenso_sdk/models/envelope_useop.py b/src/documenso_sdk/models/envelope_useop.py new file mode 100644 index 0000000..29a5cf9 --- /dev/null +++ b/src/documenso_sdk/models/envelope_useop.py @@ -0,0 +1,590 @@ +"""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, MultipartFormMetadata +from enum import Enum +import httpx +import io +import pydantic +from typing import IO, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict + + +class EnvelopeUseRecipientTypedDict(TypedDict): + id: float + email: str + name: NotRequired[str] + signing_order: NotRequired[float] + + +class EnvelopeUseRecipient(BaseModel): + id: float + + email: str + + name: Optional[str] = None + + signing_order: Annotated[Optional[float], pydantic.Field(alias="signingOrder")] = ( + None + ) + + +EnvelopeUseIdentifierTypedDict = TypeAliasType( + "EnvelopeUseIdentifierTypedDict", Union[str, float] +) + + +EnvelopeUseIdentifier = TypeAliasType("EnvelopeUseIdentifier", Union[str, float]) + + +class EnvelopeUseCustomDocumentDatumTypedDict(TypedDict): + identifier: EnvelopeUseIdentifierTypedDict + envelope_item_id: str + + +class EnvelopeUseCustomDocumentDatum(BaseModel): + identifier: EnvelopeUseIdentifier + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + +class EnvelopeUseTypeDate(str, Enum): + DATE = "date" + + +class EnvelopeUsePrefillFieldDateTypedDict(TypedDict): + type: EnvelopeUseTypeDate + id: float + value: NotRequired[str] + + +class EnvelopeUsePrefillFieldDate(BaseModel): + type: EnvelopeUseTypeDate + + id: float + + value: Optional[str] = None + + +class EnvelopeUseTypeDropdown(str, Enum): + DROPDOWN = "dropdown" + + +class EnvelopeUsePrefillFieldDropdownTypedDict(TypedDict): + type: EnvelopeUseTypeDropdown + id: float + label: NotRequired[str] + value: NotRequired[str] + + +class EnvelopeUsePrefillFieldDropdown(BaseModel): + type: EnvelopeUseTypeDropdown + + id: float + + label: Optional[str] = None + + value: Optional[str] = None + + +class EnvelopeUseTypeCheckbox(str, Enum): + CHECKBOX = "checkbox" + + +class EnvelopeUsePrefillFieldCheckboxTypedDict(TypedDict): + type: EnvelopeUseTypeCheckbox + id: float + label: NotRequired[str] + value: NotRequired[List[str]] + + +class EnvelopeUsePrefillFieldCheckbox(BaseModel): + type: EnvelopeUseTypeCheckbox + + id: float + + label: Optional[str] = None + + value: Optional[List[str]] = None + + +class EnvelopeUseTypeRadio(str, Enum): + RADIO = "radio" + + +class EnvelopeUsePrefillFieldRadioTypedDict(TypedDict): + type: EnvelopeUseTypeRadio + id: float + label: NotRequired[str] + value: NotRequired[str] + + +class EnvelopeUsePrefillFieldRadio(BaseModel): + type: EnvelopeUseTypeRadio + + id: float + + label: Optional[str] = None + + value: Optional[str] = None + + +class EnvelopeUseTypeNumber(str, Enum): + NUMBER = "number" + + +class EnvelopeUsePrefillFieldNumberTypedDict(TypedDict): + type: EnvelopeUseTypeNumber + id: float + label: NotRequired[str] + placeholder: NotRequired[str] + value: NotRequired[str] + + +class EnvelopeUsePrefillFieldNumber(BaseModel): + type: EnvelopeUseTypeNumber + + id: float + + label: Optional[str] = None + + placeholder: Optional[str] = None + + value: Optional[str] = None + + +class EnvelopeUseTypeText(str, Enum): + TEXT = "text" + + +class EnvelopeUsePrefillFieldTextTypedDict(TypedDict): + type: EnvelopeUseTypeText + id: float + label: NotRequired[str] + placeholder: NotRequired[str] + value: NotRequired[str] + + +class EnvelopeUsePrefillFieldText(BaseModel): + type: EnvelopeUseTypeText + + id: float + + label: Optional[str] = None + + placeholder: Optional[str] = None + + value: Optional[str] = None + + +EnvelopeUsePrefillFieldUnionTypedDict = TypeAliasType( + "EnvelopeUsePrefillFieldUnionTypedDict", + Union[ + EnvelopeUsePrefillFieldDateTypedDict, + EnvelopeUsePrefillFieldRadioTypedDict, + EnvelopeUsePrefillFieldCheckboxTypedDict, + EnvelopeUsePrefillFieldDropdownTypedDict, + EnvelopeUsePrefillFieldTextTypedDict, + EnvelopeUsePrefillFieldNumberTypedDict, + ], +) + + +EnvelopeUsePrefillFieldUnion = TypeAliasType( + "EnvelopeUsePrefillFieldUnion", + Union[ + EnvelopeUsePrefillFieldDate, + EnvelopeUsePrefillFieldRadio, + EnvelopeUsePrefillFieldCheckbox, + EnvelopeUsePrefillFieldDropdown, + EnvelopeUsePrefillFieldText, + EnvelopeUsePrefillFieldNumber, + ], +) + + +class EnvelopeUseDateFormat(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 EnvelopeUseDistributionMethod(str, Enum): + EMAIL = "EMAIL" + NONE = "NONE" + + +class EnvelopeUseEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class EnvelopeUseEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class EnvelopeUseLanguage(str, Enum): + DE = "de" + EN = "en" + FR = "fr" + ES = "es" + IT = "it" + PL = "pl" + + +class OverrideTypedDict(TypedDict): + title: NotRequired[str] + subject: NotRequired[str] + message: NotRequired[str] + timezone: NotRequired[str] + date_format: NotRequired[EnvelopeUseDateFormat] + redirect_url: NotRequired[str] + distribution_method: NotRequired[EnvelopeUseDistributionMethod] + email_settings: NotRequired[EnvelopeUseEmailSettingsTypedDict] + language: NotRequired[EnvelopeUseLanguage] + typed_signature_enabled: NotRequired[bool] + upload_signature_enabled: NotRequired[bool] + draw_signature_enabled: NotRequired[bool] + allow_dictate_next_signer: NotRequired[bool] + + +class Override(BaseModel): + title: Optional[str] = None + + subject: Optional[str] = None + + message: Optional[str] = None + + timezone: Optional[str] = None + + date_format: Annotated[ + Optional[EnvelopeUseDateFormat], pydantic.Field(alias="dateFormat") + ] = None + + redirect_url: Annotated[Optional[str], pydantic.Field(alias="redirectUrl")] = None + + distribution_method: Annotated[ + Optional[EnvelopeUseDistributionMethod], + pydantic.Field(alias="distributionMethod"), + ] = None + + email_settings: Annotated[ + Optional[EnvelopeUseEmailSettings], pydantic.Field(alias="emailSettings") + ] = None + + language: Optional[EnvelopeUseLanguage] = None + + typed_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="typedSignatureEnabled") + ] = None + + upload_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="uploadSignatureEnabled") + ] = None + + draw_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="drawSignatureEnabled") + ] = None + + allow_dictate_next_signer: Annotated[ + Optional[bool], pydantic.Field(alias="allowDictateNextSigner") + ] = None + + +class EnvelopeUseTypeLink(str, Enum): + LINK = "link" + + +class EnvelopeUseAttachmentTypedDict(TypedDict): + label: str + data: str + type: NotRequired[EnvelopeUseTypeLink] + + +class EnvelopeUseAttachment(BaseModel): + label: str + + data: str + + type: Optional[EnvelopeUseTypeLink] = EnvelopeUseTypeLink.LINK + + +class EnvelopeUsePayloadTypedDict(TypedDict): + envelope_id: str + recipients: List[EnvelopeUseRecipientTypedDict] + external_id: NotRequired[str] + distribute_document: NotRequired[bool] + custom_document_data: NotRequired[List[EnvelopeUseCustomDocumentDatumTypedDict]] + folder_id: NotRequired[str] + prefill_fields: NotRequired[List[EnvelopeUsePrefillFieldUnionTypedDict]] + override: NotRequired[OverrideTypedDict] + attachments: NotRequired[List[EnvelopeUseAttachmentTypedDict]] + + +class EnvelopeUsePayload(BaseModel): + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + recipients: List[EnvelopeUseRecipient] + + external_id: Annotated[Optional[str], pydantic.Field(alias="externalId")] = None + + distribute_document: Annotated[ + Optional[bool], pydantic.Field(alias="distributeDocument") + ] = None + + custom_document_data: Annotated[ + Optional[List[EnvelopeUseCustomDocumentDatum]], + pydantic.Field(alias="customDocumentData"), + ] = None + + folder_id: Annotated[Optional[str], pydantic.Field(alias="folderId")] = None + + prefill_fields: Annotated[ + Optional[List[EnvelopeUsePrefillFieldUnion]], + pydantic.Field(alias="prefillFields"), + ] = None + + override: Optional[Override] = None + + attachments: Optional[List[EnvelopeUseAttachment]] = None + + +class EnvelopeUseFileTypedDict(TypedDict): + file_name: str + content: Union[bytes, IO[bytes], io.BufferedReader] + content_type: NotRequired[str] + + +class EnvelopeUseFile(BaseModel): + file_name: Annotated[ + str, pydantic.Field(alias="fileName"), FieldMetadata(multipart=True) + ] + + content: Annotated[ + Union[bytes, IO[bytes], io.BufferedReader], + pydantic.Field(alias=""), + FieldMetadata(multipart=MultipartFormMetadata(content=True)), + ] + + content_type: Annotated[ + Optional[str], + pydantic.Field(alias="Content-Type"), + FieldMetadata(multipart=True), + ] = None + + +class EnvelopeUseRequestTypedDict(TypedDict): + payload: EnvelopeUsePayloadTypedDict + files: NotRequired[List[EnvelopeUseFileTypedDict]] + + +class EnvelopeUseRequest(BaseModel): + payload: Annotated[ + EnvelopeUsePayload, FieldMetadata(multipart=MultipartFormMetadata(json=True)) + ] + + files: Annotated[ + Optional[List[EnvelopeUseFile]], + FieldMetadata(multipart=MultipartFormMetadata(file=True)), + ] = None + + +class EnvelopeUseInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class EnvelopeUseInternalServerErrorIssue(BaseModel): + message: str + + +class EnvelopeUseInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeUseInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeUseInternalServerError(DocumensoError): + r"""Internal server error""" + + data: EnvelopeUseInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeUseInternalServerErrorData, + 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 EnvelopeUseForbiddenIssueTypedDict(TypedDict): + message: str + + +class EnvelopeUseForbiddenIssue(BaseModel): + message: str + + +class EnvelopeUseForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeUseForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeUseForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: EnvelopeUseForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeUseForbiddenErrorData, + 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 EnvelopeUseUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class EnvelopeUseUnauthorizedIssue(BaseModel): + message: str + + +class EnvelopeUseUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeUseUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeUseUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: EnvelopeUseUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeUseUnauthorizedErrorData, + 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 EnvelopeUseBadRequestIssueTypedDict(TypedDict): + message: str + + +class EnvelopeUseBadRequestIssue(BaseModel): + message: str + + +class EnvelopeUseBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[EnvelopeUseBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class EnvelopeUseBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: EnvelopeUseBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: EnvelopeUseBadRequestErrorData, + 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 EnvelopeUseResponseTypedDict(TypedDict): + r"""Successful response""" + + id: str + + +class EnvelopeUseResponse(BaseModel): + r"""Successful response""" + + id: str diff --git a/src/documenso_sdk/models/field_createdocumentfieldop.py b/src/documenso_sdk/models/field_createdocumentfieldop.py index 8d71d39..11b1db1 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 @@ -33,6 +40,7 @@ class FieldCreateDocumentFieldFieldMetaDropdownRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldValueDropdownTypedDict]] default_value: NotRequired[str] @@ -48,6 +56,8 @@ class FieldCreateDocumentFieldFieldMetaDropdownRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldValueDropdown]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -56,17 +66,11 @@ class FieldCreateDocumentFieldFieldMetaDropdownRequest(BaseModel): class FieldCreateDocumentFieldFieldDropdownTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeDropdownRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldFieldMetaDropdownRequestTypedDict] @@ -74,22 +78,16 @@ class FieldCreateDocumentFieldFieldDropdown(BaseModel): type: FieldCreateDocumentFieldTypeDropdownRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldFieldMetaDropdownRequest], @@ -119,15 +117,22 @@ class FieldCreateDocumentFieldValueCheckbox(BaseModel): value: str +class FieldCreateDocumentFieldDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeCheckboxRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateDocumentFieldDirectionCheckbox] class FieldCreateDocumentFieldFieldMetaCheckboxRequest(BaseModel): @@ -141,6 +146,8 @@ class FieldCreateDocumentFieldFieldMetaCheckboxRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldValueCheckbox]] = None validation_rule: Annotated[ @@ -151,21 +158,19 @@ class FieldCreateDocumentFieldFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateDocumentFieldDirectionCheckbox] = ( + FieldCreateDocumentFieldDirectionCheckbox.VERTICAL + ) + class FieldCreateDocumentFieldFieldCheckboxTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeCheckboxRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldFieldMetaCheckboxRequestTypedDict] @@ -173,22 +178,16 @@ class FieldCreateDocumentFieldFieldCheckbox(BaseModel): type: FieldCreateDocumentFieldTypeCheckboxRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldFieldMetaCheckboxRequest], @@ -218,13 +217,20 @@ class FieldCreateDocumentFieldValueRadio(BaseModel): value: str +class FieldCreateDocumentFieldDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldFieldMetaRadioRequestTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeRadioRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldValueRadioTypedDict]] + direction: NotRequired[FieldCreateDocumentFieldDirectionRadio] class FieldCreateDocumentFieldFieldMetaRadioRequest(BaseModel): @@ -238,23 +244,23 @@ class FieldCreateDocumentFieldFieldMetaRadioRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldValueRadio]] = None + direction: Optional[FieldCreateDocumentFieldDirectionRadio] = ( + FieldCreateDocumentFieldDirectionRadio.VERTICAL + ) + class FieldCreateDocumentFieldFieldRadioTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeRadioRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldFieldMetaRadioRequestTypedDict] @@ -262,22 +268,16 @@ class FieldCreateDocumentFieldFieldRadio(BaseModel): type: FieldCreateDocumentFieldTypeRadioRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldFieldMetaRadioRequest], @@ -299,18 +299,27 @@ class FieldCreateDocumentFieldTextAlignNumber(str, Enum): RIGHT = "right" +class FieldCreateDocumentFieldVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateDocumentFieldFieldMetaNumberRequestTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeNumberRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldCreateDocumentFieldTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldCreateDocumentFieldVerticalAlignNumber]] class FieldCreateDocumentFieldFieldMetaNumberRequest(BaseModel): @@ -324,36 +333,100 @@ class FieldCreateDocumentFieldFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldCreateDocumentFieldTextAlignNumber], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateDocumentFieldVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldFieldMetaNumberRequestTypedDict] @@ -361,22 +434,16 @@ class FieldCreateDocumentFieldFieldNumber(BaseModel): type: FieldCreateDocumentFieldTypeNumberRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldFieldMetaNumberRequest], @@ -398,16 +465,25 @@ class FieldCreateDocumentFieldTextAlignText(str, Enum): RIGHT = "right" +class FieldCreateDocumentFieldVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateDocumentFieldFieldMetaTextRequestTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeTextRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldCreateDocumentFieldTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldCreateDocumentFieldVerticalAlignText]] class FieldCreateDocumentFieldFieldMetaTextRequest(BaseModel): @@ -421,34 +497,83 @@ class FieldCreateDocumentFieldFieldMetaTextRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldCreateDocumentFieldTextAlignText], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateDocumentFieldVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldCreateDocumentFieldFieldTextTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeTextRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldFieldMetaTextRequestTypedDict] @@ -456,22 +581,16 @@ class FieldCreateDocumentFieldFieldText(BaseModel): type: FieldCreateDocumentFieldTypeTextRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldFieldMetaTextRequest], @@ -514,7 +633,7 @@ class FieldCreateDocumentFieldFieldMetaDateRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldTextAlignDate], @@ -525,17 +644,11 @@ class FieldCreateDocumentFieldFieldMetaDateRequest(BaseModel): class FieldCreateDocumentFieldFieldDateTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeDateRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldFieldMetaDateRequestTypedDict] @@ -543,22 +656,16 @@ class FieldCreateDocumentFieldFieldDate(BaseModel): type: FieldCreateDocumentFieldTypeDateRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldFieldMetaDateRequest], @@ -601,7 +708,7 @@ class FieldCreateDocumentFieldFieldMetaEmailRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldTextAlignEmail], @@ -612,17 +719,11 @@ class FieldCreateDocumentFieldFieldMetaEmailRequest(BaseModel): class FieldCreateDocumentFieldFieldEmailTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeEmailRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldFieldMetaEmailRequestTypedDict] @@ -630,22 +731,16 @@ class FieldCreateDocumentFieldFieldEmail(BaseModel): type: FieldCreateDocumentFieldTypeEmailRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldFieldMetaEmailRequest], @@ -688,7 +783,7 @@ class FieldCreateDocumentFieldFieldMetaNameRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldTextAlignName], @@ -699,17 +794,11 @@ class FieldCreateDocumentFieldFieldMetaNameRequest(BaseModel): class FieldCreateDocumentFieldFieldNameTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeNameRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldFieldMetaNameRequestTypedDict] @@ -717,22 +806,16 @@ class FieldCreateDocumentFieldFieldName(BaseModel): type: FieldCreateDocumentFieldTypeNameRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldFieldMetaNameRequest], @@ -775,7 +858,7 @@ class FieldCreateDocumentFieldFieldMetaInitialsRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldTextAlignInitials], @@ -786,17 +869,11 @@ class FieldCreateDocumentFieldFieldMetaInitialsRequest(BaseModel): class FieldCreateDocumentFieldFieldInitialsTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeInitialsRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldFieldMetaInitialsRequestTypedDict] @@ -804,22 +881,16 @@ class FieldCreateDocumentFieldFieldInitials(BaseModel): type: FieldCreateDocumentFieldTypeInitialsRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldFieldMetaInitialsRequest], @@ -834,88 +905,97 @@ class FieldCreateDocumentFieldTypeFreeSignature(str, Enum): class FieldCreateDocumentFieldFieldFreeSignatureTypedDict(TypedDict): type: FieldCreateDocumentFieldTypeFreeSignature recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" class FieldCreateDocumentFieldFieldFreeSignature(BaseModel): type: FieldCreateDocumentFieldTypeFreeSignature recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" -class FieldCreateDocumentFieldTypeSignature(str, Enum): +class FieldCreateDocumentFieldTypeSignatureRequest1(str, Enum): SIGNATURE = "SIGNATURE" +class FieldCreateDocumentFieldTypeSignatureRequest2(str, Enum): + SIGNATURE = "signature" + + +class FieldCreateDocumentFieldFieldMetaSignatureRequestTypedDict(TypedDict): + type: FieldCreateDocumentFieldTypeSignatureRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldCreateDocumentFieldFieldMetaSignatureRequest(BaseModel): + type: FieldCreateDocumentFieldTypeSignatureRequest2 + + 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")] = 12 + + class FieldCreateDocumentFieldFieldSignatureTypedDict(TypedDict): - type: FieldCreateDocumentFieldTypeSignature + type: FieldCreateDocumentFieldTypeSignatureRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" + field_meta: NotRequired[FieldCreateDocumentFieldFieldMetaSignatureRequestTypedDict] class FieldCreateDocumentFieldFieldSignature(BaseModel): - type: FieldCreateDocumentFieldTypeSignature + type: FieldCreateDocumentFieldTypeSignatureRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" + + field_meta: Annotated[ + Optional[FieldCreateDocumentFieldFieldMetaSignatureRequest], + pydantic.Field(alias="fieldMeta"), + ] = None FieldCreateDocumentFieldFieldUnionTypedDict = TypeAliasType( "FieldCreateDocumentFieldFieldUnionTypedDict", Union[ - FieldCreateDocumentFieldFieldSignatureTypedDict, FieldCreateDocumentFieldFieldFreeSignatureTypedDict, + FieldCreateDocumentFieldFieldSignatureTypedDict, FieldCreateDocumentFieldFieldInitialsTypedDict, FieldCreateDocumentFieldFieldNameTypedDict, FieldCreateDocumentFieldFieldEmailTypedDict, @@ -932,8 +1012,8 @@ class FieldCreateDocumentFieldFieldSignature(BaseModel): FieldCreateDocumentFieldFieldUnion = TypeAliasType( "FieldCreateDocumentFieldFieldUnion", Union[ - FieldCreateDocumentFieldFieldSignature, FieldCreateDocumentFieldFieldFreeSignature, + FieldCreateDocumentFieldFieldSignature, FieldCreateDocumentFieldFieldInitials, FieldCreateDocumentFieldFieldName, FieldCreateDocumentFieldFieldEmail, @@ -974,10 +1054,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 +1069,75 @@ 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 FieldCreateDocumentFieldForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldCreateDocumentFieldForbiddenIssue(BaseModel): + message: str + + +class FieldCreateDocumentFieldForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldCreateDocumentFieldForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldCreateDocumentFieldForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldCreateDocumentFieldForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldCreateDocumentFieldForbiddenErrorData, + 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 FieldCreateDocumentFieldUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldCreateDocumentFieldUnauthorizedIssue(BaseModel): + message: str + + +class FieldCreateDocumentFieldUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldCreateDocumentFieldUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldCreateDocumentFieldUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldCreateDocumentFieldUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldCreateDocumentFieldUnauthorizedErrorData, + 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 FieldCreateDocumentFieldBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1156,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 +1171,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): @@ -1056,6 +1206,7 @@ class FieldCreateDocumentFieldFieldMetaDropdownResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldValueResponse3TypedDict]] default_value: NotRequired[str] @@ -1071,6 +1222,8 @@ class FieldCreateDocumentFieldFieldMetaDropdownResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldValueResponse3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -1094,15 +1247,22 @@ class FieldCreateDocumentFieldValueResponse2(BaseModel): value: str +class FieldCreateDocumentFieldDirectionResponse2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldCreateDocumentFieldFieldMetaTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateDocumentFieldDirectionResponse2] class FieldCreateDocumentFieldFieldMetaCheckboxResponse(BaseModel): @@ -1116,6 +1276,8 @@ class FieldCreateDocumentFieldFieldMetaCheckboxResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldValueResponse2]] = None validation_rule: Annotated[ @@ -1126,6 +1288,10 @@ class FieldCreateDocumentFieldFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateDocumentFieldDirectionResponse2] = ( + FieldCreateDocumentFieldDirectionResponse2.VERTICAL + ) + class FieldCreateDocumentFieldFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1145,13 +1311,20 @@ class FieldCreateDocumentFieldValueResponse1(BaseModel): value: str +class FieldCreateDocumentFieldDirectionResponse1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldFieldMetaRadioResponseTypedDict(TypedDict): type: FieldCreateDocumentFieldFieldMetaTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldValueResponse1TypedDict]] + direction: NotRequired[FieldCreateDocumentFieldDirectionResponse1] class FieldCreateDocumentFieldFieldMetaRadioResponse(BaseModel): @@ -1165,8 +1338,14 @@ class FieldCreateDocumentFieldFieldMetaRadioResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldValueResponse1]] = None + direction: Optional[FieldCreateDocumentFieldDirectionResponse1] = ( + FieldCreateDocumentFieldDirectionResponse1.VERTICAL + ) + class FieldCreateDocumentFieldFieldMetaTypeNumber(str, Enum): NUMBER = "number" @@ -1178,18 +1357,29 @@ class FieldCreateDocumentFieldTextAlignResponse6(str, Enum): RIGHT = "right" +class FieldCreateDocumentFieldVerticalAlignResponse2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateDocumentFieldFieldMetaNumberResponseTypedDict(TypedDict): type: FieldCreateDocumentFieldFieldMetaTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldCreateDocumentFieldTextAlignResponse6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldCreateDocumentFieldVerticalAlignResponse2] + ] class FieldCreateDocumentFieldFieldMetaNumberResponse(BaseModel): @@ -1203,21 +1393,91 @@ class FieldCreateDocumentFieldFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldCreateDocumentFieldTextAlignResponse6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateDocumentFieldVerticalAlignResponse2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -1229,16 +1489,27 @@ class FieldCreateDocumentFieldTextAlignResponse5(str, Enum): RIGHT = "right" +class FieldCreateDocumentFieldVerticalAlignResponse1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateDocumentFieldFieldMetaTextResponseTypedDict(TypedDict): type: FieldCreateDocumentFieldFieldMetaTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldCreateDocumentFieldTextAlignResponse5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldCreateDocumentFieldVerticalAlignResponse1] + ] class FieldCreateDocumentFieldFieldMetaTextResponse(BaseModel): @@ -1252,19 +1523,74 @@ class FieldCreateDocumentFieldFieldMetaTextResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldCreateDocumentFieldTextAlignResponse5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateDocumentFieldVerticalAlignResponse1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldCreateDocumentFieldFieldMetaTypeDate(str, Enum): DATE = "date" @@ -1297,7 +1623,7 @@ class FieldCreateDocumentFieldFieldMetaDateResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldTextAlignResponse4], @@ -1336,7 +1662,7 @@ class FieldCreateDocumentFieldFieldMetaEmailResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldTextAlignResponse3], @@ -1375,7 +1701,7 @@ class FieldCreateDocumentFieldFieldMetaNameResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldTextAlignResponse2], @@ -1414,7 +1740,7 @@ class FieldCreateDocumentFieldFieldMetaInitialsResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldTextAlignResponse1], @@ -1422,14 +1748,42 @@ class FieldCreateDocumentFieldFieldMetaInitialsResponse(BaseModel): ] = None +class FieldCreateDocumentFieldFieldMetaTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldCreateDocumentFieldFieldMetaSignatureResponseTypedDict(TypedDict): + type: FieldCreateDocumentFieldFieldMetaTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldCreateDocumentFieldFieldMetaSignatureResponse(BaseModel): + type: FieldCreateDocumentFieldFieldMetaTypeSignature + + 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")] = 12 + + FieldCreateDocumentFieldFieldMetaUnionTypedDict = TypeAliasType( "FieldCreateDocumentFieldFieldMetaUnionTypedDict", Union[ - FieldCreateDocumentFieldFieldMetaRadioResponseTypedDict, + FieldCreateDocumentFieldFieldMetaSignatureResponseTypedDict, FieldCreateDocumentFieldFieldMetaInitialsResponseTypedDict, FieldCreateDocumentFieldFieldMetaNameResponseTypedDict, FieldCreateDocumentFieldFieldMetaEmailResponseTypedDict, FieldCreateDocumentFieldFieldMetaDateResponseTypedDict, + FieldCreateDocumentFieldFieldMetaRadioResponseTypedDict, FieldCreateDocumentFieldFieldMetaDropdownResponseTypedDict, FieldCreateDocumentFieldFieldMetaCheckboxResponseTypedDict, FieldCreateDocumentFieldFieldMetaTextResponseTypedDict, @@ -1441,11 +1795,12 @@ class FieldCreateDocumentFieldFieldMetaInitialsResponse(BaseModel): FieldCreateDocumentFieldFieldMetaUnion = TypeAliasType( "FieldCreateDocumentFieldFieldMetaUnion", Union[ - FieldCreateDocumentFieldFieldMetaRadioResponse, + FieldCreateDocumentFieldFieldMetaSignatureResponse, FieldCreateDocumentFieldFieldMetaInitialsResponse, FieldCreateDocumentFieldFieldMetaNameResponse, FieldCreateDocumentFieldFieldMetaEmailResponse, FieldCreateDocumentFieldFieldMetaDateResponse, + FieldCreateDocumentFieldFieldMetaRadioResponse, FieldCreateDocumentFieldFieldMetaDropdownResponse, FieldCreateDocumentFieldFieldMetaCheckboxResponse, FieldCreateDocumentFieldFieldMetaTextResponse, @@ -1457,40 +1812,48 @@ 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[FieldCreateDocumentFieldFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -1501,18 +1864,18 @@ class FieldCreateDocumentFieldResponse(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["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..3cc106e 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 @@ -33,6 +40,7 @@ class FieldCreateDocumentFieldsFieldMetaDropdownRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldsValueDropdownTypedDict]] default_value: NotRequired[str] @@ -48,6 +56,8 @@ class FieldCreateDocumentFieldsFieldMetaDropdownRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldsValueDropdown]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -56,17 +66,11 @@ class FieldCreateDocumentFieldsFieldMetaDropdownRequest(BaseModel): class FieldCreateDocumentFieldsFieldDropdownTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeDropdownRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldsFieldMetaDropdownRequestTypedDict] @@ -74,22 +78,16 @@ class FieldCreateDocumentFieldsFieldDropdown(BaseModel): type: FieldCreateDocumentFieldsTypeDropdownRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldsFieldMetaDropdownRequest], @@ -119,15 +117,22 @@ class FieldCreateDocumentFieldsValueCheckbox(BaseModel): value: str +class FieldCreateDocumentFieldsDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeCheckboxRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldsValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateDocumentFieldsDirectionCheckbox] class FieldCreateDocumentFieldsFieldMetaCheckboxRequest(BaseModel): @@ -141,6 +146,8 @@ class FieldCreateDocumentFieldsFieldMetaCheckboxRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldsValueCheckbox]] = None validation_rule: Annotated[ @@ -151,21 +158,19 @@ class FieldCreateDocumentFieldsFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateDocumentFieldsDirectionCheckbox] = ( + FieldCreateDocumentFieldsDirectionCheckbox.VERTICAL + ) + class FieldCreateDocumentFieldsFieldCheckboxTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeCheckboxRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldsFieldMetaCheckboxRequestTypedDict] @@ -173,22 +178,16 @@ class FieldCreateDocumentFieldsFieldCheckbox(BaseModel): type: FieldCreateDocumentFieldsTypeCheckboxRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldsFieldMetaCheckboxRequest], @@ -218,13 +217,20 @@ class FieldCreateDocumentFieldsValueRadio(BaseModel): value: str +class FieldCreateDocumentFieldsDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldsFieldMetaRadioRequestTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeRadioRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldsValueRadioTypedDict]] + direction: NotRequired[FieldCreateDocumentFieldsDirectionRadio] class FieldCreateDocumentFieldsFieldMetaRadioRequest(BaseModel): @@ -238,23 +244,23 @@ class FieldCreateDocumentFieldsFieldMetaRadioRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldsValueRadio]] = None + direction: Optional[FieldCreateDocumentFieldsDirectionRadio] = ( + FieldCreateDocumentFieldsDirectionRadio.VERTICAL + ) + class FieldCreateDocumentFieldsFieldRadioTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeRadioRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldsFieldMetaRadioRequestTypedDict] @@ -262,22 +268,16 @@ class FieldCreateDocumentFieldsFieldRadio(BaseModel): type: FieldCreateDocumentFieldsTypeRadioRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldsFieldMetaRadioRequest], @@ -299,18 +299,27 @@ class FieldCreateDocumentFieldsTextAlignNumber(str, Enum): RIGHT = "right" +class FieldCreateDocumentFieldsVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateDocumentFieldsFieldMetaNumberRequestTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeNumberRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldCreateDocumentFieldsTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldCreateDocumentFieldsVerticalAlignNumber]] class FieldCreateDocumentFieldsFieldMetaNumberRequest(BaseModel): @@ -324,36 +333,100 @@ class FieldCreateDocumentFieldsFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldCreateDocumentFieldsTextAlignNumber], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateDocumentFieldsVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldsFieldMetaNumberRequestTypedDict] @@ -361,22 +434,16 @@ class FieldCreateDocumentFieldsFieldNumber(BaseModel): type: FieldCreateDocumentFieldsTypeNumberRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldsFieldMetaNumberRequest], @@ -398,16 +465,25 @@ class FieldCreateDocumentFieldsTextAlignText(str, Enum): RIGHT = "right" +class FieldCreateDocumentFieldsVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateDocumentFieldsFieldMetaTextRequestTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeTextRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldCreateDocumentFieldsTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldCreateDocumentFieldsVerticalAlignText]] class FieldCreateDocumentFieldsFieldMetaTextRequest(BaseModel): @@ -421,34 +497,83 @@ class FieldCreateDocumentFieldsFieldMetaTextRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldCreateDocumentFieldsTextAlignText], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateDocumentFieldsVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldCreateDocumentFieldsFieldTextTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeTextRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldsFieldMetaTextRequestTypedDict] @@ -456,22 +581,16 @@ class FieldCreateDocumentFieldsFieldText(BaseModel): type: FieldCreateDocumentFieldsTypeTextRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldsFieldMetaTextRequest], @@ -514,7 +633,7 @@ class FieldCreateDocumentFieldsFieldMetaDateRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldsTextAlignDate], @@ -525,17 +644,11 @@ class FieldCreateDocumentFieldsFieldMetaDateRequest(BaseModel): class FieldCreateDocumentFieldsFieldDateTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeDateRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldsFieldMetaDateRequestTypedDict] @@ -543,22 +656,16 @@ class FieldCreateDocumentFieldsFieldDate(BaseModel): type: FieldCreateDocumentFieldsTypeDateRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldsFieldMetaDateRequest], @@ -601,7 +708,7 @@ class FieldCreateDocumentFieldsFieldMetaEmailRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldsTextAlignEmail], @@ -612,17 +719,11 @@ class FieldCreateDocumentFieldsFieldMetaEmailRequest(BaseModel): class FieldCreateDocumentFieldsFieldEmailTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeEmailRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldsFieldMetaEmailRequestTypedDict] @@ -630,22 +731,16 @@ class FieldCreateDocumentFieldsFieldEmail(BaseModel): type: FieldCreateDocumentFieldsTypeEmailRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldsFieldMetaEmailRequest], @@ -688,7 +783,7 @@ class FieldCreateDocumentFieldsFieldMetaNameRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldsTextAlignName], @@ -699,17 +794,11 @@ class FieldCreateDocumentFieldsFieldMetaNameRequest(BaseModel): class FieldCreateDocumentFieldsFieldNameTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeNameRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldsFieldMetaNameRequestTypedDict] @@ -717,22 +806,16 @@ class FieldCreateDocumentFieldsFieldName(BaseModel): type: FieldCreateDocumentFieldsTypeNameRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldsFieldMetaNameRequest], @@ -775,7 +858,7 @@ class FieldCreateDocumentFieldsFieldMetaInitialsRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldsTextAlignInitials], @@ -786,17 +869,11 @@ class FieldCreateDocumentFieldsFieldMetaInitialsRequest(BaseModel): class FieldCreateDocumentFieldsFieldInitialsTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeInitialsRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateDocumentFieldsFieldMetaInitialsRequestTypedDict] @@ -804,22 +881,16 @@ class FieldCreateDocumentFieldsFieldInitials(BaseModel): type: FieldCreateDocumentFieldsTypeInitialsRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateDocumentFieldsFieldMetaInitialsRequest], @@ -834,88 +905,97 @@ class FieldCreateDocumentFieldsTypeFreeSignature(str, Enum): class FieldCreateDocumentFieldsFieldFreeSignatureTypedDict(TypedDict): type: FieldCreateDocumentFieldsTypeFreeSignature recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" class FieldCreateDocumentFieldsFieldFreeSignature(BaseModel): type: FieldCreateDocumentFieldsTypeFreeSignature recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" -class FieldCreateDocumentFieldsTypeSignature(str, Enum): +class FieldCreateDocumentFieldsTypeSignatureRequest1(str, Enum): SIGNATURE = "SIGNATURE" +class FieldCreateDocumentFieldsTypeSignatureRequest2(str, Enum): + SIGNATURE = "signature" + + +class FieldCreateDocumentFieldsFieldMetaSignatureRequestTypedDict(TypedDict): + type: FieldCreateDocumentFieldsTypeSignatureRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldCreateDocumentFieldsFieldMetaSignatureRequest(BaseModel): + type: FieldCreateDocumentFieldsTypeSignatureRequest2 + + 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")] = 12 + + class FieldCreateDocumentFieldsFieldSignatureTypedDict(TypedDict): - type: FieldCreateDocumentFieldsTypeSignature + type: FieldCreateDocumentFieldsTypeSignatureRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" + field_meta: NotRequired[FieldCreateDocumentFieldsFieldMetaSignatureRequestTypedDict] class FieldCreateDocumentFieldsFieldSignature(BaseModel): - type: FieldCreateDocumentFieldsTypeSignature + type: FieldCreateDocumentFieldsTypeSignatureRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" + + field_meta: Annotated[ + Optional[FieldCreateDocumentFieldsFieldMetaSignatureRequest], + pydantic.Field(alias="fieldMeta"), + ] = None FieldCreateDocumentFieldsFieldUnionTypedDict = TypeAliasType( "FieldCreateDocumentFieldsFieldUnionTypedDict", Union[ - FieldCreateDocumentFieldsFieldSignatureTypedDict, FieldCreateDocumentFieldsFieldFreeSignatureTypedDict, + FieldCreateDocumentFieldsFieldSignatureTypedDict, FieldCreateDocumentFieldsFieldInitialsTypedDict, FieldCreateDocumentFieldsFieldNameTypedDict, FieldCreateDocumentFieldsFieldEmailTypedDict, @@ -932,8 +1012,8 @@ class FieldCreateDocumentFieldsFieldSignature(BaseModel): FieldCreateDocumentFieldsFieldUnion = TypeAliasType( "FieldCreateDocumentFieldsFieldUnion", Union[ - FieldCreateDocumentFieldsFieldSignature, FieldCreateDocumentFieldsFieldFreeSignature, + FieldCreateDocumentFieldsFieldSignature, FieldCreateDocumentFieldsFieldInitials, FieldCreateDocumentFieldsFieldName, FieldCreateDocumentFieldsFieldEmail, @@ -974,10 +1054,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 +1069,75 @@ 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 FieldCreateDocumentFieldsForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldCreateDocumentFieldsForbiddenIssue(BaseModel): + message: str + + +class FieldCreateDocumentFieldsForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldCreateDocumentFieldsForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldCreateDocumentFieldsForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldCreateDocumentFieldsForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldCreateDocumentFieldsForbiddenErrorData, + 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 FieldCreateDocumentFieldsUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldCreateDocumentFieldsUnauthorizedIssue(BaseModel): + message: str + + +class FieldCreateDocumentFieldsUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldCreateDocumentFieldsUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldCreateDocumentFieldsUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldCreateDocumentFieldsUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldCreateDocumentFieldsUnauthorizedErrorData, + 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 FieldCreateDocumentFieldsBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1156,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 +1171,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): @@ -1056,6 +1206,7 @@ class FieldCreateDocumentFieldsFieldMetaDropdownResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldsValueResponse3TypedDict]] default_value: NotRequired[str] @@ -1071,6 +1222,8 @@ class FieldCreateDocumentFieldsFieldMetaDropdownResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldsValueResponse3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -1094,15 +1247,22 @@ class FieldCreateDocumentFieldsValueResponse2(BaseModel): value: str +class FieldCreateDocumentFieldsDirectionResponse2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldCreateDocumentFieldsFieldMetaTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldsValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateDocumentFieldsDirectionResponse2] class FieldCreateDocumentFieldsFieldMetaCheckboxResponse(BaseModel): @@ -1116,6 +1276,8 @@ class FieldCreateDocumentFieldsFieldMetaCheckboxResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldsValueResponse2]] = None validation_rule: Annotated[ @@ -1126,6 +1288,10 @@ class FieldCreateDocumentFieldsFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateDocumentFieldsDirectionResponse2] = ( + FieldCreateDocumentFieldsDirectionResponse2.VERTICAL + ) + class FieldCreateDocumentFieldsFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1145,13 +1311,20 @@ class FieldCreateDocumentFieldsValueResponse1(BaseModel): value: str +class FieldCreateDocumentFieldsDirectionResponse1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateDocumentFieldsFieldMetaRadioResponseTypedDict(TypedDict): type: FieldCreateDocumentFieldsFieldMetaTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateDocumentFieldsValueResponse1TypedDict]] + direction: NotRequired[FieldCreateDocumentFieldsDirectionResponse1] class FieldCreateDocumentFieldsFieldMetaRadioResponse(BaseModel): @@ -1165,8 +1338,14 @@ class FieldCreateDocumentFieldsFieldMetaRadioResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateDocumentFieldsValueResponse1]] = None + direction: Optional[FieldCreateDocumentFieldsDirectionResponse1] = ( + FieldCreateDocumentFieldsDirectionResponse1.VERTICAL + ) + class FieldCreateDocumentFieldsFieldMetaTypeNumber(str, Enum): NUMBER = "number" @@ -1178,18 +1357,29 @@ class FieldCreateDocumentFieldsTextAlignResponse6(str, Enum): RIGHT = "right" +class FieldCreateDocumentFieldsVerticalAlignResponse2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateDocumentFieldsFieldMetaNumberResponseTypedDict(TypedDict): type: FieldCreateDocumentFieldsFieldMetaTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldCreateDocumentFieldsTextAlignResponse6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldCreateDocumentFieldsVerticalAlignResponse2] + ] class FieldCreateDocumentFieldsFieldMetaNumberResponse(BaseModel): @@ -1203,21 +1393,91 @@ class FieldCreateDocumentFieldsFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldCreateDocumentFieldsTextAlignResponse6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateDocumentFieldsVerticalAlignResponse2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -1229,16 +1489,27 @@ class FieldCreateDocumentFieldsTextAlignResponse5(str, Enum): RIGHT = "right" +class FieldCreateDocumentFieldsVerticalAlignResponse1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateDocumentFieldsFieldMetaTextResponseTypedDict(TypedDict): type: FieldCreateDocumentFieldsFieldMetaTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldCreateDocumentFieldsTextAlignResponse5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldCreateDocumentFieldsVerticalAlignResponse1] + ] class FieldCreateDocumentFieldsFieldMetaTextResponse(BaseModel): @@ -1252,19 +1523,74 @@ class FieldCreateDocumentFieldsFieldMetaTextResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldCreateDocumentFieldsTextAlignResponse5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateDocumentFieldsVerticalAlignResponse1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldCreateDocumentFieldsFieldMetaTypeDate(str, Enum): DATE = "date" @@ -1297,7 +1623,7 @@ class FieldCreateDocumentFieldsFieldMetaDateResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldsTextAlignResponse4], @@ -1336,7 +1662,7 @@ class FieldCreateDocumentFieldsFieldMetaEmailResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldsTextAlignResponse3], @@ -1375,7 +1701,7 @@ class FieldCreateDocumentFieldsFieldMetaNameResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldsTextAlignResponse2], @@ -1414,7 +1740,7 @@ class FieldCreateDocumentFieldsFieldMetaInitialsResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateDocumentFieldsTextAlignResponse1], @@ -1422,14 +1748,42 @@ class FieldCreateDocumentFieldsFieldMetaInitialsResponse(BaseModel): ] = None +class FieldCreateDocumentFieldsFieldMetaTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldCreateDocumentFieldsFieldMetaSignatureResponseTypedDict(TypedDict): + type: FieldCreateDocumentFieldsFieldMetaTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldCreateDocumentFieldsFieldMetaSignatureResponse(BaseModel): + type: FieldCreateDocumentFieldsFieldMetaTypeSignature + + 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")] = 12 + + FieldCreateDocumentFieldsFieldMetaUnionTypedDict = TypeAliasType( "FieldCreateDocumentFieldsFieldMetaUnionTypedDict", Union[ - FieldCreateDocumentFieldsFieldMetaRadioResponseTypedDict, + FieldCreateDocumentFieldsFieldMetaSignatureResponseTypedDict, FieldCreateDocumentFieldsFieldMetaInitialsResponseTypedDict, FieldCreateDocumentFieldsFieldMetaNameResponseTypedDict, FieldCreateDocumentFieldsFieldMetaEmailResponseTypedDict, FieldCreateDocumentFieldsFieldMetaDateResponseTypedDict, + FieldCreateDocumentFieldsFieldMetaRadioResponseTypedDict, FieldCreateDocumentFieldsFieldMetaDropdownResponseTypedDict, FieldCreateDocumentFieldsFieldMetaCheckboxResponseTypedDict, FieldCreateDocumentFieldsFieldMetaTextResponseTypedDict, @@ -1441,11 +1795,12 @@ class FieldCreateDocumentFieldsFieldMetaInitialsResponse(BaseModel): FieldCreateDocumentFieldsFieldMetaUnion = TypeAliasType( "FieldCreateDocumentFieldsFieldMetaUnion", Union[ - FieldCreateDocumentFieldsFieldMetaRadioResponse, + FieldCreateDocumentFieldsFieldMetaSignatureResponse, FieldCreateDocumentFieldsFieldMetaInitialsResponse, FieldCreateDocumentFieldsFieldMetaNameResponse, FieldCreateDocumentFieldsFieldMetaEmailResponse, FieldCreateDocumentFieldsFieldMetaDateResponse, + FieldCreateDocumentFieldsFieldMetaRadioResponse, FieldCreateDocumentFieldsFieldMetaDropdownResponse, FieldCreateDocumentFieldsFieldMetaCheckboxResponse, FieldCreateDocumentFieldsFieldMetaTextResponse, @@ -1455,38 +1810,46 @@ class FieldCreateDocumentFieldsFieldMetaInitialsResponse(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[FieldCreateDocumentFieldsFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -1497,18 +1860,18 @@ class FieldCreateDocumentFieldsFieldResponse(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["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..95b90b5 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 @@ -33,6 +40,7 @@ class FieldCreateTemplateFieldFieldMetaDropdownRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldValueDropdownTypedDict]] default_value: NotRequired[str] @@ -48,6 +56,8 @@ class FieldCreateTemplateFieldFieldMetaDropdownRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldValueDropdown]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -56,17 +66,11 @@ class FieldCreateTemplateFieldFieldMetaDropdownRequest(BaseModel): class FieldCreateTemplateFieldFieldDropdownTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeDropdownRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldFieldMetaDropdownRequestTypedDict] @@ -74,22 +78,16 @@ class FieldCreateTemplateFieldFieldDropdown(BaseModel): type: FieldCreateTemplateFieldTypeDropdownRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldFieldMetaDropdownRequest], @@ -119,15 +117,22 @@ class FieldCreateTemplateFieldValueCheckbox(BaseModel): value: str +class FieldCreateTemplateFieldDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeCheckboxRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateTemplateFieldDirectionCheckbox] class FieldCreateTemplateFieldFieldMetaCheckboxRequest(BaseModel): @@ -141,6 +146,8 @@ class FieldCreateTemplateFieldFieldMetaCheckboxRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldValueCheckbox]] = None validation_rule: Annotated[ @@ -151,21 +158,19 @@ class FieldCreateTemplateFieldFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateTemplateFieldDirectionCheckbox] = ( + FieldCreateTemplateFieldDirectionCheckbox.VERTICAL + ) + class FieldCreateTemplateFieldFieldCheckboxTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeCheckboxRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldFieldMetaCheckboxRequestTypedDict] @@ -173,22 +178,16 @@ class FieldCreateTemplateFieldFieldCheckbox(BaseModel): type: FieldCreateTemplateFieldTypeCheckboxRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldFieldMetaCheckboxRequest], @@ -218,13 +217,20 @@ class FieldCreateTemplateFieldValueRadio(BaseModel): value: str +class FieldCreateTemplateFieldDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldFieldMetaRadioRequestTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeRadioRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldValueRadioTypedDict]] + direction: NotRequired[FieldCreateTemplateFieldDirectionRadio] class FieldCreateTemplateFieldFieldMetaRadioRequest(BaseModel): @@ -238,23 +244,23 @@ class FieldCreateTemplateFieldFieldMetaRadioRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldValueRadio]] = None + direction: Optional[FieldCreateTemplateFieldDirectionRadio] = ( + FieldCreateTemplateFieldDirectionRadio.VERTICAL + ) + class FieldCreateTemplateFieldFieldRadioTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeRadioRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldFieldMetaRadioRequestTypedDict] @@ -262,22 +268,16 @@ class FieldCreateTemplateFieldFieldRadio(BaseModel): type: FieldCreateTemplateFieldTypeRadioRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldFieldMetaRadioRequest], @@ -299,18 +299,27 @@ class FieldCreateTemplateFieldTextAlignNumber(str, Enum): RIGHT = "right" +class FieldCreateTemplateFieldVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateTemplateFieldFieldMetaNumberRequestTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeNumberRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldCreateTemplateFieldTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldCreateTemplateFieldVerticalAlignNumber]] class FieldCreateTemplateFieldFieldMetaNumberRequest(BaseModel): @@ -324,36 +333,100 @@ class FieldCreateTemplateFieldFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldCreateTemplateFieldTextAlignNumber], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateTemplateFieldVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldFieldMetaNumberRequestTypedDict] @@ -361,22 +434,16 @@ class FieldCreateTemplateFieldFieldNumber(BaseModel): type: FieldCreateTemplateFieldTypeNumberRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldFieldMetaNumberRequest], @@ -398,16 +465,25 @@ class FieldCreateTemplateFieldTextAlignText(str, Enum): RIGHT = "right" +class FieldCreateTemplateFieldVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateTemplateFieldFieldMetaTextRequestTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeTextRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldCreateTemplateFieldTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldCreateTemplateFieldVerticalAlignText]] class FieldCreateTemplateFieldFieldMetaTextRequest(BaseModel): @@ -421,34 +497,83 @@ class FieldCreateTemplateFieldFieldMetaTextRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldCreateTemplateFieldTextAlignText], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateTemplateFieldVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldCreateTemplateFieldFieldTextTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeTextRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldFieldMetaTextRequestTypedDict] @@ -456,22 +581,16 @@ class FieldCreateTemplateFieldFieldText(BaseModel): type: FieldCreateTemplateFieldTypeTextRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldFieldMetaTextRequest], @@ -514,7 +633,7 @@ class FieldCreateTemplateFieldFieldMetaDateRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldTextAlignDate], @@ -525,17 +644,11 @@ class FieldCreateTemplateFieldFieldMetaDateRequest(BaseModel): class FieldCreateTemplateFieldFieldDateTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeDateRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldFieldMetaDateRequestTypedDict] @@ -543,22 +656,16 @@ class FieldCreateTemplateFieldFieldDate(BaseModel): type: FieldCreateTemplateFieldTypeDateRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldFieldMetaDateRequest], @@ -601,7 +708,7 @@ class FieldCreateTemplateFieldFieldMetaEmailRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldTextAlignEmail], @@ -612,17 +719,11 @@ class FieldCreateTemplateFieldFieldMetaEmailRequest(BaseModel): class FieldCreateTemplateFieldFieldEmailTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeEmailRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldFieldMetaEmailRequestTypedDict] @@ -630,22 +731,16 @@ class FieldCreateTemplateFieldFieldEmail(BaseModel): type: FieldCreateTemplateFieldTypeEmailRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldFieldMetaEmailRequest], @@ -688,7 +783,7 @@ class FieldCreateTemplateFieldFieldMetaNameRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldTextAlignName], @@ -699,17 +794,11 @@ class FieldCreateTemplateFieldFieldMetaNameRequest(BaseModel): class FieldCreateTemplateFieldFieldNameTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeNameRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldFieldMetaNameRequestTypedDict] @@ -717,22 +806,16 @@ class FieldCreateTemplateFieldFieldName(BaseModel): type: FieldCreateTemplateFieldTypeNameRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldFieldMetaNameRequest], @@ -775,7 +858,7 @@ class FieldCreateTemplateFieldFieldMetaInitialsRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldTextAlignInitials], @@ -786,17 +869,11 @@ class FieldCreateTemplateFieldFieldMetaInitialsRequest(BaseModel): class FieldCreateTemplateFieldFieldInitialsTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeInitialsRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldFieldMetaInitialsRequestTypedDict] @@ -804,22 +881,16 @@ class FieldCreateTemplateFieldFieldInitials(BaseModel): type: FieldCreateTemplateFieldTypeInitialsRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldFieldMetaInitialsRequest], @@ -834,88 +905,97 @@ class FieldCreateTemplateFieldTypeFreeSignature(str, Enum): class FieldCreateTemplateFieldFieldFreeSignatureTypedDict(TypedDict): type: FieldCreateTemplateFieldTypeFreeSignature recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" class FieldCreateTemplateFieldFieldFreeSignature(BaseModel): type: FieldCreateTemplateFieldTypeFreeSignature recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" -class FieldCreateTemplateFieldTypeSignature(str, Enum): +class FieldCreateTemplateFieldTypeSignatureRequest1(str, Enum): SIGNATURE = "SIGNATURE" +class FieldCreateTemplateFieldTypeSignatureRequest2(str, Enum): + SIGNATURE = "signature" + + +class FieldCreateTemplateFieldFieldMetaSignatureRequestTypedDict(TypedDict): + type: FieldCreateTemplateFieldTypeSignatureRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldCreateTemplateFieldFieldMetaSignatureRequest(BaseModel): + type: FieldCreateTemplateFieldTypeSignatureRequest2 + + 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")] = 12 + + class FieldCreateTemplateFieldFieldSignatureTypedDict(TypedDict): - type: FieldCreateTemplateFieldTypeSignature + type: FieldCreateTemplateFieldTypeSignatureRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" + field_meta: NotRequired[FieldCreateTemplateFieldFieldMetaSignatureRequestTypedDict] class FieldCreateTemplateFieldFieldSignature(BaseModel): - type: FieldCreateTemplateFieldTypeSignature + type: FieldCreateTemplateFieldTypeSignatureRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" + + field_meta: Annotated[ + Optional[FieldCreateTemplateFieldFieldMetaSignatureRequest], + pydantic.Field(alias="fieldMeta"), + ] = None FieldCreateTemplateFieldFieldUnionTypedDict = TypeAliasType( "FieldCreateTemplateFieldFieldUnionTypedDict", Union[ - FieldCreateTemplateFieldFieldSignatureTypedDict, FieldCreateTemplateFieldFieldFreeSignatureTypedDict, + FieldCreateTemplateFieldFieldSignatureTypedDict, FieldCreateTemplateFieldFieldInitialsTypedDict, FieldCreateTemplateFieldFieldNameTypedDict, FieldCreateTemplateFieldFieldEmailTypedDict, @@ -932,8 +1012,8 @@ class FieldCreateTemplateFieldFieldSignature(BaseModel): FieldCreateTemplateFieldFieldUnion = TypeAliasType( "FieldCreateTemplateFieldFieldUnion", Union[ - FieldCreateTemplateFieldFieldSignature, FieldCreateTemplateFieldFieldFreeSignature, + FieldCreateTemplateFieldFieldSignature, FieldCreateTemplateFieldFieldInitials, FieldCreateTemplateFieldFieldName, FieldCreateTemplateFieldFieldEmail, @@ -974,10 +1054,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 +1069,75 @@ 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 FieldCreateTemplateFieldForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldCreateTemplateFieldForbiddenIssue(BaseModel): + message: str + + +class FieldCreateTemplateFieldForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldCreateTemplateFieldForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldCreateTemplateFieldForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldCreateTemplateFieldForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldCreateTemplateFieldForbiddenErrorData, + 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 FieldCreateTemplateFieldUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldCreateTemplateFieldUnauthorizedIssue(BaseModel): + message: str + + +class FieldCreateTemplateFieldUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldCreateTemplateFieldUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldCreateTemplateFieldUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldCreateTemplateFieldUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldCreateTemplateFieldUnauthorizedErrorData, + 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 FieldCreateTemplateFieldBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1156,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 +1171,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): @@ -1056,6 +1206,7 @@ class FieldCreateTemplateFieldFieldMetaDropdownResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldValueResponse3TypedDict]] default_value: NotRequired[str] @@ -1071,6 +1222,8 @@ class FieldCreateTemplateFieldFieldMetaDropdownResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldValueResponse3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -1094,15 +1247,22 @@ class FieldCreateTemplateFieldValueResponse2(BaseModel): value: str +class FieldCreateTemplateFieldDirectionResponse2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldCreateTemplateFieldFieldMetaTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateTemplateFieldDirectionResponse2] class FieldCreateTemplateFieldFieldMetaCheckboxResponse(BaseModel): @@ -1116,6 +1276,8 @@ class FieldCreateTemplateFieldFieldMetaCheckboxResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldValueResponse2]] = None validation_rule: Annotated[ @@ -1126,6 +1288,10 @@ class FieldCreateTemplateFieldFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateTemplateFieldDirectionResponse2] = ( + FieldCreateTemplateFieldDirectionResponse2.VERTICAL + ) + class FieldCreateTemplateFieldFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1145,13 +1311,20 @@ class FieldCreateTemplateFieldValueResponse1(BaseModel): value: str +class FieldCreateTemplateFieldDirectionResponse1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldFieldMetaRadioResponseTypedDict(TypedDict): type: FieldCreateTemplateFieldFieldMetaTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldValueResponse1TypedDict]] + direction: NotRequired[FieldCreateTemplateFieldDirectionResponse1] class FieldCreateTemplateFieldFieldMetaRadioResponse(BaseModel): @@ -1165,8 +1338,14 @@ class FieldCreateTemplateFieldFieldMetaRadioResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldValueResponse1]] = None + direction: Optional[FieldCreateTemplateFieldDirectionResponse1] = ( + FieldCreateTemplateFieldDirectionResponse1.VERTICAL + ) + class FieldCreateTemplateFieldFieldMetaTypeNumber(str, Enum): NUMBER = "number" @@ -1178,18 +1357,29 @@ class FieldCreateTemplateFieldTextAlignResponse6(str, Enum): RIGHT = "right" +class FieldCreateTemplateFieldVerticalAlignResponse2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateTemplateFieldFieldMetaNumberResponseTypedDict(TypedDict): type: FieldCreateTemplateFieldFieldMetaTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldCreateTemplateFieldTextAlignResponse6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldCreateTemplateFieldVerticalAlignResponse2] + ] class FieldCreateTemplateFieldFieldMetaNumberResponse(BaseModel): @@ -1203,21 +1393,91 @@ class FieldCreateTemplateFieldFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldCreateTemplateFieldTextAlignResponse6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateTemplateFieldVerticalAlignResponse2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -1229,16 +1489,27 @@ class FieldCreateTemplateFieldTextAlignResponse5(str, Enum): RIGHT = "right" +class FieldCreateTemplateFieldVerticalAlignResponse1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateTemplateFieldFieldMetaTextResponseTypedDict(TypedDict): type: FieldCreateTemplateFieldFieldMetaTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldCreateTemplateFieldTextAlignResponse5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldCreateTemplateFieldVerticalAlignResponse1] + ] class FieldCreateTemplateFieldFieldMetaTextResponse(BaseModel): @@ -1252,19 +1523,74 @@ class FieldCreateTemplateFieldFieldMetaTextResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldCreateTemplateFieldTextAlignResponse5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateTemplateFieldVerticalAlignResponse1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldCreateTemplateFieldFieldMetaTypeDate(str, Enum): DATE = "date" @@ -1297,7 +1623,7 @@ class FieldCreateTemplateFieldFieldMetaDateResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldTextAlignResponse4], @@ -1336,7 +1662,7 @@ class FieldCreateTemplateFieldFieldMetaEmailResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldTextAlignResponse3], @@ -1375,7 +1701,7 @@ class FieldCreateTemplateFieldFieldMetaNameResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldTextAlignResponse2], @@ -1414,7 +1740,7 @@ class FieldCreateTemplateFieldFieldMetaInitialsResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldTextAlignResponse1], @@ -1422,14 +1748,42 @@ class FieldCreateTemplateFieldFieldMetaInitialsResponse(BaseModel): ] = None +class FieldCreateTemplateFieldFieldMetaTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldCreateTemplateFieldFieldMetaSignatureResponseTypedDict(TypedDict): + type: FieldCreateTemplateFieldFieldMetaTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldCreateTemplateFieldFieldMetaSignatureResponse(BaseModel): + type: FieldCreateTemplateFieldFieldMetaTypeSignature + + 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")] = 12 + + FieldCreateTemplateFieldFieldMetaUnionTypedDict = TypeAliasType( "FieldCreateTemplateFieldFieldMetaUnionTypedDict", Union[ - FieldCreateTemplateFieldFieldMetaRadioResponseTypedDict, + FieldCreateTemplateFieldFieldMetaSignatureResponseTypedDict, FieldCreateTemplateFieldFieldMetaInitialsResponseTypedDict, FieldCreateTemplateFieldFieldMetaNameResponseTypedDict, FieldCreateTemplateFieldFieldMetaEmailResponseTypedDict, FieldCreateTemplateFieldFieldMetaDateResponseTypedDict, + FieldCreateTemplateFieldFieldMetaRadioResponseTypedDict, FieldCreateTemplateFieldFieldMetaDropdownResponseTypedDict, FieldCreateTemplateFieldFieldMetaCheckboxResponseTypedDict, FieldCreateTemplateFieldFieldMetaTextResponseTypedDict, @@ -1441,11 +1795,12 @@ class FieldCreateTemplateFieldFieldMetaInitialsResponse(BaseModel): FieldCreateTemplateFieldFieldMetaUnion = TypeAliasType( "FieldCreateTemplateFieldFieldMetaUnion", Union[ - FieldCreateTemplateFieldFieldMetaRadioResponse, + FieldCreateTemplateFieldFieldMetaSignatureResponse, FieldCreateTemplateFieldFieldMetaInitialsResponse, FieldCreateTemplateFieldFieldMetaNameResponse, FieldCreateTemplateFieldFieldMetaEmailResponse, FieldCreateTemplateFieldFieldMetaDateResponse, + FieldCreateTemplateFieldFieldMetaRadioResponse, FieldCreateTemplateFieldFieldMetaDropdownResponse, FieldCreateTemplateFieldFieldMetaCheckboxResponse, FieldCreateTemplateFieldFieldMetaTextResponse, @@ -1457,40 +1812,48 @@ 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[FieldCreateTemplateFieldFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -1501,18 +1864,18 @@ class FieldCreateTemplateFieldResponse(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["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..f325456 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 @@ -33,6 +40,7 @@ class FieldCreateTemplateFieldsFieldMetaDropdownRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldsValueDropdownTypedDict]] default_value: NotRequired[str] @@ -48,6 +56,8 @@ class FieldCreateTemplateFieldsFieldMetaDropdownRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldsValueDropdown]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -56,17 +66,11 @@ class FieldCreateTemplateFieldsFieldMetaDropdownRequest(BaseModel): class FieldCreateTemplateFieldsFieldDropdownTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeDropdownRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldsFieldMetaDropdownRequestTypedDict] @@ -74,22 +78,16 @@ class FieldCreateTemplateFieldsFieldDropdown(BaseModel): type: FieldCreateTemplateFieldsTypeDropdownRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldsFieldMetaDropdownRequest], @@ -119,15 +117,22 @@ class FieldCreateTemplateFieldsValueCheckbox(BaseModel): value: str +class FieldCreateTemplateFieldsDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeCheckboxRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldsValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateTemplateFieldsDirectionCheckbox] class FieldCreateTemplateFieldsFieldMetaCheckboxRequest(BaseModel): @@ -141,6 +146,8 @@ class FieldCreateTemplateFieldsFieldMetaCheckboxRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldsValueCheckbox]] = None validation_rule: Annotated[ @@ -151,21 +158,19 @@ class FieldCreateTemplateFieldsFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateTemplateFieldsDirectionCheckbox] = ( + FieldCreateTemplateFieldsDirectionCheckbox.VERTICAL + ) + class FieldCreateTemplateFieldsFieldCheckboxTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeCheckboxRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldsFieldMetaCheckboxRequestTypedDict] @@ -173,22 +178,16 @@ class FieldCreateTemplateFieldsFieldCheckbox(BaseModel): type: FieldCreateTemplateFieldsTypeCheckboxRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldsFieldMetaCheckboxRequest], @@ -218,13 +217,20 @@ class FieldCreateTemplateFieldsValueRadio(BaseModel): value: str +class FieldCreateTemplateFieldsDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldsFieldMetaRadioRequestTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeRadioRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldsValueRadioTypedDict]] + direction: NotRequired[FieldCreateTemplateFieldsDirectionRadio] class FieldCreateTemplateFieldsFieldMetaRadioRequest(BaseModel): @@ -238,23 +244,23 @@ class FieldCreateTemplateFieldsFieldMetaRadioRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldsValueRadio]] = None + direction: Optional[FieldCreateTemplateFieldsDirectionRadio] = ( + FieldCreateTemplateFieldsDirectionRadio.VERTICAL + ) + class FieldCreateTemplateFieldsFieldRadioTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeRadioRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldsFieldMetaRadioRequestTypedDict] @@ -262,22 +268,16 @@ class FieldCreateTemplateFieldsFieldRadio(BaseModel): type: FieldCreateTemplateFieldsTypeRadioRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldsFieldMetaRadioRequest], @@ -299,18 +299,27 @@ class FieldCreateTemplateFieldsTextAlignNumber(str, Enum): RIGHT = "right" +class FieldCreateTemplateFieldsVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateTemplateFieldsFieldMetaNumberRequestTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeNumberRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldCreateTemplateFieldsTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldCreateTemplateFieldsVerticalAlignNumber]] class FieldCreateTemplateFieldsFieldMetaNumberRequest(BaseModel): @@ -324,36 +333,100 @@ class FieldCreateTemplateFieldsFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldCreateTemplateFieldsTextAlignNumber], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateTemplateFieldsVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldsFieldMetaNumberRequestTypedDict] @@ -361,22 +434,16 @@ class FieldCreateTemplateFieldsFieldNumber(BaseModel): type: FieldCreateTemplateFieldsTypeNumberRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldsFieldMetaNumberRequest], @@ -398,16 +465,25 @@ class FieldCreateTemplateFieldsTextAlignText(str, Enum): RIGHT = "right" +class FieldCreateTemplateFieldsVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateTemplateFieldsFieldMetaTextRequestTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeTextRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldCreateTemplateFieldsTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldCreateTemplateFieldsVerticalAlignText]] class FieldCreateTemplateFieldsFieldMetaTextRequest(BaseModel): @@ -421,34 +497,83 @@ class FieldCreateTemplateFieldsFieldMetaTextRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldCreateTemplateFieldsTextAlignText], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateTemplateFieldsVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldCreateTemplateFieldsFieldTextTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeTextRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldsFieldMetaTextRequestTypedDict] @@ -456,22 +581,16 @@ class FieldCreateTemplateFieldsFieldText(BaseModel): type: FieldCreateTemplateFieldsTypeTextRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldsFieldMetaTextRequest], @@ -514,7 +633,7 @@ class FieldCreateTemplateFieldsFieldMetaDateRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldsTextAlignDate], @@ -525,17 +644,11 @@ class FieldCreateTemplateFieldsFieldMetaDateRequest(BaseModel): class FieldCreateTemplateFieldsFieldDateTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeDateRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldsFieldMetaDateRequestTypedDict] @@ -543,22 +656,16 @@ class FieldCreateTemplateFieldsFieldDate(BaseModel): type: FieldCreateTemplateFieldsTypeDateRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldsFieldMetaDateRequest], @@ -601,7 +708,7 @@ class FieldCreateTemplateFieldsFieldMetaEmailRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldsTextAlignEmail], @@ -612,17 +719,11 @@ class FieldCreateTemplateFieldsFieldMetaEmailRequest(BaseModel): class FieldCreateTemplateFieldsFieldEmailTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeEmailRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldsFieldMetaEmailRequestTypedDict] @@ -630,22 +731,16 @@ class FieldCreateTemplateFieldsFieldEmail(BaseModel): type: FieldCreateTemplateFieldsTypeEmailRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldsFieldMetaEmailRequest], @@ -688,7 +783,7 @@ class FieldCreateTemplateFieldsFieldMetaNameRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldsTextAlignName], @@ -699,17 +794,11 @@ class FieldCreateTemplateFieldsFieldMetaNameRequest(BaseModel): class FieldCreateTemplateFieldsFieldNameTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeNameRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldsFieldMetaNameRequestTypedDict] @@ -717,22 +806,16 @@ class FieldCreateTemplateFieldsFieldName(BaseModel): type: FieldCreateTemplateFieldsTypeNameRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldsFieldMetaNameRequest], @@ -775,7 +858,7 @@ class FieldCreateTemplateFieldsFieldMetaInitialsRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldsTextAlignInitials], @@ -786,17 +869,11 @@ class FieldCreateTemplateFieldsFieldMetaInitialsRequest(BaseModel): class FieldCreateTemplateFieldsFieldInitialsTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeInitialsRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: NotRequired[FieldCreateTemplateFieldsFieldMetaInitialsRequestTypedDict] @@ -804,22 +881,16 @@ class FieldCreateTemplateFieldsFieldInitials(BaseModel): type: FieldCreateTemplateFieldsTypeInitialsRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" field_meta: Annotated[ Optional[FieldCreateTemplateFieldsFieldMetaInitialsRequest], @@ -834,88 +905,97 @@ class FieldCreateTemplateFieldsTypeFreeSignature(str, Enum): class FieldCreateTemplateFieldsFieldFreeSignatureTypedDict(TypedDict): type: FieldCreateTemplateFieldsTypeFreeSignature recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" class FieldCreateTemplateFieldsFieldFreeSignature(BaseModel): type: FieldCreateTemplateFieldsTypeFreeSignature recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" -class FieldCreateTemplateFieldsTypeSignature(str, Enum): +class FieldCreateTemplateFieldsTypeSignatureRequest1(str, Enum): SIGNATURE = "SIGNATURE" +class FieldCreateTemplateFieldsTypeSignatureRequest2(str, Enum): + SIGNATURE = "signature" + + +class FieldCreateTemplateFieldsFieldMetaSignatureRequestTypedDict(TypedDict): + type: FieldCreateTemplateFieldsTypeSignatureRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldCreateTemplateFieldsFieldMetaSignatureRequest(BaseModel): + type: FieldCreateTemplateFieldsTypeSignatureRequest2 + + 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")] = 12 + + class FieldCreateTemplateFieldsFieldSignatureTypedDict(TypedDict): - type: FieldCreateTemplateFieldsTypeSignature + type: FieldCreateTemplateFieldsTypeSignatureRequest1 recipient_id: float - r"""The ID of the recipient to create the field for.""" page_number: float - r"""The page number the field will be on.""" page_x: float - r"""The X coordinate of where the field will be placed.""" page_y: float - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" + field_meta: NotRequired[FieldCreateTemplateFieldsFieldMetaSignatureRequestTypedDict] class FieldCreateTemplateFieldsFieldSignature(BaseModel): - type: FieldCreateTemplateFieldsTypeSignature + type: FieldCreateTemplateFieldsTypeSignatureRequest1 recipient_id: Annotated[float, pydantic.Field(alias="recipientId")] - r"""The ID of the recipient to create the field for.""" page_number: Annotated[float, pydantic.Field(alias="pageNumber")] - r"""The page number the field will be on.""" page_x: Annotated[float, pydantic.Field(alias="pageX")] - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[float, pydantic.Field(alias="pageY")] - r"""The Y coordinate of where the field will be placed.""" width: float - r"""The width of the field.""" height: float - r"""The height of the field.""" + + field_meta: Annotated[ + Optional[FieldCreateTemplateFieldsFieldMetaSignatureRequest], + pydantic.Field(alias="fieldMeta"), + ] = None FieldCreateTemplateFieldsFieldUnionTypedDict = TypeAliasType( "FieldCreateTemplateFieldsFieldUnionTypedDict", Union[ - FieldCreateTemplateFieldsFieldSignatureTypedDict, FieldCreateTemplateFieldsFieldFreeSignatureTypedDict, + FieldCreateTemplateFieldsFieldSignatureTypedDict, FieldCreateTemplateFieldsFieldInitialsTypedDict, FieldCreateTemplateFieldsFieldNameTypedDict, FieldCreateTemplateFieldsFieldEmailTypedDict, @@ -932,8 +1012,8 @@ class FieldCreateTemplateFieldsFieldSignature(BaseModel): FieldCreateTemplateFieldsFieldUnion = TypeAliasType( "FieldCreateTemplateFieldsFieldUnion", Union[ - FieldCreateTemplateFieldsFieldSignature, FieldCreateTemplateFieldsFieldFreeSignature, + FieldCreateTemplateFieldsFieldSignature, FieldCreateTemplateFieldsFieldInitials, FieldCreateTemplateFieldsFieldName, FieldCreateTemplateFieldsFieldEmail, @@ -974,10 +1054,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 +1069,75 @@ 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 FieldCreateTemplateFieldsForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldCreateTemplateFieldsForbiddenIssue(BaseModel): + message: str + + +class FieldCreateTemplateFieldsForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldCreateTemplateFieldsForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldCreateTemplateFieldsForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldCreateTemplateFieldsForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldCreateTemplateFieldsForbiddenErrorData, + 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 FieldCreateTemplateFieldsUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldCreateTemplateFieldsUnauthorizedIssue(BaseModel): + message: str + + +class FieldCreateTemplateFieldsUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldCreateTemplateFieldsUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldCreateTemplateFieldsUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldCreateTemplateFieldsUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldCreateTemplateFieldsUnauthorizedErrorData, + 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 FieldCreateTemplateFieldsBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1156,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 +1171,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): @@ -1056,6 +1206,7 @@ class FieldCreateTemplateFieldsFieldMetaDropdownResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldsValueResponse3TypedDict]] default_value: NotRequired[str] @@ -1071,6 +1222,8 @@ class FieldCreateTemplateFieldsFieldMetaDropdownResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldsValueResponse3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -1094,15 +1247,22 @@ class FieldCreateTemplateFieldsValueResponse2(BaseModel): value: str +class FieldCreateTemplateFieldsDirectionResponse2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldCreateTemplateFieldsFieldMetaTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldsValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldCreateTemplateFieldsDirectionResponse2] class FieldCreateTemplateFieldsFieldMetaCheckboxResponse(BaseModel): @@ -1116,6 +1276,8 @@ class FieldCreateTemplateFieldsFieldMetaCheckboxResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldsValueResponse2]] = None validation_rule: Annotated[ @@ -1126,6 +1288,10 @@ class FieldCreateTemplateFieldsFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldCreateTemplateFieldsDirectionResponse2] = ( + FieldCreateTemplateFieldsDirectionResponse2.VERTICAL + ) + class FieldCreateTemplateFieldsFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1145,13 +1311,20 @@ class FieldCreateTemplateFieldsValueResponse1(BaseModel): value: str +class FieldCreateTemplateFieldsDirectionResponse1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldCreateTemplateFieldsFieldMetaRadioResponseTypedDict(TypedDict): type: FieldCreateTemplateFieldsFieldMetaTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldCreateTemplateFieldsValueResponse1TypedDict]] + direction: NotRequired[FieldCreateTemplateFieldsDirectionResponse1] class FieldCreateTemplateFieldsFieldMetaRadioResponse(BaseModel): @@ -1165,8 +1338,14 @@ class FieldCreateTemplateFieldsFieldMetaRadioResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldCreateTemplateFieldsValueResponse1]] = None + direction: Optional[FieldCreateTemplateFieldsDirectionResponse1] = ( + FieldCreateTemplateFieldsDirectionResponse1.VERTICAL + ) + class FieldCreateTemplateFieldsFieldMetaTypeNumber(str, Enum): NUMBER = "number" @@ -1178,18 +1357,29 @@ class FieldCreateTemplateFieldsTextAlignResponse6(str, Enum): RIGHT = "right" +class FieldCreateTemplateFieldsVerticalAlignResponse2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateTemplateFieldsFieldMetaNumberResponseTypedDict(TypedDict): type: FieldCreateTemplateFieldsFieldMetaTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldCreateTemplateFieldsTextAlignResponse6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldCreateTemplateFieldsVerticalAlignResponse2] + ] class FieldCreateTemplateFieldsFieldMetaNumberResponse(BaseModel): @@ -1203,21 +1393,91 @@ class FieldCreateTemplateFieldsFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldCreateTemplateFieldsTextAlignResponse6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateTemplateFieldsVerticalAlignResponse2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -1229,16 +1489,27 @@ class FieldCreateTemplateFieldsTextAlignResponse5(str, Enum): RIGHT = "right" +class FieldCreateTemplateFieldsVerticalAlignResponse1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldCreateTemplateFieldsFieldMetaTextResponseTypedDict(TypedDict): type: FieldCreateTemplateFieldsFieldMetaTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldCreateTemplateFieldsTextAlignResponse5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldCreateTemplateFieldsVerticalAlignResponse1] + ] class FieldCreateTemplateFieldsFieldMetaTextResponse(BaseModel): @@ -1252,19 +1523,74 @@ class FieldCreateTemplateFieldsFieldMetaTextResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldCreateTemplateFieldsTextAlignResponse5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldCreateTemplateFieldsVerticalAlignResponse1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldCreateTemplateFieldsFieldMetaTypeDate(str, Enum): DATE = "date" @@ -1297,7 +1623,7 @@ class FieldCreateTemplateFieldsFieldMetaDateResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldsTextAlignResponse4], @@ -1336,7 +1662,7 @@ class FieldCreateTemplateFieldsFieldMetaEmailResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldsTextAlignResponse3], @@ -1375,7 +1701,7 @@ class FieldCreateTemplateFieldsFieldMetaNameResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldsTextAlignResponse2], @@ -1414,7 +1740,7 @@ class FieldCreateTemplateFieldsFieldMetaInitialsResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldCreateTemplateFieldsTextAlignResponse1], @@ -1422,14 +1748,42 @@ class FieldCreateTemplateFieldsFieldMetaInitialsResponse(BaseModel): ] = None +class FieldCreateTemplateFieldsFieldMetaTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldCreateTemplateFieldsFieldMetaSignatureResponseTypedDict(TypedDict): + type: FieldCreateTemplateFieldsFieldMetaTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldCreateTemplateFieldsFieldMetaSignatureResponse(BaseModel): + type: FieldCreateTemplateFieldsFieldMetaTypeSignature + + 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")] = 12 + + FieldCreateTemplateFieldsFieldMetaUnionTypedDict = TypeAliasType( "FieldCreateTemplateFieldsFieldMetaUnionTypedDict", Union[ - FieldCreateTemplateFieldsFieldMetaRadioResponseTypedDict, + FieldCreateTemplateFieldsFieldMetaSignatureResponseTypedDict, FieldCreateTemplateFieldsFieldMetaInitialsResponseTypedDict, FieldCreateTemplateFieldsFieldMetaNameResponseTypedDict, FieldCreateTemplateFieldsFieldMetaEmailResponseTypedDict, FieldCreateTemplateFieldsFieldMetaDateResponseTypedDict, + FieldCreateTemplateFieldsFieldMetaRadioResponseTypedDict, FieldCreateTemplateFieldsFieldMetaDropdownResponseTypedDict, FieldCreateTemplateFieldsFieldMetaCheckboxResponseTypedDict, FieldCreateTemplateFieldsFieldMetaTextResponseTypedDict, @@ -1441,11 +1795,12 @@ class FieldCreateTemplateFieldsFieldMetaInitialsResponse(BaseModel): FieldCreateTemplateFieldsFieldMetaUnion = TypeAliasType( "FieldCreateTemplateFieldsFieldMetaUnion", Union[ - FieldCreateTemplateFieldsFieldMetaRadioResponse, + FieldCreateTemplateFieldsFieldMetaSignatureResponse, FieldCreateTemplateFieldsFieldMetaInitialsResponse, FieldCreateTemplateFieldsFieldMetaNameResponse, FieldCreateTemplateFieldsFieldMetaEmailResponse, FieldCreateTemplateFieldsFieldMetaDateResponse, + FieldCreateTemplateFieldsFieldMetaRadioResponse, FieldCreateTemplateFieldsFieldMetaDropdownResponse, FieldCreateTemplateFieldsFieldMetaCheckboxResponse, FieldCreateTemplateFieldsFieldMetaTextResponse, @@ -1455,38 +1810,46 @@ class FieldCreateTemplateFieldsFieldMetaInitialsResponse(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[FieldCreateTemplateFieldsFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -1497,18 +1860,18 @@ class FieldCreateTemplateFieldsFieldResponse(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["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..fefcbb7 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,75 @@ 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 FieldDeleteDocumentFieldForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldDeleteDocumentFieldForbiddenIssue(BaseModel): + message: str + + +class FieldDeleteDocumentFieldForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldDeleteDocumentFieldForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldDeleteDocumentFieldForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldDeleteDocumentFieldForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldDeleteDocumentFieldForbiddenErrorData, + 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 FieldDeleteDocumentFieldUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldDeleteDocumentFieldUnauthorizedIssue(BaseModel): + message: str + + +class FieldDeleteDocumentFieldUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldDeleteDocumentFieldUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldDeleteDocumentFieldUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldDeleteDocumentFieldUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldDeleteDocumentFieldUnauthorizedErrorData, + 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 FieldDeleteDocumentFieldBadRequestIssueTypedDict(TypedDict): @@ -66,10 +136,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 +151,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..0cc80d8 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,75 @@ 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 FieldDeleteTemplateFieldForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldDeleteTemplateFieldForbiddenIssue(BaseModel): + message: str + + +class FieldDeleteTemplateFieldForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldDeleteTemplateFieldForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldDeleteTemplateFieldForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldDeleteTemplateFieldForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldDeleteTemplateFieldForbiddenErrorData, + 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 FieldDeleteTemplateFieldUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldDeleteTemplateFieldUnauthorizedIssue(BaseModel): + message: str + + +class FieldDeleteTemplateFieldUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldDeleteTemplateFieldUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldDeleteTemplateFieldUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldDeleteTemplateFieldUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldDeleteTemplateFieldUnauthorizedErrorData, + 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 FieldDeleteTemplateFieldBadRequestIssueTypedDict(TypedDict): @@ -66,10 +136,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 +151,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..34f0db2 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,75 @@ 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 FieldGetDocumentFieldForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldGetDocumentFieldForbiddenIssue(BaseModel): + message: str + + +class FieldGetDocumentFieldForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldGetDocumentFieldForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldGetDocumentFieldForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldGetDocumentFieldForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldGetDocumentFieldForbiddenErrorData, + 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 FieldGetDocumentFieldUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldGetDocumentFieldUnauthorizedIssue(BaseModel): + message: str + + +class FieldGetDocumentFieldUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldGetDocumentFieldUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldGetDocumentFieldUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldGetDocumentFieldUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldGetDocumentFieldUnauthorizedErrorData, + 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 FieldGetDocumentFieldBadRequestIssueTypedDict(TypedDict): @@ -106,10 +183,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 +198,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): @@ -155,6 +233,7 @@ class FieldGetDocumentFieldFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldGetDocumentFieldValue3TypedDict]] default_value: NotRequired[str] @@ -170,6 +249,8 @@ class FieldGetDocumentFieldFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldGetDocumentFieldValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -193,15 +274,22 @@ class FieldGetDocumentFieldValue2(BaseModel): value: str +class FieldGetDocumentFieldDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldGetDocumentFieldFieldMetaCheckboxTypedDict(TypedDict): type: FieldGetDocumentFieldTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldGetDocumentFieldValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldGetDocumentFieldDirection2] class FieldGetDocumentFieldFieldMetaCheckbox(BaseModel): @@ -215,6 +303,8 @@ class FieldGetDocumentFieldFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldGetDocumentFieldValue2]] = None validation_rule: Annotated[ @@ -225,6 +315,10 @@ class FieldGetDocumentFieldFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldGetDocumentFieldDirection2] = ( + FieldGetDocumentFieldDirection2.VERTICAL + ) + class FieldGetDocumentFieldTypeRadio(str, Enum): RADIO = "radio" @@ -244,13 +338,20 @@ class FieldGetDocumentFieldValue1(BaseModel): value: str +class FieldGetDocumentFieldDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldGetDocumentFieldFieldMetaRadioTypedDict(TypedDict): type: FieldGetDocumentFieldTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldGetDocumentFieldValue1TypedDict]] + direction: NotRequired[FieldGetDocumentFieldDirection1] class FieldGetDocumentFieldFieldMetaRadio(BaseModel): @@ -264,8 +365,14 @@ class FieldGetDocumentFieldFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldGetDocumentFieldValue1]] = None + direction: Optional[FieldGetDocumentFieldDirection1] = ( + FieldGetDocumentFieldDirection1.VERTICAL + ) + class FieldGetDocumentFieldTypeNumber(str, Enum): NUMBER = "number" @@ -277,18 +384,27 @@ class FieldGetDocumentFieldTextAlign6(str, Enum): RIGHT = "right" +class FieldGetDocumentFieldVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldGetDocumentFieldFieldMetaNumberTypedDict(TypedDict): type: FieldGetDocumentFieldTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldGetDocumentFieldTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldGetDocumentFieldVerticalAlign2]] class FieldGetDocumentFieldFieldMetaNumber(BaseModel): @@ -302,20 +418,90 @@ class FieldGetDocumentFieldFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldGetDocumentFieldTextAlign6], pydantic.Field(alias="textAlign") ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldGetDocumentFieldVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -327,16 +513,25 @@ class FieldGetDocumentFieldTextAlign5(str, Enum): RIGHT = "right" +class FieldGetDocumentFieldVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldGetDocumentFieldFieldMetaTextTypedDict(TypedDict): type: FieldGetDocumentFieldTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldGetDocumentFieldTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldGetDocumentFieldVerticalAlign1]] class FieldGetDocumentFieldFieldMetaText(BaseModel): @@ -350,18 +545,73 @@ class FieldGetDocumentFieldFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldGetDocumentFieldTextAlign5], pydantic.Field(alias="textAlign") ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldGetDocumentFieldVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldGetDocumentFieldTypeDate(str, Enum): DATE = "date" @@ -394,7 +644,7 @@ class FieldGetDocumentFieldFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldGetDocumentFieldTextAlign4], pydantic.Field(alias="textAlign") @@ -432,7 +682,7 @@ class FieldGetDocumentFieldFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldGetDocumentFieldTextAlign3], pydantic.Field(alias="textAlign") @@ -470,7 +720,7 @@ class FieldGetDocumentFieldFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldGetDocumentFieldTextAlign2], pydantic.Field(alias="textAlign") @@ -508,21 +758,49 @@ class FieldGetDocumentFieldFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldGetDocumentFieldTextAlign1], pydantic.Field(alias="textAlign") ] = None +class FieldGetDocumentFieldTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldGetDocumentFieldFieldMetaSignatureTypedDict(TypedDict): + type: FieldGetDocumentFieldTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldGetDocumentFieldFieldMetaSignature(BaseModel): + type: FieldGetDocumentFieldTypeSignature + + 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")] = 12 + + FieldGetDocumentFieldFieldMetaUnionTypedDict = TypeAliasType( "FieldGetDocumentFieldFieldMetaUnionTypedDict", Union[ - FieldGetDocumentFieldFieldMetaRadioTypedDict, + FieldGetDocumentFieldFieldMetaSignatureTypedDict, FieldGetDocumentFieldFieldMetaInitialsTypedDict, FieldGetDocumentFieldFieldMetaNameTypedDict, FieldGetDocumentFieldFieldMetaEmailTypedDict, FieldGetDocumentFieldFieldMetaDateTypedDict, + FieldGetDocumentFieldFieldMetaRadioTypedDict, FieldGetDocumentFieldFieldMetaDropdownTypedDict, FieldGetDocumentFieldFieldMetaCheckboxTypedDict, FieldGetDocumentFieldFieldMetaTextTypedDict, @@ -534,11 +812,12 @@ class FieldGetDocumentFieldFieldMetaInitials(BaseModel): FieldGetDocumentFieldFieldMetaUnion = TypeAliasType( "FieldGetDocumentFieldFieldMetaUnion", Union[ - FieldGetDocumentFieldFieldMetaRadio, + FieldGetDocumentFieldFieldMetaSignature, FieldGetDocumentFieldFieldMetaInitials, FieldGetDocumentFieldFieldMetaName, FieldGetDocumentFieldFieldMetaEmail, FieldGetDocumentFieldFieldMetaDate, + FieldGetDocumentFieldFieldMetaRadio, FieldGetDocumentFieldFieldMetaDropdown, FieldGetDocumentFieldFieldMetaCheckbox, FieldGetDocumentFieldFieldMetaText, @@ -550,40 +829,48 @@ 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[FieldGetDocumentFieldFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -593,18 +880,18 @@ class FieldGetDocumentFieldResponse(BaseModel): Nullable[FieldGetDocumentFieldFieldMetaUnion], 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["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..7157c9b 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,75 @@ 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 FieldGetTemplateFieldForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldGetTemplateFieldForbiddenIssue(BaseModel): + message: str + + +class FieldGetTemplateFieldForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldGetTemplateFieldForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldGetTemplateFieldForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldGetTemplateFieldForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldGetTemplateFieldForbiddenErrorData, + 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 FieldGetTemplateFieldUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldGetTemplateFieldUnauthorizedIssue(BaseModel): + message: str + + +class FieldGetTemplateFieldUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldGetTemplateFieldUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldGetTemplateFieldUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldGetTemplateFieldUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldGetTemplateFieldUnauthorizedErrorData, + 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 FieldGetTemplateFieldBadRequestIssueTypedDict(TypedDict): @@ -106,10 +183,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 +198,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): @@ -155,6 +233,7 @@ class FieldGetTemplateFieldFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldGetTemplateFieldValue3TypedDict]] default_value: NotRequired[str] @@ -170,6 +249,8 @@ class FieldGetTemplateFieldFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldGetTemplateFieldValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -193,15 +274,22 @@ class FieldGetTemplateFieldValue2(BaseModel): value: str +class FieldGetTemplateFieldDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldGetTemplateFieldFieldMetaCheckboxTypedDict(TypedDict): type: FieldGetTemplateFieldTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldGetTemplateFieldValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldGetTemplateFieldDirection2] class FieldGetTemplateFieldFieldMetaCheckbox(BaseModel): @@ -215,6 +303,8 @@ class FieldGetTemplateFieldFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldGetTemplateFieldValue2]] = None validation_rule: Annotated[ @@ -225,6 +315,10 @@ class FieldGetTemplateFieldFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldGetTemplateFieldDirection2] = ( + FieldGetTemplateFieldDirection2.VERTICAL + ) + class FieldGetTemplateFieldTypeRadio(str, Enum): RADIO = "radio" @@ -244,13 +338,20 @@ class FieldGetTemplateFieldValue1(BaseModel): value: str +class FieldGetTemplateFieldDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldGetTemplateFieldFieldMetaRadioTypedDict(TypedDict): type: FieldGetTemplateFieldTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldGetTemplateFieldValue1TypedDict]] + direction: NotRequired[FieldGetTemplateFieldDirection1] class FieldGetTemplateFieldFieldMetaRadio(BaseModel): @@ -264,8 +365,14 @@ class FieldGetTemplateFieldFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldGetTemplateFieldValue1]] = None + direction: Optional[FieldGetTemplateFieldDirection1] = ( + FieldGetTemplateFieldDirection1.VERTICAL + ) + class FieldGetTemplateFieldTypeNumber(str, Enum): NUMBER = "number" @@ -277,18 +384,27 @@ class FieldGetTemplateFieldTextAlign6(str, Enum): RIGHT = "right" +class FieldGetTemplateFieldVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldGetTemplateFieldFieldMetaNumberTypedDict(TypedDict): type: FieldGetTemplateFieldTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldGetTemplateFieldTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldGetTemplateFieldVerticalAlign2]] class FieldGetTemplateFieldFieldMetaNumber(BaseModel): @@ -302,20 +418,90 @@ class FieldGetTemplateFieldFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldGetTemplateFieldTextAlign6], pydantic.Field(alias="textAlign") ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldGetTemplateFieldVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -327,16 +513,25 @@ class FieldGetTemplateFieldTextAlign5(str, Enum): RIGHT = "right" +class FieldGetTemplateFieldVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldGetTemplateFieldFieldMetaTextTypedDict(TypedDict): type: FieldGetTemplateFieldTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldGetTemplateFieldTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldGetTemplateFieldVerticalAlign1]] class FieldGetTemplateFieldFieldMetaText(BaseModel): @@ -350,18 +545,73 @@ class FieldGetTemplateFieldFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldGetTemplateFieldTextAlign5], pydantic.Field(alias="textAlign") ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldGetTemplateFieldVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldGetTemplateFieldTypeDate(str, Enum): DATE = "date" @@ -394,7 +644,7 @@ class FieldGetTemplateFieldFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldGetTemplateFieldTextAlign4], pydantic.Field(alias="textAlign") @@ -432,7 +682,7 @@ class FieldGetTemplateFieldFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldGetTemplateFieldTextAlign3], pydantic.Field(alias="textAlign") @@ -470,7 +720,7 @@ class FieldGetTemplateFieldFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldGetTemplateFieldTextAlign2], pydantic.Field(alias="textAlign") @@ -508,21 +758,49 @@ class FieldGetTemplateFieldFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldGetTemplateFieldTextAlign1], pydantic.Field(alias="textAlign") ] = None +class FieldGetTemplateFieldTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldGetTemplateFieldFieldMetaSignatureTypedDict(TypedDict): + type: FieldGetTemplateFieldTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldGetTemplateFieldFieldMetaSignature(BaseModel): + type: FieldGetTemplateFieldTypeSignature + + 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")] = 12 + + FieldGetTemplateFieldFieldMetaUnionTypedDict = TypeAliasType( "FieldGetTemplateFieldFieldMetaUnionTypedDict", Union[ - FieldGetTemplateFieldFieldMetaRadioTypedDict, + FieldGetTemplateFieldFieldMetaSignatureTypedDict, FieldGetTemplateFieldFieldMetaInitialsTypedDict, FieldGetTemplateFieldFieldMetaNameTypedDict, FieldGetTemplateFieldFieldMetaEmailTypedDict, FieldGetTemplateFieldFieldMetaDateTypedDict, + FieldGetTemplateFieldFieldMetaRadioTypedDict, FieldGetTemplateFieldFieldMetaDropdownTypedDict, FieldGetTemplateFieldFieldMetaCheckboxTypedDict, FieldGetTemplateFieldFieldMetaTextTypedDict, @@ -534,11 +812,12 @@ class FieldGetTemplateFieldFieldMetaInitials(BaseModel): FieldGetTemplateFieldFieldMetaUnion = TypeAliasType( "FieldGetTemplateFieldFieldMetaUnion", Union[ - FieldGetTemplateFieldFieldMetaRadio, + FieldGetTemplateFieldFieldMetaSignature, FieldGetTemplateFieldFieldMetaInitials, FieldGetTemplateFieldFieldMetaName, FieldGetTemplateFieldFieldMetaEmail, FieldGetTemplateFieldFieldMetaDate, + FieldGetTemplateFieldFieldMetaRadio, FieldGetTemplateFieldFieldMetaDropdown, FieldGetTemplateFieldFieldMetaCheckbox, FieldGetTemplateFieldFieldMetaText, @@ -550,40 +829,48 @@ 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[FieldGetTemplateFieldFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -593,18 +880,18 @@ class FieldGetTemplateFieldResponse(BaseModel): Nullable[FieldGetTemplateFieldFieldMetaUnion], 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["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..726c855 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 @@ -33,6 +40,7 @@ class FieldUpdateDocumentFieldFieldMetaDropdownRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldValueDropdownTypedDict]] default_value: NotRequired[str] @@ -48,6 +56,8 @@ class FieldUpdateDocumentFieldFieldMetaDropdownRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldValueDropdown]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -56,25 +66,18 @@ class FieldUpdateDocumentFieldFieldMetaDropdownRequest(BaseModel): class FieldUpdateDocumentFieldFieldDropdownTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeDropdownRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldFieldMetaDropdownRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldDropdown(BaseModel): type: FieldUpdateDocumentFieldTypeDropdownRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldFieldMetaDropdownRequest], @@ -82,19 +85,14 @@ class FieldUpdateDocumentFieldFieldDropdown(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldTypeCheckboxRequest1(str, Enum): @@ -119,15 +117,22 @@ class FieldUpdateDocumentFieldValueCheckbox(BaseModel): value: str +class FieldUpdateDocumentFieldDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeCheckboxRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateDocumentFieldDirectionCheckbox] class FieldUpdateDocumentFieldFieldMetaCheckboxRequest(BaseModel): @@ -141,6 +146,8 @@ class FieldUpdateDocumentFieldFieldMetaCheckboxRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldValueCheckbox]] = None validation_rule: Annotated[ @@ -151,29 +158,26 @@ class FieldUpdateDocumentFieldFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateDocumentFieldDirectionCheckbox] = ( + FieldUpdateDocumentFieldDirectionCheckbox.VERTICAL + ) + class FieldUpdateDocumentFieldFieldCheckboxTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeCheckboxRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldFieldMetaCheckboxRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldCheckbox(BaseModel): type: FieldUpdateDocumentFieldTypeCheckboxRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldFieldMetaCheckboxRequest], @@ -181,19 +185,14 @@ class FieldUpdateDocumentFieldFieldCheckbox(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldTypeRadioRequest1(str, Enum): @@ -218,13 +217,20 @@ class FieldUpdateDocumentFieldValueRadio(BaseModel): value: str +class FieldUpdateDocumentFieldDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldFieldMetaRadioRequestTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeRadioRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldValueRadioTypedDict]] + direction: NotRequired[FieldUpdateDocumentFieldDirectionRadio] class FieldUpdateDocumentFieldFieldMetaRadioRequest(BaseModel): @@ -238,31 +244,30 @@ class FieldUpdateDocumentFieldFieldMetaRadioRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldValueRadio]] = None + direction: Optional[FieldUpdateDocumentFieldDirectionRadio] = ( + FieldUpdateDocumentFieldDirectionRadio.VERTICAL + ) + class FieldUpdateDocumentFieldFieldRadioTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeRadioRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldFieldMetaRadioRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldRadio(BaseModel): type: FieldUpdateDocumentFieldTypeRadioRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldFieldMetaRadioRequest], @@ -270,19 +275,14 @@ class FieldUpdateDocumentFieldFieldRadio(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldTypeNumberRequest1(str, Enum): @@ -299,18 +299,27 @@ class FieldUpdateDocumentFieldTextAlignNumber(str, Enum): RIGHT = "right" +class FieldUpdateDocumentFieldVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateDocumentFieldFieldMetaNumberRequestTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeNumberRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldUpdateDocumentFieldTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldUpdateDocumentFieldVerticalAlignNumber]] class FieldUpdateDocumentFieldFieldMetaNumberRequest(BaseModel): @@ -324,44 +333,107 @@ class FieldUpdateDocumentFieldFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldUpdateDocumentFieldTextAlignNumber], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateDocumentFieldVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldFieldMetaNumberRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldNumber(BaseModel): type: FieldUpdateDocumentFieldTypeNumberRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldFieldMetaNumberRequest], @@ -369,19 +441,14 @@ class FieldUpdateDocumentFieldFieldNumber(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldTypeTextRequest1(str, Enum): @@ -398,16 +465,25 @@ class FieldUpdateDocumentFieldTextAlignText(str, Enum): RIGHT = "right" +class FieldUpdateDocumentFieldVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateDocumentFieldFieldMetaTextRequestTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeTextRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldUpdateDocumentFieldTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldUpdateDocumentFieldVerticalAlignText]] class FieldUpdateDocumentFieldFieldMetaTextRequest(BaseModel): @@ -421,42 +497,90 @@ class FieldUpdateDocumentFieldFieldMetaTextRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldUpdateDocumentFieldTextAlignText], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateDocumentFieldVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldUpdateDocumentFieldFieldTextTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeTextRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldFieldMetaTextRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldText(BaseModel): type: FieldUpdateDocumentFieldTypeTextRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldFieldMetaTextRequest], @@ -464,19 +588,14 @@ class FieldUpdateDocumentFieldFieldText(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldTypeDateRequest1(str, Enum): @@ -514,7 +633,7 @@ class FieldUpdateDocumentFieldFieldMetaDateRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldTextAlignDate], @@ -525,25 +644,18 @@ class FieldUpdateDocumentFieldFieldMetaDateRequest(BaseModel): class FieldUpdateDocumentFieldFieldDateTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeDateRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldFieldMetaDateRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldDate(BaseModel): type: FieldUpdateDocumentFieldTypeDateRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldFieldMetaDateRequest], @@ -551,19 +663,14 @@ class FieldUpdateDocumentFieldFieldDate(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldTypeEmailRequest1(str, Enum): @@ -601,7 +708,7 @@ class FieldUpdateDocumentFieldFieldMetaEmailRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldTextAlignEmail], @@ -612,25 +719,18 @@ class FieldUpdateDocumentFieldFieldMetaEmailRequest(BaseModel): class FieldUpdateDocumentFieldFieldEmailTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeEmailRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldFieldMetaEmailRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldEmail(BaseModel): type: FieldUpdateDocumentFieldTypeEmailRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldFieldMetaEmailRequest], @@ -638,19 +738,14 @@ class FieldUpdateDocumentFieldFieldEmail(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldTypeNameRequest1(str, Enum): @@ -688,7 +783,7 @@ class FieldUpdateDocumentFieldFieldMetaNameRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldTextAlignName], @@ -699,25 +794,18 @@ class FieldUpdateDocumentFieldFieldMetaNameRequest(BaseModel): class FieldUpdateDocumentFieldFieldNameTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeNameRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldFieldMetaNameRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldName(BaseModel): type: FieldUpdateDocumentFieldTypeNameRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldFieldMetaNameRequest], @@ -725,19 +813,14 @@ class FieldUpdateDocumentFieldFieldName(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldTypeInitialsRequest1(str, Enum): @@ -775,7 +858,7 @@ class FieldUpdateDocumentFieldFieldMetaInitialsRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldTextAlignInitials], @@ -786,25 +869,18 @@ class FieldUpdateDocumentFieldFieldMetaInitialsRequest(BaseModel): class FieldUpdateDocumentFieldFieldInitialsTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeInitialsRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldFieldMetaInitialsRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldInitials(BaseModel): type: FieldUpdateDocumentFieldTypeInitialsRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldFieldMetaInitialsRequest], @@ -812,19 +888,14 @@ class FieldUpdateDocumentFieldFieldInitials(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldTypeFreeSignature(str, Enum): @@ -834,88 +905,97 @@ class FieldUpdateDocumentFieldTypeFreeSignature(str, Enum): class FieldUpdateDocumentFieldFieldFreeSignatureTypedDict(TypedDict): type: FieldUpdateDocumentFieldTypeFreeSignature id: float - r"""The ID of the field to update.""" page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldFreeSignature(BaseModel): type: FieldUpdateDocumentFieldTypeFreeSignature id: float - r"""The ID of the field to update.""" page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" -class FieldUpdateDocumentFieldTypeSignature(str, Enum): +class FieldUpdateDocumentFieldTypeSignatureRequest1(str, Enum): SIGNATURE = "SIGNATURE" +class FieldUpdateDocumentFieldTypeSignatureRequest2(str, Enum): + SIGNATURE = "signature" + + +class FieldUpdateDocumentFieldFieldMetaSignatureRequestTypedDict(TypedDict): + type: FieldUpdateDocumentFieldTypeSignatureRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldUpdateDocumentFieldFieldMetaSignatureRequest(BaseModel): + type: FieldUpdateDocumentFieldTypeSignatureRequest2 + + 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")] = 12 + + class FieldUpdateDocumentFieldFieldSignatureTypedDict(TypedDict): - type: FieldUpdateDocumentFieldTypeSignature + type: FieldUpdateDocumentFieldTypeSignatureRequest1 id: float - r"""The ID of the field to update.""" + field_meta: NotRequired[FieldUpdateDocumentFieldFieldMetaSignatureRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldFieldSignature(BaseModel): - type: FieldUpdateDocumentFieldTypeSignature + type: FieldUpdateDocumentFieldTypeSignatureRequest1 id: float - r"""The ID of the field to update.""" + + field_meta: Annotated[ + Optional[FieldUpdateDocumentFieldFieldMetaSignatureRequest], + pydantic.Field(alias="fieldMeta"), + ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" FieldUpdateDocumentFieldFieldUnionTypedDict = TypeAliasType( "FieldUpdateDocumentFieldFieldUnionTypedDict", Union[ - FieldUpdateDocumentFieldFieldSignatureTypedDict, FieldUpdateDocumentFieldFieldFreeSignatureTypedDict, + FieldUpdateDocumentFieldFieldSignatureTypedDict, FieldUpdateDocumentFieldFieldInitialsTypedDict, FieldUpdateDocumentFieldFieldNameTypedDict, FieldUpdateDocumentFieldFieldEmailTypedDict, @@ -932,8 +1012,8 @@ class FieldUpdateDocumentFieldFieldSignature(BaseModel): FieldUpdateDocumentFieldFieldUnion = TypeAliasType( "FieldUpdateDocumentFieldFieldUnion", Union[ - FieldUpdateDocumentFieldFieldSignature, FieldUpdateDocumentFieldFieldFreeSignature, + FieldUpdateDocumentFieldFieldSignature, FieldUpdateDocumentFieldFieldInitials, FieldUpdateDocumentFieldFieldName, FieldUpdateDocumentFieldFieldEmail, @@ -974,10 +1054,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 +1069,75 @@ 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 FieldUpdateDocumentFieldForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldUpdateDocumentFieldForbiddenIssue(BaseModel): + message: str + + +class FieldUpdateDocumentFieldForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldUpdateDocumentFieldForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldUpdateDocumentFieldForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldUpdateDocumentFieldForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldUpdateDocumentFieldForbiddenErrorData, + 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 FieldUpdateDocumentFieldUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldUpdateDocumentFieldUnauthorizedIssue(BaseModel): + message: str + + +class FieldUpdateDocumentFieldUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldUpdateDocumentFieldUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldUpdateDocumentFieldUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldUpdateDocumentFieldUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldUpdateDocumentFieldUnauthorizedErrorData, + 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 FieldUpdateDocumentFieldBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1156,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 +1171,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): @@ -1056,6 +1206,7 @@ class FieldUpdateDocumentFieldFieldMetaDropdownResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldValueResponse3TypedDict]] default_value: NotRequired[str] @@ -1071,6 +1222,8 @@ class FieldUpdateDocumentFieldFieldMetaDropdownResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldValueResponse3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -1094,15 +1247,22 @@ class FieldUpdateDocumentFieldValueResponse2(BaseModel): value: str +class FieldUpdateDocumentFieldDirectionResponse2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldUpdateDocumentFieldFieldMetaTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateDocumentFieldDirectionResponse2] class FieldUpdateDocumentFieldFieldMetaCheckboxResponse(BaseModel): @@ -1116,6 +1276,8 @@ class FieldUpdateDocumentFieldFieldMetaCheckboxResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldValueResponse2]] = None validation_rule: Annotated[ @@ -1126,6 +1288,10 @@ class FieldUpdateDocumentFieldFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateDocumentFieldDirectionResponse2] = ( + FieldUpdateDocumentFieldDirectionResponse2.VERTICAL + ) + class FieldUpdateDocumentFieldFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1145,13 +1311,20 @@ class FieldUpdateDocumentFieldValueResponse1(BaseModel): value: str +class FieldUpdateDocumentFieldDirectionResponse1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldFieldMetaRadioResponseTypedDict(TypedDict): type: FieldUpdateDocumentFieldFieldMetaTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldValueResponse1TypedDict]] + direction: NotRequired[FieldUpdateDocumentFieldDirectionResponse1] class FieldUpdateDocumentFieldFieldMetaRadioResponse(BaseModel): @@ -1165,8 +1338,14 @@ class FieldUpdateDocumentFieldFieldMetaRadioResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldValueResponse1]] = None + direction: Optional[FieldUpdateDocumentFieldDirectionResponse1] = ( + FieldUpdateDocumentFieldDirectionResponse1.VERTICAL + ) + class FieldUpdateDocumentFieldFieldMetaTypeNumber(str, Enum): NUMBER = "number" @@ -1178,18 +1357,29 @@ class FieldUpdateDocumentFieldTextAlignResponse6(str, Enum): RIGHT = "right" +class FieldUpdateDocumentFieldVerticalAlignResponse2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateDocumentFieldFieldMetaNumberResponseTypedDict(TypedDict): type: FieldUpdateDocumentFieldFieldMetaTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldUpdateDocumentFieldTextAlignResponse6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldUpdateDocumentFieldVerticalAlignResponse2] + ] class FieldUpdateDocumentFieldFieldMetaNumberResponse(BaseModel): @@ -1203,21 +1393,91 @@ class FieldUpdateDocumentFieldFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldUpdateDocumentFieldTextAlignResponse6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateDocumentFieldVerticalAlignResponse2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -1229,16 +1489,27 @@ class FieldUpdateDocumentFieldTextAlignResponse5(str, Enum): RIGHT = "right" +class FieldUpdateDocumentFieldVerticalAlignResponse1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateDocumentFieldFieldMetaTextResponseTypedDict(TypedDict): type: FieldUpdateDocumentFieldFieldMetaTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldUpdateDocumentFieldTextAlignResponse5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldUpdateDocumentFieldVerticalAlignResponse1] + ] class FieldUpdateDocumentFieldFieldMetaTextResponse(BaseModel): @@ -1252,19 +1523,74 @@ class FieldUpdateDocumentFieldFieldMetaTextResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldUpdateDocumentFieldTextAlignResponse5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateDocumentFieldVerticalAlignResponse1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldUpdateDocumentFieldFieldMetaTypeDate(str, Enum): DATE = "date" @@ -1297,7 +1623,7 @@ class FieldUpdateDocumentFieldFieldMetaDateResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldTextAlignResponse4], @@ -1336,7 +1662,7 @@ class FieldUpdateDocumentFieldFieldMetaEmailResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldTextAlignResponse3], @@ -1375,7 +1701,7 @@ class FieldUpdateDocumentFieldFieldMetaNameResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldTextAlignResponse2], @@ -1414,7 +1740,7 @@ class FieldUpdateDocumentFieldFieldMetaInitialsResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldTextAlignResponse1], @@ -1422,14 +1748,42 @@ class FieldUpdateDocumentFieldFieldMetaInitialsResponse(BaseModel): ] = None +class FieldUpdateDocumentFieldFieldMetaTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldUpdateDocumentFieldFieldMetaSignatureResponseTypedDict(TypedDict): + type: FieldUpdateDocumentFieldFieldMetaTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldUpdateDocumentFieldFieldMetaSignatureResponse(BaseModel): + type: FieldUpdateDocumentFieldFieldMetaTypeSignature + + 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")] = 12 + + FieldUpdateDocumentFieldFieldMetaUnionTypedDict = TypeAliasType( "FieldUpdateDocumentFieldFieldMetaUnionTypedDict", Union[ - FieldUpdateDocumentFieldFieldMetaRadioResponseTypedDict, + FieldUpdateDocumentFieldFieldMetaSignatureResponseTypedDict, FieldUpdateDocumentFieldFieldMetaInitialsResponseTypedDict, FieldUpdateDocumentFieldFieldMetaNameResponseTypedDict, FieldUpdateDocumentFieldFieldMetaEmailResponseTypedDict, FieldUpdateDocumentFieldFieldMetaDateResponseTypedDict, + FieldUpdateDocumentFieldFieldMetaRadioResponseTypedDict, FieldUpdateDocumentFieldFieldMetaDropdownResponseTypedDict, FieldUpdateDocumentFieldFieldMetaCheckboxResponseTypedDict, FieldUpdateDocumentFieldFieldMetaTextResponseTypedDict, @@ -1441,11 +1795,12 @@ class FieldUpdateDocumentFieldFieldMetaInitialsResponse(BaseModel): FieldUpdateDocumentFieldFieldMetaUnion = TypeAliasType( "FieldUpdateDocumentFieldFieldMetaUnion", Union[ - FieldUpdateDocumentFieldFieldMetaRadioResponse, + FieldUpdateDocumentFieldFieldMetaSignatureResponse, FieldUpdateDocumentFieldFieldMetaInitialsResponse, FieldUpdateDocumentFieldFieldMetaNameResponse, FieldUpdateDocumentFieldFieldMetaEmailResponse, FieldUpdateDocumentFieldFieldMetaDateResponse, + FieldUpdateDocumentFieldFieldMetaRadioResponse, FieldUpdateDocumentFieldFieldMetaDropdownResponse, FieldUpdateDocumentFieldFieldMetaCheckboxResponse, FieldUpdateDocumentFieldFieldMetaTextResponse, @@ -1457,40 +1812,48 @@ 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[FieldUpdateDocumentFieldFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -1501,18 +1864,18 @@ class FieldUpdateDocumentFieldResponse(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["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..c54d767 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 @@ -33,6 +40,7 @@ class FieldUpdateDocumentFieldsFieldMetaDropdownRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldsValueDropdownTypedDict]] default_value: NotRequired[str] @@ -48,6 +56,8 @@ class FieldUpdateDocumentFieldsFieldMetaDropdownRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldsValueDropdown]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -56,25 +66,18 @@ class FieldUpdateDocumentFieldsFieldMetaDropdownRequest(BaseModel): class FieldUpdateDocumentFieldsFieldDropdownTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeDropdownRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldsFieldMetaDropdownRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldDropdown(BaseModel): type: FieldUpdateDocumentFieldsTypeDropdownRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldsFieldMetaDropdownRequest], @@ -82,19 +85,14 @@ class FieldUpdateDocumentFieldsFieldDropdown(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldsTypeCheckboxRequest1(str, Enum): @@ -119,15 +117,22 @@ class FieldUpdateDocumentFieldsValueCheckbox(BaseModel): value: str +class FieldUpdateDocumentFieldsDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeCheckboxRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldsValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateDocumentFieldsDirectionCheckbox] class FieldUpdateDocumentFieldsFieldMetaCheckboxRequest(BaseModel): @@ -141,6 +146,8 @@ class FieldUpdateDocumentFieldsFieldMetaCheckboxRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldsValueCheckbox]] = None validation_rule: Annotated[ @@ -151,29 +158,26 @@ class FieldUpdateDocumentFieldsFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateDocumentFieldsDirectionCheckbox] = ( + FieldUpdateDocumentFieldsDirectionCheckbox.VERTICAL + ) + class FieldUpdateDocumentFieldsFieldCheckboxTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeCheckboxRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldsFieldMetaCheckboxRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldCheckbox(BaseModel): type: FieldUpdateDocumentFieldsTypeCheckboxRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldsFieldMetaCheckboxRequest], @@ -181,19 +185,14 @@ class FieldUpdateDocumentFieldsFieldCheckbox(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldsTypeRadioRequest1(str, Enum): @@ -218,13 +217,20 @@ class FieldUpdateDocumentFieldsValueRadio(BaseModel): value: str +class FieldUpdateDocumentFieldsDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldsFieldMetaRadioRequestTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeRadioRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldsValueRadioTypedDict]] + direction: NotRequired[FieldUpdateDocumentFieldsDirectionRadio] class FieldUpdateDocumentFieldsFieldMetaRadioRequest(BaseModel): @@ -238,31 +244,30 @@ class FieldUpdateDocumentFieldsFieldMetaRadioRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldsValueRadio]] = None + direction: Optional[FieldUpdateDocumentFieldsDirectionRadio] = ( + FieldUpdateDocumentFieldsDirectionRadio.VERTICAL + ) + class FieldUpdateDocumentFieldsFieldRadioTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeRadioRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldsFieldMetaRadioRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldRadio(BaseModel): type: FieldUpdateDocumentFieldsTypeRadioRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldsFieldMetaRadioRequest], @@ -270,19 +275,14 @@ class FieldUpdateDocumentFieldsFieldRadio(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldsTypeNumberRequest1(str, Enum): @@ -299,18 +299,27 @@ class FieldUpdateDocumentFieldsTextAlignNumber(str, Enum): RIGHT = "right" +class FieldUpdateDocumentFieldsVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateDocumentFieldsFieldMetaNumberRequestTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeNumberRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldUpdateDocumentFieldsTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldUpdateDocumentFieldsVerticalAlignNumber]] class FieldUpdateDocumentFieldsFieldMetaNumberRequest(BaseModel): @@ -324,44 +333,107 @@ class FieldUpdateDocumentFieldsFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldUpdateDocumentFieldsTextAlignNumber], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateDocumentFieldsVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldsFieldMetaNumberRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldNumber(BaseModel): type: FieldUpdateDocumentFieldsTypeNumberRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldsFieldMetaNumberRequest], @@ -369,19 +441,14 @@ class FieldUpdateDocumentFieldsFieldNumber(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldsTypeTextRequest1(str, Enum): @@ -398,16 +465,25 @@ class FieldUpdateDocumentFieldsTextAlignText(str, Enum): RIGHT = "right" +class FieldUpdateDocumentFieldsVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateDocumentFieldsFieldMetaTextRequestTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeTextRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldUpdateDocumentFieldsTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldUpdateDocumentFieldsVerticalAlignText]] class FieldUpdateDocumentFieldsFieldMetaTextRequest(BaseModel): @@ -421,42 +497,90 @@ class FieldUpdateDocumentFieldsFieldMetaTextRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldUpdateDocumentFieldsTextAlignText], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateDocumentFieldsVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldUpdateDocumentFieldsFieldTextTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeTextRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldsFieldMetaTextRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldText(BaseModel): type: FieldUpdateDocumentFieldsTypeTextRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldsFieldMetaTextRequest], @@ -464,19 +588,14 @@ class FieldUpdateDocumentFieldsFieldText(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldsTypeDateRequest1(str, Enum): @@ -514,7 +633,7 @@ class FieldUpdateDocumentFieldsFieldMetaDateRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldsTextAlignDate], @@ -525,25 +644,18 @@ class FieldUpdateDocumentFieldsFieldMetaDateRequest(BaseModel): class FieldUpdateDocumentFieldsFieldDateTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeDateRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldsFieldMetaDateRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldDate(BaseModel): type: FieldUpdateDocumentFieldsTypeDateRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldsFieldMetaDateRequest], @@ -551,19 +663,14 @@ class FieldUpdateDocumentFieldsFieldDate(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldsTypeEmailRequest1(str, Enum): @@ -601,7 +708,7 @@ class FieldUpdateDocumentFieldsFieldMetaEmailRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldsTextAlignEmail], @@ -612,25 +719,18 @@ class FieldUpdateDocumentFieldsFieldMetaEmailRequest(BaseModel): class FieldUpdateDocumentFieldsFieldEmailTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeEmailRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldsFieldMetaEmailRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldEmail(BaseModel): type: FieldUpdateDocumentFieldsTypeEmailRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldsFieldMetaEmailRequest], @@ -638,19 +738,14 @@ class FieldUpdateDocumentFieldsFieldEmail(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldsTypeNameRequest1(str, Enum): @@ -688,7 +783,7 @@ class FieldUpdateDocumentFieldsFieldMetaNameRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldsTextAlignName], @@ -699,25 +794,18 @@ class FieldUpdateDocumentFieldsFieldMetaNameRequest(BaseModel): class FieldUpdateDocumentFieldsFieldNameTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeNameRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldsFieldMetaNameRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldName(BaseModel): type: FieldUpdateDocumentFieldsTypeNameRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldsFieldMetaNameRequest], @@ -725,19 +813,14 @@ class FieldUpdateDocumentFieldsFieldName(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldsTypeInitialsRequest1(str, Enum): @@ -775,7 +858,7 @@ class FieldUpdateDocumentFieldsFieldMetaInitialsRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldsTextAlignInitials], @@ -786,25 +869,18 @@ class FieldUpdateDocumentFieldsFieldMetaInitialsRequest(BaseModel): class FieldUpdateDocumentFieldsFieldInitialsTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeInitialsRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateDocumentFieldsFieldMetaInitialsRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldInitials(BaseModel): type: FieldUpdateDocumentFieldsTypeInitialsRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateDocumentFieldsFieldMetaInitialsRequest], @@ -812,19 +888,14 @@ class FieldUpdateDocumentFieldsFieldInitials(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateDocumentFieldsTypeFreeSignature(str, Enum): @@ -834,88 +905,97 @@ class FieldUpdateDocumentFieldsTypeFreeSignature(str, Enum): class FieldUpdateDocumentFieldsFieldFreeSignatureTypedDict(TypedDict): type: FieldUpdateDocumentFieldsTypeFreeSignature id: float - r"""The ID of the field to update.""" page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldFreeSignature(BaseModel): type: FieldUpdateDocumentFieldsTypeFreeSignature id: float - r"""The ID of the field to update.""" page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" -class FieldUpdateDocumentFieldsTypeSignature(str, Enum): +class FieldUpdateDocumentFieldsTypeSignatureRequest1(str, Enum): SIGNATURE = "SIGNATURE" +class FieldUpdateDocumentFieldsTypeSignatureRequest2(str, Enum): + SIGNATURE = "signature" + + +class FieldUpdateDocumentFieldsFieldMetaSignatureRequestTypedDict(TypedDict): + type: FieldUpdateDocumentFieldsTypeSignatureRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldUpdateDocumentFieldsFieldMetaSignatureRequest(BaseModel): + type: FieldUpdateDocumentFieldsTypeSignatureRequest2 + + 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")] = 12 + + class FieldUpdateDocumentFieldsFieldSignatureTypedDict(TypedDict): - type: FieldUpdateDocumentFieldsTypeSignature + type: FieldUpdateDocumentFieldsTypeSignatureRequest1 id: float - r"""The ID of the field to update.""" + field_meta: NotRequired[FieldUpdateDocumentFieldsFieldMetaSignatureRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateDocumentFieldsFieldSignature(BaseModel): - type: FieldUpdateDocumentFieldsTypeSignature + type: FieldUpdateDocumentFieldsTypeSignatureRequest1 id: float - r"""The ID of the field to update.""" + + field_meta: Annotated[ + Optional[FieldUpdateDocumentFieldsFieldMetaSignatureRequest], + pydantic.Field(alias="fieldMeta"), + ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" FieldUpdateDocumentFieldsFieldUnionTypedDict = TypeAliasType( "FieldUpdateDocumentFieldsFieldUnionTypedDict", Union[ - FieldUpdateDocumentFieldsFieldSignatureTypedDict, FieldUpdateDocumentFieldsFieldFreeSignatureTypedDict, + FieldUpdateDocumentFieldsFieldSignatureTypedDict, FieldUpdateDocumentFieldsFieldInitialsTypedDict, FieldUpdateDocumentFieldsFieldNameTypedDict, FieldUpdateDocumentFieldsFieldEmailTypedDict, @@ -932,8 +1012,8 @@ class FieldUpdateDocumentFieldsFieldSignature(BaseModel): FieldUpdateDocumentFieldsFieldUnion = TypeAliasType( "FieldUpdateDocumentFieldsFieldUnion", Union[ - FieldUpdateDocumentFieldsFieldSignature, FieldUpdateDocumentFieldsFieldFreeSignature, + FieldUpdateDocumentFieldsFieldSignature, FieldUpdateDocumentFieldsFieldInitials, FieldUpdateDocumentFieldsFieldName, FieldUpdateDocumentFieldsFieldEmail, @@ -974,10 +1054,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 +1069,75 @@ 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 FieldUpdateDocumentFieldsForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldUpdateDocumentFieldsForbiddenIssue(BaseModel): + message: str + + +class FieldUpdateDocumentFieldsForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldUpdateDocumentFieldsForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldUpdateDocumentFieldsForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldUpdateDocumentFieldsForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldUpdateDocumentFieldsForbiddenErrorData, + 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 FieldUpdateDocumentFieldsUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldUpdateDocumentFieldsUnauthorizedIssue(BaseModel): + message: str + + +class FieldUpdateDocumentFieldsUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldUpdateDocumentFieldsUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldUpdateDocumentFieldsUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldUpdateDocumentFieldsUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldUpdateDocumentFieldsUnauthorizedErrorData, + 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 FieldUpdateDocumentFieldsBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1156,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 +1171,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): @@ -1056,6 +1206,7 @@ class FieldUpdateDocumentFieldsFieldMetaDropdownResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldsValueResponse3TypedDict]] default_value: NotRequired[str] @@ -1071,6 +1222,8 @@ class FieldUpdateDocumentFieldsFieldMetaDropdownResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldsValueResponse3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -1094,15 +1247,22 @@ class FieldUpdateDocumentFieldsValueResponse2(BaseModel): value: str +class FieldUpdateDocumentFieldsDirectionResponse2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldUpdateDocumentFieldsFieldMetaTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldsValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateDocumentFieldsDirectionResponse2] class FieldUpdateDocumentFieldsFieldMetaCheckboxResponse(BaseModel): @@ -1116,6 +1276,8 @@ class FieldUpdateDocumentFieldsFieldMetaCheckboxResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldsValueResponse2]] = None validation_rule: Annotated[ @@ -1126,6 +1288,10 @@ class FieldUpdateDocumentFieldsFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateDocumentFieldsDirectionResponse2] = ( + FieldUpdateDocumentFieldsDirectionResponse2.VERTICAL + ) + class FieldUpdateDocumentFieldsFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1145,13 +1311,20 @@ class FieldUpdateDocumentFieldsValueResponse1(BaseModel): value: str +class FieldUpdateDocumentFieldsDirectionResponse1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateDocumentFieldsFieldMetaRadioResponseTypedDict(TypedDict): type: FieldUpdateDocumentFieldsFieldMetaTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateDocumentFieldsValueResponse1TypedDict]] + direction: NotRequired[FieldUpdateDocumentFieldsDirectionResponse1] class FieldUpdateDocumentFieldsFieldMetaRadioResponse(BaseModel): @@ -1165,8 +1338,14 @@ class FieldUpdateDocumentFieldsFieldMetaRadioResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateDocumentFieldsValueResponse1]] = None + direction: Optional[FieldUpdateDocumentFieldsDirectionResponse1] = ( + FieldUpdateDocumentFieldsDirectionResponse1.VERTICAL + ) + class FieldUpdateDocumentFieldsFieldMetaTypeNumber(str, Enum): NUMBER = "number" @@ -1178,18 +1357,29 @@ class FieldUpdateDocumentFieldsTextAlignResponse6(str, Enum): RIGHT = "right" +class FieldUpdateDocumentFieldsVerticalAlignResponse2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateDocumentFieldsFieldMetaNumberResponseTypedDict(TypedDict): type: FieldUpdateDocumentFieldsFieldMetaTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldUpdateDocumentFieldsTextAlignResponse6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldUpdateDocumentFieldsVerticalAlignResponse2] + ] class FieldUpdateDocumentFieldsFieldMetaNumberResponse(BaseModel): @@ -1203,21 +1393,91 @@ class FieldUpdateDocumentFieldsFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldUpdateDocumentFieldsTextAlignResponse6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateDocumentFieldsVerticalAlignResponse2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -1229,16 +1489,27 @@ class FieldUpdateDocumentFieldsTextAlignResponse5(str, Enum): RIGHT = "right" +class FieldUpdateDocumentFieldsVerticalAlignResponse1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateDocumentFieldsFieldMetaTextResponseTypedDict(TypedDict): type: FieldUpdateDocumentFieldsFieldMetaTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldUpdateDocumentFieldsTextAlignResponse5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldUpdateDocumentFieldsVerticalAlignResponse1] + ] class FieldUpdateDocumentFieldsFieldMetaTextResponse(BaseModel): @@ -1252,19 +1523,74 @@ class FieldUpdateDocumentFieldsFieldMetaTextResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldUpdateDocumentFieldsTextAlignResponse5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateDocumentFieldsVerticalAlignResponse1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldUpdateDocumentFieldsFieldMetaTypeDate(str, Enum): DATE = "date" @@ -1297,7 +1623,7 @@ class FieldUpdateDocumentFieldsFieldMetaDateResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldsTextAlignResponse4], @@ -1336,7 +1662,7 @@ class FieldUpdateDocumentFieldsFieldMetaEmailResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldsTextAlignResponse3], @@ -1375,7 +1701,7 @@ class FieldUpdateDocumentFieldsFieldMetaNameResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldsTextAlignResponse2], @@ -1414,7 +1740,7 @@ class FieldUpdateDocumentFieldsFieldMetaInitialsResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateDocumentFieldsTextAlignResponse1], @@ -1422,14 +1748,42 @@ class FieldUpdateDocumentFieldsFieldMetaInitialsResponse(BaseModel): ] = None +class FieldUpdateDocumentFieldsFieldMetaTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldUpdateDocumentFieldsFieldMetaSignatureResponseTypedDict(TypedDict): + type: FieldUpdateDocumentFieldsFieldMetaTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldUpdateDocumentFieldsFieldMetaSignatureResponse(BaseModel): + type: FieldUpdateDocumentFieldsFieldMetaTypeSignature + + 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")] = 12 + + FieldUpdateDocumentFieldsFieldMetaUnionTypedDict = TypeAliasType( "FieldUpdateDocumentFieldsFieldMetaUnionTypedDict", Union[ - FieldUpdateDocumentFieldsFieldMetaRadioResponseTypedDict, + FieldUpdateDocumentFieldsFieldMetaSignatureResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaInitialsResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaNameResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaEmailResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaDateResponseTypedDict, + FieldUpdateDocumentFieldsFieldMetaRadioResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaDropdownResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaCheckboxResponseTypedDict, FieldUpdateDocumentFieldsFieldMetaTextResponseTypedDict, @@ -1441,11 +1795,12 @@ class FieldUpdateDocumentFieldsFieldMetaInitialsResponse(BaseModel): FieldUpdateDocumentFieldsFieldMetaUnion = TypeAliasType( "FieldUpdateDocumentFieldsFieldMetaUnion", Union[ - FieldUpdateDocumentFieldsFieldMetaRadioResponse, + FieldUpdateDocumentFieldsFieldMetaSignatureResponse, FieldUpdateDocumentFieldsFieldMetaInitialsResponse, FieldUpdateDocumentFieldsFieldMetaNameResponse, FieldUpdateDocumentFieldsFieldMetaEmailResponse, FieldUpdateDocumentFieldsFieldMetaDateResponse, + FieldUpdateDocumentFieldsFieldMetaRadioResponse, FieldUpdateDocumentFieldsFieldMetaDropdownResponse, FieldUpdateDocumentFieldsFieldMetaCheckboxResponse, FieldUpdateDocumentFieldsFieldMetaTextResponse, @@ -1455,38 +1810,46 @@ class FieldUpdateDocumentFieldsFieldMetaInitialsResponse(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[FieldUpdateDocumentFieldsFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -1497,18 +1860,18 @@ class FieldUpdateDocumentFieldsFieldResponse(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["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..f5cbf3f 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 @@ -33,6 +40,7 @@ class FieldUpdateTemplateFieldFieldMetaDropdownRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldValueDropdownTypedDict]] default_value: NotRequired[str] @@ -48,6 +56,8 @@ class FieldUpdateTemplateFieldFieldMetaDropdownRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldValueDropdown]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -56,25 +66,18 @@ class FieldUpdateTemplateFieldFieldMetaDropdownRequest(BaseModel): class FieldUpdateTemplateFieldFieldDropdownTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeDropdownRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldFieldMetaDropdownRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldDropdown(BaseModel): type: FieldUpdateTemplateFieldTypeDropdownRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldFieldMetaDropdownRequest], @@ -82,19 +85,14 @@ class FieldUpdateTemplateFieldFieldDropdown(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldTypeCheckboxRequest1(str, Enum): @@ -119,15 +117,22 @@ class FieldUpdateTemplateFieldValueCheckbox(BaseModel): value: str +class FieldUpdateTemplateFieldDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeCheckboxRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateTemplateFieldDirectionCheckbox] class FieldUpdateTemplateFieldFieldMetaCheckboxRequest(BaseModel): @@ -141,6 +146,8 @@ class FieldUpdateTemplateFieldFieldMetaCheckboxRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldValueCheckbox]] = None validation_rule: Annotated[ @@ -151,29 +158,26 @@ class FieldUpdateTemplateFieldFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateTemplateFieldDirectionCheckbox] = ( + FieldUpdateTemplateFieldDirectionCheckbox.VERTICAL + ) + class FieldUpdateTemplateFieldFieldCheckboxTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeCheckboxRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldFieldMetaCheckboxRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldCheckbox(BaseModel): type: FieldUpdateTemplateFieldTypeCheckboxRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldFieldMetaCheckboxRequest], @@ -181,19 +185,14 @@ class FieldUpdateTemplateFieldFieldCheckbox(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldTypeRadioRequest1(str, Enum): @@ -218,13 +217,20 @@ class FieldUpdateTemplateFieldValueRadio(BaseModel): value: str +class FieldUpdateTemplateFieldDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldFieldMetaRadioRequestTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeRadioRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldValueRadioTypedDict]] + direction: NotRequired[FieldUpdateTemplateFieldDirectionRadio] class FieldUpdateTemplateFieldFieldMetaRadioRequest(BaseModel): @@ -238,31 +244,30 @@ class FieldUpdateTemplateFieldFieldMetaRadioRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldValueRadio]] = None + direction: Optional[FieldUpdateTemplateFieldDirectionRadio] = ( + FieldUpdateTemplateFieldDirectionRadio.VERTICAL + ) + class FieldUpdateTemplateFieldFieldRadioTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeRadioRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldFieldMetaRadioRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldRadio(BaseModel): type: FieldUpdateTemplateFieldTypeRadioRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldFieldMetaRadioRequest], @@ -270,19 +275,14 @@ class FieldUpdateTemplateFieldFieldRadio(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldTypeNumberRequest1(str, Enum): @@ -299,18 +299,27 @@ class FieldUpdateTemplateFieldTextAlignNumber(str, Enum): RIGHT = "right" +class FieldUpdateTemplateFieldVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateTemplateFieldFieldMetaNumberRequestTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeNumberRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldUpdateTemplateFieldTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldUpdateTemplateFieldVerticalAlignNumber]] class FieldUpdateTemplateFieldFieldMetaNumberRequest(BaseModel): @@ -324,44 +333,107 @@ class FieldUpdateTemplateFieldFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldUpdateTemplateFieldTextAlignNumber], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateTemplateFieldVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldFieldMetaNumberRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldNumber(BaseModel): type: FieldUpdateTemplateFieldTypeNumberRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldFieldMetaNumberRequest], @@ -369,19 +441,14 @@ class FieldUpdateTemplateFieldFieldNumber(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldTypeTextRequest1(str, Enum): @@ -398,16 +465,25 @@ class FieldUpdateTemplateFieldTextAlignText(str, Enum): RIGHT = "right" +class FieldUpdateTemplateFieldVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateTemplateFieldFieldMetaTextRequestTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeTextRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldUpdateTemplateFieldTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldUpdateTemplateFieldVerticalAlignText]] class FieldUpdateTemplateFieldFieldMetaTextRequest(BaseModel): @@ -421,42 +497,90 @@ class FieldUpdateTemplateFieldFieldMetaTextRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldUpdateTemplateFieldTextAlignText], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateTemplateFieldVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldUpdateTemplateFieldFieldTextTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeTextRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldFieldMetaTextRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldText(BaseModel): type: FieldUpdateTemplateFieldTypeTextRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldFieldMetaTextRequest], @@ -464,19 +588,14 @@ class FieldUpdateTemplateFieldFieldText(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldTypeDateRequest1(str, Enum): @@ -514,7 +633,7 @@ class FieldUpdateTemplateFieldFieldMetaDateRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldTextAlignDate], @@ -525,25 +644,18 @@ class FieldUpdateTemplateFieldFieldMetaDateRequest(BaseModel): class FieldUpdateTemplateFieldFieldDateTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeDateRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldFieldMetaDateRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldDate(BaseModel): type: FieldUpdateTemplateFieldTypeDateRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldFieldMetaDateRequest], @@ -551,19 +663,14 @@ class FieldUpdateTemplateFieldFieldDate(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldTypeEmailRequest1(str, Enum): @@ -601,7 +708,7 @@ class FieldUpdateTemplateFieldFieldMetaEmailRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldTextAlignEmail], @@ -612,25 +719,18 @@ class FieldUpdateTemplateFieldFieldMetaEmailRequest(BaseModel): class FieldUpdateTemplateFieldFieldEmailTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeEmailRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldFieldMetaEmailRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldEmail(BaseModel): type: FieldUpdateTemplateFieldTypeEmailRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldFieldMetaEmailRequest], @@ -638,19 +738,14 @@ class FieldUpdateTemplateFieldFieldEmail(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldTypeNameRequest1(str, Enum): @@ -688,7 +783,7 @@ class FieldUpdateTemplateFieldFieldMetaNameRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldTextAlignName], @@ -699,25 +794,18 @@ class FieldUpdateTemplateFieldFieldMetaNameRequest(BaseModel): class FieldUpdateTemplateFieldFieldNameTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeNameRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldFieldMetaNameRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldName(BaseModel): type: FieldUpdateTemplateFieldTypeNameRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldFieldMetaNameRequest], @@ -725,19 +813,14 @@ class FieldUpdateTemplateFieldFieldName(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldTypeInitialsRequest1(str, Enum): @@ -775,7 +858,7 @@ class FieldUpdateTemplateFieldFieldMetaInitialsRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldTextAlignInitials], @@ -786,25 +869,18 @@ class FieldUpdateTemplateFieldFieldMetaInitialsRequest(BaseModel): class FieldUpdateTemplateFieldFieldInitialsTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeInitialsRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldFieldMetaInitialsRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldInitials(BaseModel): type: FieldUpdateTemplateFieldTypeInitialsRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldFieldMetaInitialsRequest], @@ -812,19 +888,14 @@ class FieldUpdateTemplateFieldFieldInitials(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldTypeFreeSignature(str, Enum): @@ -834,88 +905,97 @@ class FieldUpdateTemplateFieldTypeFreeSignature(str, Enum): class FieldUpdateTemplateFieldFieldFreeSignatureTypedDict(TypedDict): type: FieldUpdateTemplateFieldTypeFreeSignature id: float - r"""The ID of the field to update.""" page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldFreeSignature(BaseModel): type: FieldUpdateTemplateFieldTypeFreeSignature id: float - r"""The ID of the field to update.""" page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" -class FieldUpdateTemplateFieldTypeSignature(str, Enum): +class FieldUpdateTemplateFieldTypeSignatureRequest1(str, Enum): SIGNATURE = "SIGNATURE" +class FieldUpdateTemplateFieldTypeSignatureRequest2(str, Enum): + SIGNATURE = "signature" + + +class FieldUpdateTemplateFieldFieldMetaSignatureRequestTypedDict(TypedDict): + type: FieldUpdateTemplateFieldTypeSignatureRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldUpdateTemplateFieldFieldMetaSignatureRequest(BaseModel): + type: FieldUpdateTemplateFieldTypeSignatureRequest2 + + 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")] = 12 + + class FieldUpdateTemplateFieldFieldSignatureTypedDict(TypedDict): - type: FieldUpdateTemplateFieldTypeSignature + type: FieldUpdateTemplateFieldTypeSignatureRequest1 id: float - r"""The ID of the field to update.""" + field_meta: NotRequired[FieldUpdateTemplateFieldFieldMetaSignatureRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldFieldSignature(BaseModel): - type: FieldUpdateTemplateFieldTypeSignature + type: FieldUpdateTemplateFieldTypeSignatureRequest1 id: float - r"""The ID of the field to update.""" + + field_meta: Annotated[ + Optional[FieldUpdateTemplateFieldFieldMetaSignatureRequest], + pydantic.Field(alias="fieldMeta"), + ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" FieldUpdateTemplateFieldFieldUnionTypedDict = TypeAliasType( "FieldUpdateTemplateFieldFieldUnionTypedDict", Union[ - FieldUpdateTemplateFieldFieldSignatureTypedDict, FieldUpdateTemplateFieldFieldFreeSignatureTypedDict, + FieldUpdateTemplateFieldFieldSignatureTypedDict, FieldUpdateTemplateFieldFieldInitialsTypedDict, FieldUpdateTemplateFieldFieldNameTypedDict, FieldUpdateTemplateFieldFieldEmailTypedDict, @@ -932,8 +1012,8 @@ class FieldUpdateTemplateFieldFieldSignature(BaseModel): FieldUpdateTemplateFieldFieldUnion = TypeAliasType( "FieldUpdateTemplateFieldFieldUnion", Union[ - FieldUpdateTemplateFieldFieldSignature, FieldUpdateTemplateFieldFieldFreeSignature, + FieldUpdateTemplateFieldFieldSignature, FieldUpdateTemplateFieldFieldInitials, FieldUpdateTemplateFieldFieldName, FieldUpdateTemplateFieldFieldEmail, @@ -974,10 +1054,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 +1069,75 @@ 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 FieldUpdateTemplateFieldForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldUpdateTemplateFieldForbiddenIssue(BaseModel): + message: str + + +class FieldUpdateTemplateFieldForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldUpdateTemplateFieldForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldUpdateTemplateFieldForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldUpdateTemplateFieldForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldUpdateTemplateFieldForbiddenErrorData, + 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 FieldUpdateTemplateFieldUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldUpdateTemplateFieldUnauthorizedIssue(BaseModel): + message: str + + +class FieldUpdateTemplateFieldUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldUpdateTemplateFieldUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldUpdateTemplateFieldUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldUpdateTemplateFieldUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldUpdateTemplateFieldUnauthorizedErrorData, + 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 FieldUpdateTemplateFieldBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1156,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 +1171,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): @@ -1056,6 +1206,7 @@ class FieldUpdateTemplateFieldFieldMetaDropdownResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldValueResponse3TypedDict]] default_value: NotRequired[str] @@ -1071,6 +1222,8 @@ class FieldUpdateTemplateFieldFieldMetaDropdownResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldValueResponse3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -1094,15 +1247,22 @@ class FieldUpdateTemplateFieldValueResponse2(BaseModel): value: str +class FieldUpdateTemplateFieldDirectionResponse2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldUpdateTemplateFieldFieldMetaTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateTemplateFieldDirectionResponse2] class FieldUpdateTemplateFieldFieldMetaCheckboxResponse(BaseModel): @@ -1116,6 +1276,8 @@ class FieldUpdateTemplateFieldFieldMetaCheckboxResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldValueResponse2]] = None validation_rule: Annotated[ @@ -1126,6 +1288,10 @@ class FieldUpdateTemplateFieldFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateTemplateFieldDirectionResponse2] = ( + FieldUpdateTemplateFieldDirectionResponse2.VERTICAL + ) + class FieldUpdateTemplateFieldFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1145,13 +1311,20 @@ class FieldUpdateTemplateFieldValueResponse1(BaseModel): value: str +class FieldUpdateTemplateFieldDirectionResponse1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldFieldMetaRadioResponseTypedDict(TypedDict): type: FieldUpdateTemplateFieldFieldMetaTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldValueResponse1TypedDict]] + direction: NotRequired[FieldUpdateTemplateFieldDirectionResponse1] class FieldUpdateTemplateFieldFieldMetaRadioResponse(BaseModel): @@ -1165,8 +1338,14 @@ class FieldUpdateTemplateFieldFieldMetaRadioResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldValueResponse1]] = None + direction: Optional[FieldUpdateTemplateFieldDirectionResponse1] = ( + FieldUpdateTemplateFieldDirectionResponse1.VERTICAL + ) + class FieldUpdateTemplateFieldFieldMetaTypeNumber(str, Enum): NUMBER = "number" @@ -1178,18 +1357,29 @@ class FieldUpdateTemplateFieldTextAlignResponse6(str, Enum): RIGHT = "right" +class FieldUpdateTemplateFieldVerticalAlignResponse2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateTemplateFieldFieldMetaNumberResponseTypedDict(TypedDict): type: FieldUpdateTemplateFieldFieldMetaTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldUpdateTemplateFieldTextAlignResponse6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldUpdateTemplateFieldVerticalAlignResponse2] + ] class FieldUpdateTemplateFieldFieldMetaNumberResponse(BaseModel): @@ -1203,21 +1393,91 @@ class FieldUpdateTemplateFieldFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldUpdateTemplateFieldTextAlignResponse6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateTemplateFieldVerticalAlignResponse2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -1229,16 +1489,27 @@ class FieldUpdateTemplateFieldTextAlignResponse5(str, Enum): RIGHT = "right" +class FieldUpdateTemplateFieldVerticalAlignResponse1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateTemplateFieldFieldMetaTextResponseTypedDict(TypedDict): type: FieldUpdateTemplateFieldFieldMetaTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldUpdateTemplateFieldTextAlignResponse5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldUpdateTemplateFieldVerticalAlignResponse1] + ] class FieldUpdateTemplateFieldFieldMetaTextResponse(BaseModel): @@ -1252,19 +1523,74 @@ class FieldUpdateTemplateFieldFieldMetaTextResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldUpdateTemplateFieldTextAlignResponse5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateTemplateFieldVerticalAlignResponse1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldUpdateTemplateFieldFieldMetaTypeDate(str, Enum): DATE = "date" @@ -1297,7 +1623,7 @@ class FieldUpdateTemplateFieldFieldMetaDateResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldTextAlignResponse4], @@ -1336,7 +1662,7 @@ class FieldUpdateTemplateFieldFieldMetaEmailResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldTextAlignResponse3], @@ -1375,7 +1701,7 @@ class FieldUpdateTemplateFieldFieldMetaNameResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldTextAlignResponse2], @@ -1414,7 +1740,7 @@ class FieldUpdateTemplateFieldFieldMetaInitialsResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldTextAlignResponse1], @@ -1422,14 +1748,42 @@ class FieldUpdateTemplateFieldFieldMetaInitialsResponse(BaseModel): ] = None +class FieldUpdateTemplateFieldFieldMetaTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldUpdateTemplateFieldFieldMetaSignatureResponseTypedDict(TypedDict): + type: FieldUpdateTemplateFieldFieldMetaTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldUpdateTemplateFieldFieldMetaSignatureResponse(BaseModel): + type: FieldUpdateTemplateFieldFieldMetaTypeSignature + + 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")] = 12 + + FieldUpdateTemplateFieldFieldMetaUnionTypedDict = TypeAliasType( "FieldUpdateTemplateFieldFieldMetaUnionTypedDict", Union[ - FieldUpdateTemplateFieldFieldMetaRadioResponseTypedDict, + FieldUpdateTemplateFieldFieldMetaSignatureResponseTypedDict, FieldUpdateTemplateFieldFieldMetaInitialsResponseTypedDict, FieldUpdateTemplateFieldFieldMetaNameResponseTypedDict, FieldUpdateTemplateFieldFieldMetaEmailResponseTypedDict, FieldUpdateTemplateFieldFieldMetaDateResponseTypedDict, + FieldUpdateTemplateFieldFieldMetaRadioResponseTypedDict, FieldUpdateTemplateFieldFieldMetaDropdownResponseTypedDict, FieldUpdateTemplateFieldFieldMetaCheckboxResponseTypedDict, FieldUpdateTemplateFieldFieldMetaTextResponseTypedDict, @@ -1441,11 +1795,12 @@ class FieldUpdateTemplateFieldFieldMetaInitialsResponse(BaseModel): FieldUpdateTemplateFieldFieldMetaUnion = TypeAliasType( "FieldUpdateTemplateFieldFieldMetaUnion", Union[ - FieldUpdateTemplateFieldFieldMetaRadioResponse, + FieldUpdateTemplateFieldFieldMetaSignatureResponse, FieldUpdateTemplateFieldFieldMetaInitialsResponse, FieldUpdateTemplateFieldFieldMetaNameResponse, FieldUpdateTemplateFieldFieldMetaEmailResponse, FieldUpdateTemplateFieldFieldMetaDateResponse, + FieldUpdateTemplateFieldFieldMetaRadioResponse, FieldUpdateTemplateFieldFieldMetaDropdownResponse, FieldUpdateTemplateFieldFieldMetaCheckboxResponse, FieldUpdateTemplateFieldFieldMetaTextResponse, @@ -1457,40 +1812,48 @@ 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[FieldUpdateTemplateFieldFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -1501,18 +1864,18 @@ class FieldUpdateTemplateFieldResponse(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["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..ad6cd11 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 @@ -33,6 +40,7 @@ class FieldUpdateTemplateFieldsFieldMetaDropdownRequestTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldsValueDropdownTypedDict]] default_value: NotRequired[str] @@ -48,6 +56,8 @@ class FieldUpdateTemplateFieldsFieldMetaDropdownRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldsValueDropdown]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -56,25 +66,18 @@ class FieldUpdateTemplateFieldsFieldMetaDropdownRequest(BaseModel): class FieldUpdateTemplateFieldsFieldDropdownTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeDropdownRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldsFieldMetaDropdownRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldDropdown(BaseModel): type: FieldUpdateTemplateFieldsTypeDropdownRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldsFieldMetaDropdownRequest], @@ -82,19 +85,14 @@ class FieldUpdateTemplateFieldsFieldDropdown(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldsTypeCheckboxRequest1(str, Enum): @@ -119,15 +117,22 @@ class FieldUpdateTemplateFieldsValueCheckbox(BaseModel): value: str +class FieldUpdateTemplateFieldsDirectionCheckbox(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldsFieldMetaCheckboxRequestTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeCheckboxRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldsValueCheckboxTypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateTemplateFieldsDirectionCheckbox] class FieldUpdateTemplateFieldsFieldMetaCheckboxRequest(BaseModel): @@ -141,6 +146,8 @@ class FieldUpdateTemplateFieldsFieldMetaCheckboxRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldsValueCheckbox]] = None validation_rule: Annotated[ @@ -151,29 +158,26 @@ class FieldUpdateTemplateFieldsFieldMetaCheckboxRequest(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateTemplateFieldsDirectionCheckbox] = ( + FieldUpdateTemplateFieldsDirectionCheckbox.VERTICAL + ) + class FieldUpdateTemplateFieldsFieldCheckboxTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeCheckboxRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldsFieldMetaCheckboxRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldCheckbox(BaseModel): type: FieldUpdateTemplateFieldsTypeCheckboxRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldsFieldMetaCheckboxRequest], @@ -181,19 +185,14 @@ class FieldUpdateTemplateFieldsFieldCheckbox(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldsTypeRadioRequest1(str, Enum): @@ -218,13 +217,20 @@ class FieldUpdateTemplateFieldsValueRadio(BaseModel): value: str +class FieldUpdateTemplateFieldsDirectionRadio(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldsFieldMetaRadioRequestTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeRadioRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldsValueRadioTypedDict]] + direction: NotRequired[FieldUpdateTemplateFieldsDirectionRadio] class FieldUpdateTemplateFieldsFieldMetaRadioRequest(BaseModel): @@ -238,31 +244,30 @@ class FieldUpdateTemplateFieldsFieldMetaRadioRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldsValueRadio]] = None + direction: Optional[FieldUpdateTemplateFieldsDirectionRadio] = ( + FieldUpdateTemplateFieldsDirectionRadio.VERTICAL + ) + class FieldUpdateTemplateFieldsFieldRadioTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeRadioRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldsFieldMetaRadioRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldRadio(BaseModel): type: FieldUpdateTemplateFieldsTypeRadioRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldsFieldMetaRadioRequest], @@ -270,19 +275,14 @@ class FieldUpdateTemplateFieldsFieldRadio(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldsTypeNumberRequest1(str, Enum): @@ -299,18 +299,27 @@ class FieldUpdateTemplateFieldsTextAlignNumber(str, Enum): RIGHT = "right" +class FieldUpdateTemplateFieldsVerticalAlignNumber(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateTemplateFieldsFieldMetaNumberRequestTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeNumberRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldUpdateTemplateFieldsTextAlignNumber] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldUpdateTemplateFieldsVerticalAlignNumber]] class FieldUpdateTemplateFieldsFieldMetaNumberRequest(BaseModel): @@ -324,44 +333,107 @@ class FieldUpdateTemplateFieldsFieldMetaNumberRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldUpdateTemplateFieldsTextAlignNumber], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateTemplateFieldsVerticalAlignNumber], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldsFieldMetaNumberRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldNumber(BaseModel): type: FieldUpdateTemplateFieldsTypeNumberRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldsFieldMetaNumberRequest], @@ -369,19 +441,14 @@ class FieldUpdateTemplateFieldsFieldNumber(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldsTypeTextRequest1(str, Enum): @@ -398,16 +465,25 @@ class FieldUpdateTemplateFieldsTextAlignText(str, Enum): RIGHT = "right" +class FieldUpdateTemplateFieldsVerticalAlignText(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateTemplateFieldsFieldMetaTextRequestTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeTextRequest2 label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldUpdateTemplateFieldsTextAlignText] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[FieldUpdateTemplateFieldsVerticalAlignText]] class FieldUpdateTemplateFieldsFieldMetaTextRequest(BaseModel): @@ -421,42 +497,90 @@ class FieldUpdateTemplateFieldsFieldMetaTextRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldUpdateTemplateFieldsTextAlignText], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateTemplateFieldsVerticalAlignText], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldUpdateTemplateFieldsFieldTextTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeTextRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldsFieldMetaTextRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldText(BaseModel): type: FieldUpdateTemplateFieldsTypeTextRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldsFieldMetaTextRequest], @@ -464,19 +588,14 @@ class FieldUpdateTemplateFieldsFieldText(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldsTypeDateRequest1(str, Enum): @@ -514,7 +633,7 @@ class FieldUpdateTemplateFieldsFieldMetaDateRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldsTextAlignDate], @@ -525,25 +644,18 @@ class FieldUpdateTemplateFieldsFieldMetaDateRequest(BaseModel): class FieldUpdateTemplateFieldsFieldDateTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeDateRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldsFieldMetaDateRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldDate(BaseModel): type: FieldUpdateTemplateFieldsTypeDateRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldsFieldMetaDateRequest], @@ -551,19 +663,14 @@ class FieldUpdateTemplateFieldsFieldDate(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldsTypeEmailRequest1(str, Enum): @@ -601,7 +708,7 @@ class FieldUpdateTemplateFieldsFieldMetaEmailRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldsTextAlignEmail], @@ -612,25 +719,18 @@ class FieldUpdateTemplateFieldsFieldMetaEmailRequest(BaseModel): class FieldUpdateTemplateFieldsFieldEmailTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeEmailRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldsFieldMetaEmailRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldEmail(BaseModel): type: FieldUpdateTemplateFieldsTypeEmailRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldsFieldMetaEmailRequest], @@ -638,19 +738,14 @@ class FieldUpdateTemplateFieldsFieldEmail(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldsTypeNameRequest1(str, Enum): @@ -688,7 +783,7 @@ class FieldUpdateTemplateFieldsFieldMetaNameRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldsTextAlignName], @@ -699,25 +794,18 @@ class FieldUpdateTemplateFieldsFieldMetaNameRequest(BaseModel): class FieldUpdateTemplateFieldsFieldNameTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeNameRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldsFieldMetaNameRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldName(BaseModel): type: FieldUpdateTemplateFieldsTypeNameRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldsFieldMetaNameRequest], @@ -725,19 +813,14 @@ class FieldUpdateTemplateFieldsFieldName(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldsTypeInitialsRequest1(str, Enum): @@ -775,7 +858,7 @@ class FieldUpdateTemplateFieldsFieldMetaInitialsRequest(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldsTextAlignInitials], @@ -786,25 +869,18 @@ class FieldUpdateTemplateFieldsFieldMetaInitialsRequest(BaseModel): class FieldUpdateTemplateFieldsFieldInitialsTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeInitialsRequest1 id: float - r"""The ID of the field to update.""" field_meta: NotRequired[FieldUpdateTemplateFieldsFieldMetaInitialsRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldInitials(BaseModel): type: FieldUpdateTemplateFieldsTypeInitialsRequest1 id: float - r"""The ID of the field to update.""" field_meta: Annotated[ Optional[FieldUpdateTemplateFieldsFieldMetaInitialsRequest], @@ -812,19 +888,14 @@ class FieldUpdateTemplateFieldsFieldInitials(BaseModel): ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" class FieldUpdateTemplateFieldsTypeFreeSignature(str, Enum): @@ -834,88 +905,97 @@ class FieldUpdateTemplateFieldsTypeFreeSignature(str, Enum): class FieldUpdateTemplateFieldsFieldFreeSignatureTypedDict(TypedDict): type: FieldUpdateTemplateFieldsTypeFreeSignature id: float - r"""The ID of the field to update.""" page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldFreeSignature(BaseModel): type: FieldUpdateTemplateFieldsTypeFreeSignature id: float - r"""The ID of the field to update.""" page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" -class FieldUpdateTemplateFieldsTypeSignature(str, Enum): +class FieldUpdateTemplateFieldsTypeSignatureRequest1(str, Enum): SIGNATURE = "SIGNATURE" +class FieldUpdateTemplateFieldsTypeSignatureRequest2(str, Enum): + SIGNATURE = "signature" + + +class FieldUpdateTemplateFieldsFieldMetaSignatureRequestTypedDict(TypedDict): + type: FieldUpdateTemplateFieldsTypeSignatureRequest2 + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldUpdateTemplateFieldsFieldMetaSignatureRequest(BaseModel): + type: FieldUpdateTemplateFieldsTypeSignatureRequest2 + + 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")] = 12 + + class FieldUpdateTemplateFieldsFieldSignatureTypedDict(TypedDict): - type: FieldUpdateTemplateFieldsTypeSignature + type: FieldUpdateTemplateFieldsTypeSignatureRequest1 id: float - r"""The ID of the field to update.""" + field_meta: NotRequired[FieldUpdateTemplateFieldsFieldMetaSignatureRequestTypedDict] page_number: NotRequired[float] - r"""The page number the field will be on.""" page_x: NotRequired[float] - r"""The X coordinate of where the field will be placed.""" page_y: NotRequired[float] - r"""The Y coordinate of where the field will be placed.""" width: NotRequired[float] - r"""The width of the field.""" height: NotRequired[float] - r"""The height of the field.""" class FieldUpdateTemplateFieldsFieldSignature(BaseModel): - type: FieldUpdateTemplateFieldsTypeSignature + type: FieldUpdateTemplateFieldsTypeSignatureRequest1 id: float - r"""The ID of the field to update.""" + + field_meta: Annotated[ + Optional[FieldUpdateTemplateFieldsFieldMetaSignatureRequest], + pydantic.Field(alias="fieldMeta"), + ] = None page_number: Annotated[Optional[float], pydantic.Field(alias="pageNumber")] = None - r"""The page number the field will be on.""" page_x: Annotated[Optional[float], pydantic.Field(alias="pageX")] = None - r"""The X coordinate of where the field will be placed.""" page_y: Annotated[Optional[float], pydantic.Field(alias="pageY")] = None - r"""The Y coordinate of where the field will be placed.""" width: Optional[float] = None - r"""The width of the field.""" height: Optional[float] = None - r"""The height of the field.""" FieldUpdateTemplateFieldsFieldUnionTypedDict = TypeAliasType( "FieldUpdateTemplateFieldsFieldUnionTypedDict", Union[ - FieldUpdateTemplateFieldsFieldSignatureTypedDict, FieldUpdateTemplateFieldsFieldFreeSignatureTypedDict, + FieldUpdateTemplateFieldsFieldSignatureTypedDict, FieldUpdateTemplateFieldsFieldInitialsTypedDict, FieldUpdateTemplateFieldsFieldNameTypedDict, FieldUpdateTemplateFieldsFieldEmailTypedDict, @@ -932,8 +1012,8 @@ class FieldUpdateTemplateFieldsFieldSignature(BaseModel): FieldUpdateTemplateFieldsFieldUnion = TypeAliasType( "FieldUpdateTemplateFieldsFieldUnion", Union[ - FieldUpdateTemplateFieldsFieldSignature, FieldUpdateTemplateFieldsFieldFreeSignature, + FieldUpdateTemplateFieldsFieldSignature, FieldUpdateTemplateFieldsFieldInitials, FieldUpdateTemplateFieldsFieldName, FieldUpdateTemplateFieldsFieldEmail, @@ -974,10 +1054,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 +1069,75 @@ 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 FieldUpdateTemplateFieldsForbiddenIssueTypedDict(TypedDict): + message: str + + +class FieldUpdateTemplateFieldsForbiddenIssue(BaseModel): + message: str + + +class FieldUpdateTemplateFieldsForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldUpdateTemplateFieldsForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldUpdateTemplateFieldsForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FieldUpdateTemplateFieldsForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FieldUpdateTemplateFieldsForbiddenErrorData, + 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 FieldUpdateTemplateFieldsUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FieldUpdateTemplateFieldsUnauthorizedIssue(BaseModel): + message: str + + +class FieldUpdateTemplateFieldsUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FieldUpdateTemplateFieldsUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FieldUpdateTemplateFieldsUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FieldUpdateTemplateFieldsUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FieldUpdateTemplateFieldsUnauthorizedErrorData, + 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 FieldUpdateTemplateFieldsBadRequestIssueTypedDict(TypedDict): @@ -1007,10 +1156,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 +1171,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): @@ -1056,6 +1206,7 @@ class FieldUpdateTemplateFieldsFieldMetaDropdownResponseTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldsValueResponse3TypedDict]] default_value: NotRequired[str] @@ -1071,6 +1222,8 @@ class FieldUpdateTemplateFieldsFieldMetaDropdownResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldsValueResponse3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -1094,15 +1247,22 @@ class FieldUpdateTemplateFieldsValueResponse2(BaseModel): value: str +class FieldUpdateTemplateFieldsDirectionResponse2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldsFieldMetaCheckboxResponseTypedDict(TypedDict): type: FieldUpdateTemplateFieldsFieldMetaTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldsValueResponse2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[FieldUpdateTemplateFieldsDirectionResponse2] class FieldUpdateTemplateFieldsFieldMetaCheckboxResponse(BaseModel): @@ -1116,6 +1276,8 @@ class FieldUpdateTemplateFieldsFieldMetaCheckboxResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldsValueResponse2]] = None validation_rule: Annotated[ @@ -1126,6 +1288,10 @@ class FieldUpdateTemplateFieldsFieldMetaCheckboxResponse(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[FieldUpdateTemplateFieldsDirectionResponse2] = ( + FieldUpdateTemplateFieldsDirectionResponse2.VERTICAL + ) + class FieldUpdateTemplateFieldsFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -1145,13 +1311,20 @@ class FieldUpdateTemplateFieldsValueResponse1(BaseModel): value: str +class FieldUpdateTemplateFieldsDirectionResponse1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class FieldUpdateTemplateFieldsFieldMetaRadioResponseTypedDict(TypedDict): type: FieldUpdateTemplateFieldsFieldMetaTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[FieldUpdateTemplateFieldsValueResponse1TypedDict]] + direction: NotRequired[FieldUpdateTemplateFieldsDirectionResponse1] class FieldUpdateTemplateFieldsFieldMetaRadioResponse(BaseModel): @@ -1165,8 +1338,14 @@ class FieldUpdateTemplateFieldsFieldMetaRadioResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[FieldUpdateTemplateFieldsValueResponse1]] = None + direction: Optional[FieldUpdateTemplateFieldsDirectionResponse1] = ( + FieldUpdateTemplateFieldsDirectionResponse1.VERTICAL + ) + class FieldUpdateTemplateFieldsFieldMetaTypeNumber(str, Enum): NUMBER = "number" @@ -1178,18 +1357,29 @@ class FieldUpdateTemplateFieldsTextAlignResponse6(str, Enum): RIGHT = "right" +class FieldUpdateTemplateFieldsVerticalAlignResponse2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateTemplateFieldsFieldMetaNumberResponseTypedDict(TypedDict): type: FieldUpdateTemplateFieldsFieldMetaTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[FieldUpdateTemplateFieldsTextAlignResponse6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldUpdateTemplateFieldsVerticalAlignResponse2] + ] class FieldUpdateTemplateFieldsFieldMetaNumberResponse(BaseModel): @@ -1203,21 +1393,91 @@ class FieldUpdateTemplateFieldsFieldMetaNumberResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[FieldUpdateTemplateFieldsTextAlignResponse6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateTemplateFieldsVerticalAlignResponse2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -1229,16 +1489,27 @@ class FieldUpdateTemplateFieldsTextAlignResponse5(str, Enum): RIGHT = "right" +class FieldUpdateTemplateFieldsVerticalAlignResponse1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class FieldUpdateTemplateFieldsFieldMetaTextResponseTypedDict(TypedDict): type: FieldUpdateTemplateFieldsFieldMetaTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[FieldUpdateTemplateFieldsTextAlignResponse5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[FieldUpdateTemplateFieldsVerticalAlignResponse1] + ] class FieldUpdateTemplateFieldsFieldMetaTextResponse(BaseModel): @@ -1252,19 +1523,74 @@ class FieldUpdateTemplateFieldsFieldMetaTextResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[FieldUpdateTemplateFieldsTextAlignResponse5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[FieldUpdateTemplateFieldsVerticalAlignResponse1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 FieldUpdateTemplateFieldsFieldMetaTypeDate(str, Enum): DATE = "date" @@ -1297,7 +1623,7 @@ class FieldUpdateTemplateFieldsFieldMetaDateResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldsTextAlignResponse4], @@ -1336,7 +1662,7 @@ class FieldUpdateTemplateFieldsFieldMetaEmailResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldsTextAlignResponse3], @@ -1375,7 +1701,7 @@ class FieldUpdateTemplateFieldsFieldMetaNameResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldsTextAlignResponse2], @@ -1414,7 +1740,7 @@ class FieldUpdateTemplateFieldsFieldMetaInitialsResponse(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[FieldUpdateTemplateFieldsTextAlignResponse1], @@ -1422,14 +1748,42 @@ class FieldUpdateTemplateFieldsFieldMetaInitialsResponse(BaseModel): ] = None +class FieldUpdateTemplateFieldsFieldMetaTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class FieldUpdateTemplateFieldsFieldMetaSignatureResponseTypedDict(TypedDict): + type: FieldUpdateTemplateFieldsFieldMetaTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class FieldUpdateTemplateFieldsFieldMetaSignatureResponse(BaseModel): + type: FieldUpdateTemplateFieldsFieldMetaTypeSignature + + 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")] = 12 + + FieldUpdateTemplateFieldsFieldMetaUnionTypedDict = TypeAliasType( "FieldUpdateTemplateFieldsFieldMetaUnionTypedDict", Union[ - FieldUpdateTemplateFieldsFieldMetaRadioResponseTypedDict, + FieldUpdateTemplateFieldsFieldMetaSignatureResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaInitialsResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaNameResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaEmailResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaDateResponseTypedDict, + FieldUpdateTemplateFieldsFieldMetaRadioResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaDropdownResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaCheckboxResponseTypedDict, FieldUpdateTemplateFieldsFieldMetaTextResponseTypedDict, @@ -1441,11 +1795,12 @@ class FieldUpdateTemplateFieldsFieldMetaInitialsResponse(BaseModel): FieldUpdateTemplateFieldsFieldMetaUnion = TypeAliasType( "FieldUpdateTemplateFieldsFieldMetaUnion", Union[ - FieldUpdateTemplateFieldsFieldMetaRadioResponse, + FieldUpdateTemplateFieldsFieldMetaSignatureResponse, FieldUpdateTemplateFieldsFieldMetaInitialsResponse, FieldUpdateTemplateFieldsFieldMetaNameResponse, FieldUpdateTemplateFieldsFieldMetaEmailResponse, FieldUpdateTemplateFieldsFieldMetaDateResponse, + FieldUpdateTemplateFieldsFieldMetaRadioResponse, FieldUpdateTemplateFieldsFieldMetaDropdownResponse, FieldUpdateTemplateFieldsFieldMetaCheckboxResponse, FieldUpdateTemplateFieldsFieldMetaTextResponse, @@ -1455,38 +1810,46 @@ class FieldUpdateTemplateFieldsFieldMetaInitialsResponse(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[FieldUpdateTemplateFieldsFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -1497,18 +1860,18 @@ class FieldUpdateTemplateFieldsFieldResponse(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) diff --git a/src/documenso_sdk/models/folder_createfolderop.py b/src/documenso_sdk/models/folder_createfolderop.py new file mode 100644 index 0000000..d914fd8 --- /dev/null +++ b/src/documenso_sdk/models/folder_createfolderop.py @@ -0,0 +1,247 @@ +"""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 +import httpx +import pydantic +from pydantic import model_serializer +from typing import List, Optional +from typing_extensions import Annotated, NotRequired, TypedDict + + +class FolderCreateFolderTypeRequest(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + + +class FolderCreateFolderRequestTypedDict(TypedDict): + name: str + parent_id: NotRequired[str] + type: NotRequired[FolderCreateFolderTypeRequest] + + +class FolderCreateFolderRequest(BaseModel): + name: str + + parent_id: Annotated[Optional[str], pydantic.Field(alias="parentId")] = None + + type: Optional[FolderCreateFolderTypeRequest] = None + + +class FolderCreateFolderInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class FolderCreateFolderInternalServerErrorIssue(BaseModel): + message: str + + +class FolderCreateFolderInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderCreateFolderInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderCreateFolderInternalServerError(DocumensoError): + r"""Internal server error""" + + data: FolderCreateFolderInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: FolderCreateFolderInternalServerErrorData, + 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 FolderCreateFolderForbiddenIssueTypedDict(TypedDict): + message: str + + +class FolderCreateFolderForbiddenIssue(BaseModel): + message: str + + +class FolderCreateFolderForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderCreateFolderForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderCreateFolderForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FolderCreateFolderForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FolderCreateFolderForbiddenErrorData, + 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 FolderCreateFolderUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FolderCreateFolderUnauthorizedIssue(BaseModel): + message: str + + +class FolderCreateFolderUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderCreateFolderUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderCreateFolderUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FolderCreateFolderUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FolderCreateFolderUnauthorizedErrorData, + 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 FolderCreateFolderBadRequestIssueTypedDict(TypedDict): + message: str + + +class FolderCreateFolderBadRequestIssue(BaseModel): + message: str + + +class FolderCreateFolderBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderCreateFolderBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderCreateFolderBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: FolderCreateFolderBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: FolderCreateFolderBadRequestErrorData, + 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 FolderCreateFolderVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class FolderCreateFolderTypeResponse(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + + +class FolderCreateFolderResponseTypedDict(TypedDict): + r"""Successful response""" + + id: str + name: str + user_id: float + team_id: float + parent_id: Nullable[str] + pinned: bool + created_at: str + updated_at: str + visibility: FolderCreateFolderVisibility + type: FolderCreateFolderTypeResponse + + +class FolderCreateFolderResponse(BaseModel): + r"""Successful response""" + + id: str + + name: str + + user_id: Annotated[float, pydantic.Field(alias="userId")] + + team_id: Annotated[float, pydantic.Field(alias="teamId")] + + parent_id: Annotated[Nullable[str], pydantic.Field(alias="parentId")] + + pinned: bool + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] + + visibility: FolderCreateFolderVisibility + + type: FolderCreateFolderTypeResponse + + @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 diff --git a/src/documenso_sdk/models/folder_deletefolderop.py b/src/documenso_sdk/models/folder_deletefolderop.py new file mode 100644 index 0000000..31e044a --- /dev/null +++ b/src/documenso_sdk/models/folder_deletefolderop.py @@ -0,0 +1,166 @@ +"""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 FolderDeleteFolderRequestTypedDict(TypedDict): + folder_id: str + + +class FolderDeleteFolderRequest(BaseModel): + folder_id: Annotated[str, pydantic.Field(alias="folderId")] + + +class FolderDeleteFolderInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class FolderDeleteFolderInternalServerErrorIssue(BaseModel): + message: str + + +class FolderDeleteFolderInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderDeleteFolderInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderDeleteFolderInternalServerError(DocumensoError): + r"""Internal server error""" + + data: FolderDeleteFolderInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: FolderDeleteFolderInternalServerErrorData, + 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 FolderDeleteFolderForbiddenIssueTypedDict(TypedDict): + message: str + + +class FolderDeleteFolderForbiddenIssue(BaseModel): + message: str + + +class FolderDeleteFolderForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderDeleteFolderForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderDeleteFolderForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FolderDeleteFolderForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FolderDeleteFolderForbiddenErrorData, + 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 FolderDeleteFolderUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FolderDeleteFolderUnauthorizedIssue(BaseModel): + message: str + + +class FolderDeleteFolderUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderDeleteFolderUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderDeleteFolderUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FolderDeleteFolderUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FolderDeleteFolderUnauthorizedErrorData, + 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 FolderDeleteFolderBadRequestIssueTypedDict(TypedDict): + message: str + + +class FolderDeleteFolderBadRequestIssue(BaseModel): + message: str + + +class FolderDeleteFolderBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderDeleteFolderBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderDeleteFolderBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: FolderDeleteFolderBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: FolderDeleteFolderBadRequestErrorData, + 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 FolderDeleteFolderResponseTypedDict(TypedDict): + r"""Successful response""" + + success: bool + + +class FolderDeleteFolderResponse(BaseModel): + r"""Successful response""" + + success: bool diff --git a/src/documenso_sdk/models/folder_findfoldersop.py b/src/documenso_sdk/models/folder_findfoldersop.py new file mode 100644 index 0000000..6fd71bf --- /dev/null +++ b/src/documenso_sdk/models/folder_findfoldersop.py @@ -0,0 +1,331 @@ +"""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, QueryParamMetadata +from enum import Enum +import httpx +import pydantic +from pydantic import model_serializer +from typing import List, Optional +from typing_extensions import Annotated, NotRequired, TypedDict + + +class FolderFindFoldersQueryParamType(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + + +class FolderFindFoldersRequestTypedDict(TypedDict): + query: NotRequired[str] + r"""The search query.""" + page: NotRequired[float] + r"""The pagination page number, starts at 1.""" + per_page: NotRequired[float] + r"""The number of items per page.""" + parent_id: NotRequired[str] + type: NotRequired[FolderFindFoldersQueryParamType] + + +class FolderFindFoldersRequest(BaseModel): + query: Annotated[ + Optional[str], + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = None + r"""The search query.""" + + page: Annotated[ + Optional[float], + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = None + r"""The pagination page number, starts at 1.""" + + per_page: Annotated[ + Optional[float], + pydantic.Field(alias="perPage"), + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = None + r"""The number of items per page.""" + + parent_id: Annotated[ + Optional[str], + pydantic.Field(alias="parentId"), + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = None + + type: Annotated[ + Optional[FolderFindFoldersQueryParamType], + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = None + + +class FolderFindFoldersInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class FolderFindFoldersInternalServerErrorIssue(BaseModel): + message: str + + +class FolderFindFoldersInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderFindFoldersInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderFindFoldersInternalServerError(DocumensoError): + r"""Internal server error""" + + data: FolderFindFoldersInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: FolderFindFoldersInternalServerErrorData, + 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 FolderFindFoldersNotFoundIssueTypedDict(TypedDict): + message: str + + +class FolderFindFoldersNotFoundIssue(BaseModel): + message: str + + +class FolderFindFoldersNotFoundErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderFindFoldersNotFoundIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderFindFoldersNotFoundError(DocumensoError): + r"""Not found""" + + data: FolderFindFoldersNotFoundErrorData = field(hash=False) + + def __init__( + self, + data: FolderFindFoldersNotFoundErrorData, + 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 FolderFindFoldersForbiddenIssueTypedDict(TypedDict): + message: str + + +class FolderFindFoldersForbiddenIssue(BaseModel): + message: str + + +class FolderFindFoldersForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderFindFoldersForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderFindFoldersForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FolderFindFoldersForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FolderFindFoldersForbiddenErrorData, + 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 FolderFindFoldersUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FolderFindFoldersUnauthorizedIssue(BaseModel): + message: str + + +class FolderFindFoldersUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderFindFoldersUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderFindFoldersUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FolderFindFoldersUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FolderFindFoldersUnauthorizedErrorData, + 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 FolderFindFoldersBadRequestIssueTypedDict(TypedDict): + message: str + + +class FolderFindFoldersBadRequestIssue(BaseModel): + message: str + + +class FolderFindFoldersBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderFindFoldersBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderFindFoldersBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: FolderFindFoldersBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: FolderFindFoldersBadRequestErrorData, + 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 FolderFindFoldersVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class FolderFindFoldersDataType(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + + +class FolderFindFoldersDataTypedDict(TypedDict): + id: str + name: str + user_id: float + team_id: float + parent_id: Nullable[str] + pinned: bool + created_at: str + updated_at: str + visibility: FolderFindFoldersVisibility + type: FolderFindFoldersDataType + + +class FolderFindFoldersData(BaseModel): + id: str + + name: str + + user_id: Annotated[float, pydantic.Field(alias="userId")] + + team_id: Annotated[float, pydantic.Field(alias="teamId")] + + parent_id: Annotated[Nullable[str], pydantic.Field(alias="parentId")] + + pinned: bool + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] + + visibility: FolderFindFoldersVisibility + + type: FolderFindFoldersDataType + + @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 FolderFindFoldersResponseTypedDict(TypedDict): + r"""Successful response""" + + data: List[FolderFindFoldersDataTypedDict] + count: float + current_page: float + per_page: float + total_pages: float + + +class FolderFindFoldersResponse(BaseModel): + r"""Successful response""" + + data: List[FolderFindFoldersData] + + count: float + + current_page: Annotated[float, pydantic.Field(alias="currentPage")] + + per_page: Annotated[float, pydantic.Field(alias="perPage")] + + total_pages: Annotated[float, pydantic.Field(alias="totalPages")] diff --git a/src/documenso_sdk/models/folder_updatefolderop.py b/src/documenso_sdk/models/folder_updatefolderop.py new file mode 100644 index 0000000..1ccca43 --- /dev/null +++ b/src/documenso_sdk/models/folder_updatefolderop.py @@ -0,0 +1,300 @@ +"""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 List, Optional +from typing_extensions import Annotated, NotRequired, TypedDict + + +class FolderUpdateFolderDataVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class FolderUpdateFolderDataTypedDict(TypedDict): + name: NotRequired[str] + parent_id: NotRequired[Nullable[str]] + visibility: NotRequired[FolderUpdateFolderDataVisibility] + pinned: NotRequired[bool] + + +class FolderUpdateFolderData(BaseModel): + name: Optional[str] = None + + parent_id: Annotated[OptionalNullable[str], pydantic.Field(alias="parentId")] = ( + UNSET + ) + + visibility: Optional[FolderUpdateFolderDataVisibility] = None + + pinned: Optional[bool] = None + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["name", "parentId", "visibility", "pinned"] + 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 FolderUpdateFolderRequestTypedDict(TypedDict): + folder_id: str + data: FolderUpdateFolderDataTypedDict + + +class FolderUpdateFolderRequest(BaseModel): + folder_id: Annotated[str, pydantic.Field(alias="folderId")] + + data: FolderUpdateFolderData + + +class FolderUpdateFolderInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class FolderUpdateFolderInternalServerErrorIssue(BaseModel): + message: str + + +class FolderUpdateFolderInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderUpdateFolderInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderUpdateFolderInternalServerError(DocumensoError): + r"""Internal server error""" + + data: FolderUpdateFolderInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: FolderUpdateFolderInternalServerErrorData, + 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 FolderUpdateFolderForbiddenIssueTypedDict(TypedDict): + message: str + + +class FolderUpdateFolderForbiddenIssue(BaseModel): + message: str + + +class FolderUpdateFolderForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderUpdateFolderForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderUpdateFolderForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: FolderUpdateFolderForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: FolderUpdateFolderForbiddenErrorData, + 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 FolderUpdateFolderUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class FolderUpdateFolderUnauthorizedIssue(BaseModel): + message: str + + +class FolderUpdateFolderUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderUpdateFolderUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderUpdateFolderUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: FolderUpdateFolderUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: FolderUpdateFolderUnauthorizedErrorData, + 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 FolderUpdateFolderBadRequestIssueTypedDict(TypedDict): + message: str + + +class FolderUpdateFolderBadRequestIssue(BaseModel): + message: str + + +class FolderUpdateFolderBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[FolderUpdateFolderBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class FolderUpdateFolderBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: FolderUpdateFolderBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: FolderUpdateFolderBadRequestErrorData, + 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 FolderUpdateFolderVisibilityResponse(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class FolderUpdateFolderType(str, Enum): + DOCUMENT = "DOCUMENT" + TEMPLATE = "TEMPLATE" + + +class FolderUpdateFolderResponseTypedDict(TypedDict): + r"""Successful response""" + + id: str + name: str + user_id: float + team_id: float + parent_id: Nullable[str] + pinned: bool + created_at: str + updated_at: str + visibility: FolderUpdateFolderVisibilityResponse + type: FolderUpdateFolderType + + +class FolderUpdateFolderResponse(BaseModel): + r"""Successful response""" + + id: str + + name: str + + user_id: Annotated[float, pydantic.Field(alias="userId")] + + team_id: Annotated[float, pydantic.Field(alias="teamId")] + + parent_id: Annotated[Nullable[str], pydantic.Field(alias="parentId")] + + pinned: bool + + created_at: Annotated[str, pydantic.Field(alias="createdAt")] + + updated_at: Annotated[str, pydantic.Field(alias="updatedAt")] + + visibility: FolderUpdateFolderVisibilityResponse + + type: FolderUpdateFolderType + + @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 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..9493c11 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 @@ -20,14 +27,11 @@ class RecipientCreateDocumentRecipientRoleRequest(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -95,10 +99,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 +114,75 @@ 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 RecipientCreateDocumentRecipientForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientCreateDocumentRecipientForbiddenIssue(BaseModel): + message: str + + +class RecipientCreateDocumentRecipientForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientCreateDocumentRecipientForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientCreateDocumentRecipientForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientCreateDocumentRecipientForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientCreateDocumentRecipientForbiddenErrorData, + 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 RecipientCreateDocumentRecipientUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientCreateDocumentRecipientUnauthorizedIssue(BaseModel): + message: str + + +class RecipientCreateDocumentRecipientUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientCreateDocumentRecipientUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientCreateDocumentRecipientUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientCreateDocumentRecipientUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientCreateDocumentRecipientUnauthorizedErrorData, + 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 RecipientCreateDocumentRecipientBadRequestIssueTypedDict(TypedDict): @@ -128,10 +201,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 +216,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): @@ -170,14 +244,11 @@ class RecipientCreateDocumentRecipientSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -205,13 +276,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 @@ -220,13 +290,16 @@ class RecipientCreateDocumentRecipientResponseTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[RecipientCreateDocumentRecipientAuthOptionsTypedDict] 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 +317,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 @@ -268,22 +337,29 @@ class RecipientCreateDocumentRecipientResponse(BaseModel): ] 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 = [] + 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..fd409c2 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 @@ -20,14 +27,11 @@ class RecipientCreateDocumentRecipientsRoleRequest(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -95,10 +99,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 +114,75 @@ 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 RecipientCreateDocumentRecipientsForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientCreateDocumentRecipientsForbiddenIssue(BaseModel): + message: str + + +class RecipientCreateDocumentRecipientsForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientCreateDocumentRecipientsForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientCreateDocumentRecipientsForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientCreateDocumentRecipientsForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientCreateDocumentRecipientsForbiddenErrorData, + 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 RecipientCreateDocumentRecipientsUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientCreateDocumentRecipientsUnauthorizedIssue(BaseModel): + message: str + + +class RecipientCreateDocumentRecipientsUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientCreateDocumentRecipientsUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientCreateDocumentRecipientsUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientCreateDocumentRecipientsUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientCreateDocumentRecipientsUnauthorizedErrorData, + 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 RecipientCreateDocumentRecipientsBadRequestIssueTypedDict(TypedDict): @@ -128,10 +201,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 +216,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): @@ -170,14 +244,11 @@ class RecipientCreateDocumentRecipientsSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -203,13 +274,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 @@ -218,11 +288,14 @@ class RecipientCreateDocumentRecipientsRecipientResponseTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[RecipientCreateDocumentRecipientsAuthOptionsTypedDict] 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 +313,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 @@ -264,22 +333,29 @@ class RecipientCreateDocumentRecipientsRecipientResponse(BaseModel): ] 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 = [] + 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..00098e3 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 @@ -20,14 +27,11 @@ class RecipientCreateTemplateRecipientRoleRequest(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -95,10 +99,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 +114,75 @@ 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 RecipientCreateTemplateRecipientForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientCreateTemplateRecipientForbiddenIssue(BaseModel): + message: str + + +class RecipientCreateTemplateRecipientForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientCreateTemplateRecipientForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientCreateTemplateRecipientForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientCreateTemplateRecipientForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientCreateTemplateRecipientForbiddenErrorData, + 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 RecipientCreateTemplateRecipientUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientCreateTemplateRecipientUnauthorizedIssue(BaseModel): + message: str + + +class RecipientCreateTemplateRecipientUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientCreateTemplateRecipientUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientCreateTemplateRecipientUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientCreateTemplateRecipientUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientCreateTemplateRecipientUnauthorizedErrorData, + 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 RecipientCreateTemplateRecipientBadRequestIssueTypedDict(TypedDict): @@ -128,10 +201,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 +216,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): @@ -170,14 +244,11 @@ class RecipientCreateTemplateRecipientSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -205,13 +276,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 @@ -220,13 +290,16 @@ class RecipientCreateTemplateRecipientResponseTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[RecipientCreateTemplateRecipientAuthOptionsTypedDict] 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 +317,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 @@ -268,22 +337,29 @@ class RecipientCreateTemplateRecipientResponse(BaseModel): ] 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 = [] + 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..ce885d6 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 @@ -20,14 +27,11 @@ class RecipientCreateTemplateRecipientsRoleRequest(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -95,10 +99,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 +114,75 @@ 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 RecipientCreateTemplateRecipientsForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientCreateTemplateRecipientsForbiddenIssue(BaseModel): + message: str + + +class RecipientCreateTemplateRecipientsForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientCreateTemplateRecipientsForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientCreateTemplateRecipientsForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientCreateTemplateRecipientsForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientCreateTemplateRecipientsForbiddenErrorData, + 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 RecipientCreateTemplateRecipientsUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientCreateTemplateRecipientsUnauthorizedIssue(BaseModel): + message: str + + +class RecipientCreateTemplateRecipientsUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientCreateTemplateRecipientsUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientCreateTemplateRecipientsUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientCreateTemplateRecipientsUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientCreateTemplateRecipientsUnauthorizedErrorData, + 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 RecipientCreateTemplateRecipientsBadRequestIssueTypedDict(TypedDict): @@ -128,10 +201,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 +216,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): @@ -170,14 +244,11 @@ class RecipientCreateTemplateRecipientsSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -203,13 +274,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 @@ -218,11 +288,14 @@ class RecipientCreateTemplateRecipientsRecipientResponseTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[RecipientCreateTemplateRecipientsAuthOptionsTypedDict] 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 +313,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 @@ -264,22 +333,29 @@ class RecipientCreateTemplateRecipientsRecipientResponse(BaseModel): ] 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 = [] + 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..44be951 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,75 @@ 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 RecipientDeleteDocumentRecipientForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientDeleteDocumentRecipientForbiddenIssue(BaseModel): + message: str + + +class RecipientDeleteDocumentRecipientForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientDeleteDocumentRecipientForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientDeleteDocumentRecipientForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientDeleteDocumentRecipientForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientDeleteDocumentRecipientForbiddenErrorData, + 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 RecipientDeleteDocumentRecipientUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientDeleteDocumentRecipientUnauthorizedIssue(BaseModel): + message: str + + +class RecipientDeleteDocumentRecipientUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientDeleteDocumentRecipientUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientDeleteDocumentRecipientUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientDeleteDocumentRecipientUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientDeleteDocumentRecipientUnauthorizedErrorData, + 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 RecipientDeleteDocumentRecipientBadRequestIssueTypedDict(TypedDict): @@ -68,10 +138,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 +153,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..2d160cb 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,75 @@ 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 RecipientDeleteTemplateRecipientForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientDeleteTemplateRecipientForbiddenIssue(BaseModel): + message: str + + +class RecipientDeleteTemplateRecipientForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientDeleteTemplateRecipientForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientDeleteTemplateRecipientForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientDeleteTemplateRecipientForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientDeleteTemplateRecipientForbiddenErrorData, + 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 RecipientDeleteTemplateRecipientUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientDeleteTemplateRecipientUnauthorizedIssue(BaseModel): + message: str + + +class RecipientDeleteTemplateRecipientUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientDeleteTemplateRecipientUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientDeleteTemplateRecipientUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientDeleteTemplateRecipientUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientDeleteTemplateRecipientUnauthorizedErrorData, + 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 RecipientDeleteTemplateRecipientBadRequestIssueTypedDict(TypedDict): @@ -68,10 +138,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 +153,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..ee0e576 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,75 @@ 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 RecipientGetDocumentRecipientForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientGetDocumentRecipientForbiddenIssue(BaseModel): + message: str + + +class RecipientGetDocumentRecipientForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientGetDocumentRecipientForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientGetDocumentRecipientForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientGetDocumentRecipientForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientGetDocumentRecipientForbiddenErrorData, + 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 RecipientGetDocumentRecipientUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientGetDocumentRecipientUnauthorizedIssue(BaseModel): + message: str + + +class RecipientGetDocumentRecipientUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientGetDocumentRecipientUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientGetDocumentRecipientUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientGetDocumentRecipientUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientGetDocumentRecipientUnauthorizedErrorData, + 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 RecipientGetDocumentRecipientBadRequestIssueTypedDict(TypedDict): @@ -106,10 +183,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 +198,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): @@ -148,14 +226,11 @@ class RecipientGetDocumentRecipientSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -212,6 +287,7 @@ class RecipientGetDocumentRecipientFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientGetDocumentRecipientValue3TypedDict]] default_value: NotRequired[str] @@ -227,6 +303,8 @@ class RecipientGetDocumentRecipientFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientGetDocumentRecipientValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -250,15 +328,22 @@ class RecipientGetDocumentRecipientValue2(BaseModel): value: str +class RecipientGetDocumentRecipientDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict(TypedDict): type: RecipientGetDocumentRecipientTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientGetDocumentRecipientValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientGetDocumentRecipientDirection2] class RecipientGetDocumentRecipientFieldMetaCheckbox(BaseModel): @@ -272,6 +357,8 @@ class RecipientGetDocumentRecipientFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientGetDocumentRecipientValue2]] = None validation_rule: Annotated[ @@ -282,6 +369,10 @@ class RecipientGetDocumentRecipientFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientGetDocumentRecipientDirection2] = ( + RecipientGetDocumentRecipientDirection2.VERTICAL + ) + class RecipientGetDocumentRecipientTypeRadio(str, Enum): RADIO = "radio" @@ -301,13 +392,20 @@ class RecipientGetDocumentRecipientValue1(BaseModel): value: str +class RecipientGetDocumentRecipientDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientGetDocumentRecipientFieldMetaRadioTypedDict(TypedDict): type: RecipientGetDocumentRecipientTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientGetDocumentRecipientValue1TypedDict]] + direction: NotRequired[RecipientGetDocumentRecipientDirection1] class RecipientGetDocumentRecipientFieldMetaRadio(BaseModel): @@ -321,8 +419,14 @@ class RecipientGetDocumentRecipientFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientGetDocumentRecipientValue1]] = None + direction: Optional[RecipientGetDocumentRecipientDirection1] = ( + RecipientGetDocumentRecipientDirection1.VERTICAL + ) + class RecipientGetDocumentRecipientTypeNumber(str, Enum): NUMBER = "number" @@ -334,18 +438,27 @@ class RecipientGetDocumentRecipientTextAlign6(str, Enum): RIGHT = "right" +class RecipientGetDocumentRecipientVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientGetDocumentRecipientFieldMetaNumberTypedDict(TypedDict): type: RecipientGetDocumentRecipientTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[RecipientGetDocumentRecipientTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[RecipientGetDocumentRecipientVerticalAlign2]] class RecipientGetDocumentRecipientFieldMetaNumber(BaseModel): @@ -359,21 +472,91 @@ class RecipientGetDocumentRecipientFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[RecipientGetDocumentRecipientTextAlign6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientGetDocumentRecipientVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -385,16 +568,25 @@ class RecipientGetDocumentRecipientTextAlign5(str, Enum): RIGHT = "right" +class RecipientGetDocumentRecipientVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientGetDocumentRecipientFieldMetaTextTypedDict(TypedDict): type: RecipientGetDocumentRecipientTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[RecipientGetDocumentRecipientTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[RecipientGetDocumentRecipientVerticalAlign1]] class RecipientGetDocumentRecipientFieldMetaText(BaseModel): @@ -408,19 +600,74 @@ class RecipientGetDocumentRecipientFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[RecipientGetDocumentRecipientTextAlign5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientGetDocumentRecipientVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 RecipientGetDocumentRecipientTypeDate(str, Enum): DATE = "date" @@ -453,7 +700,7 @@ class RecipientGetDocumentRecipientFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientGetDocumentRecipientTextAlign4], @@ -492,7 +739,7 @@ class RecipientGetDocumentRecipientFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientGetDocumentRecipientTextAlign3], @@ -531,7 +778,7 @@ class RecipientGetDocumentRecipientFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientGetDocumentRecipientTextAlign2], @@ -570,7 +817,7 @@ class RecipientGetDocumentRecipientFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientGetDocumentRecipientTextAlign1], @@ -578,14 +825,42 @@ class RecipientGetDocumentRecipientFieldMetaInitials(BaseModel): ] = None +class RecipientGetDocumentRecipientTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class RecipientGetDocumentRecipientFieldMetaSignatureTypedDict(TypedDict): + type: RecipientGetDocumentRecipientTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class RecipientGetDocumentRecipientFieldMetaSignature(BaseModel): + type: RecipientGetDocumentRecipientTypeSignature + + 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")] = 12 + + RecipientGetDocumentRecipientFieldMetaUnionTypedDict = TypeAliasType( "RecipientGetDocumentRecipientFieldMetaUnionTypedDict", Union[ - RecipientGetDocumentRecipientFieldMetaRadioTypedDict, + RecipientGetDocumentRecipientFieldMetaSignatureTypedDict, RecipientGetDocumentRecipientFieldMetaInitialsTypedDict, RecipientGetDocumentRecipientFieldMetaNameTypedDict, RecipientGetDocumentRecipientFieldMetaEmailTypedDict, RecipientGetDocumentRecipientFieldMetaDateTypedDict, + RecipientGetDocumentRecipientFieldMetaRadioTypedDict, RecipientGetDocumentRecipientFieldMetaDropdownTypedDict, RecipientGetDocumentRecipientFieldMetaCheckboxTypedDict, RecipientGetDocumentRecipientFieldMetaTextTypedDict, @@ -597,11 +872,12 @@ class RecipientGetDocumentRecipientFieldMetaInitials(BaseModel): RecipientGetDocumentRecipientFieldMetaUnion = TypeAliasType( "RecipientGetDocumentRecipientFieldMetaUnion", Union[ - RecipientGetDocumentRecipientFieldMetaRadio, + RecipientGetDocumentRecipientFieldMetaSignature, RecipientGetDocumentRecipientFieldMetaInitials, RecipientGetDocumentRecipientFieldMetaName, RecipientGetDocumentRecipientFieldMetaEmail, RecipientGetDocumentRecipientFieldMetaDate, + RecipientGetDocumentRecipientFieldMetaRadio, RecipientGetDocumentRecipientFieldMetaDropdown, RecipientGetDocumentRecipientFieldMetaCheckbox, RecipientGetDocumentRecipientFieldMetaText, @@ -611,38 +887,46 @@ class RecipientGetDocumentRecipientFieldMetaInitials(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[RecipientGetDocumentRecipientFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -653,18 +937,18 @@ class RecipientGetDocumentRecipientField(BaseModel): pydantic.Field(alias="fieldMeta"), ] - position_x: Annotated[Optional[Any], pydantic.Field(alias="positionX")] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - position_y: Annotated[Optional[Any], pydantic.Field(alias="positionY")] = None - - width: Optional[Any] = None - - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -695,13 +979,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 @@ -710,14 +993,17 @@ class RecipientGetDocumentRecipientResponseTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[RecipientGetDocumentRecipientAuthOptionsTypedDict] 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] 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 +1021,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 @@ -759,24 +1041,31 @@ class RecipientGetDocumentRecipientResponse(BaseModel): ] 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")] 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..be37ac9 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,75 @@ 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 RecipientGetTemplateRecipientForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientGetTemplateRecipientForbiddenIssue(BaseModel): + message: str + + +class RecipientGetTemplateRecipientForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientGetTemplateRecipientForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientGetTemplateRecipientForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientGetTemplateRecipientForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientGetTemplateRecipientForbiddenErrorData, + 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 RecipientGetTemplateRecipientUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientGetTemplateRecipientUnauthorizedIssue(BaseModel): + message: str + + +class RecipientGetTemplateRecipientUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientGetTemplateRecipientUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientGetTemplateRecipientUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientGetTemplateRecipientUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientGetTemplateRecipientUnauthorizedErrorData, + 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 RecipientGetTemplateRecipientBadRequestIssueTypedDict(TypedDict): @@ -106,10 +183,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 +198,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): @@ -148,14 +226,11 @@ class RecipientGetTemplateRecipientSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -212,6 +287,7 @@ class RecipientGetTemplateRecipientFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientGetTemplateRecipientValue3TypedDict]] default_value: NotRequired[str] @@ -227,6 +303,8 @@ class RecipientGetTemplateRecipientFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientGetTemplateRecipientValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -250,15 +328,22 @@ class RecipientGetTemplateRecipientValue2(BaseModel): value: str +class RecipientGetTemplateRecipientDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict(TypedDict): type: RecipientGetTemplateRecipientTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientGetTemplateRecipientValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientGetTemplateRecipientDirection2] class RecipientGetTemplateRecipientFieldMetaCheckbox(BaseModel): @@ -272,6 +357,8 @@ class RecipientGetTemplateRecipientFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientGetTemplateRecipientValue2]] = None validation_rule: Annotated[ @@ -282,6 +369,10 @@ class RecipientGetTemplateRecipientFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientGetTemplateRecipientDirection2] = ( + RecipientGetTemplateRecipientDirection2.VERTICAL + ) + class RecipientGetTemplateRecipientTypeRadio(str, Enum): RADIO = "radio" @@ -301,13 +392,20 @@ class RecipientGetTemplateRecipientValue1(BaseModel): value: str +class RecipientGetTemplateRecipientDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientGetTemplateRecipientFieldMetaRadioTypedDict(TypedDict): type: RecipientGetTemplateRecipientTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientGetTemplateRecipientValue1TypedDict]] + direction: NotRequired[RecipientGetTemplateRecipientDirection1] class RecipientGetTemplateRecipientFieldMetaRadio(BaseModel): @@ -321,8 +419,14 @@ class RecipientGetTemplateRecipientFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientGetTemplateRecipientValue1]] = None + direction: Optional[RecipientGetTemplateRecipientDirection1] = ( + RecipientGetTemplateRecipientDirection1.VERTICAL + ) + class RecipientGetTemplateRecipientTypeNumber(str, Enum): NUMBER = "number" @@ -334,18 +438,27 @@ class RecipientGetTemplateRecipientTextAlign6(str, Enum): RIGHT = "right" +class RecipientGetTemplateRecipientVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientGetTemplateRecipientFieldMetaNumberTypedDict(TypedDict): type: RecipientGetTemplateRecipientTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[RecipientGetTemplateRecipientTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[RecipientGetTemplateRecipientVerticalAlign2]] class RecipientGetTemplateRecipientFieldMetaNumber(BaseModel): @@ -359,21 +472,91 @@ class RecipientGetTemplateRecipientFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[RecipientGetTemplateRecipientTextAlign6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientGetTemplateRecipientVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -385,16 +568,25 @@ class RecipientGetTemplateRecipientTextAlign5(str, Enum): RIGHT = "right" +class RecipientGetTemplateRecipientVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientGetTemplateRecipientFieldMetaTextTypedDict(TypedDict): type: RecipientGetTemplateRecipientTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[RecipientGetTemplateRecipientTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[RecipientGetTemplateRecipientVerticalAlign1]] class RecipientGetTemplateRecipientFieldMetaText(BaseModel): @@ -408,19 +600,74 @@ class RecipientGetTemplateRecipientFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[RecipientGetTemplateRecipientTextAlign5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientGetTemplateRecipientVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 RecipientGetTemplateRecipientTypeDate(str, Enum): DATE = "date" @@ -453,7 +700,7 @@ class RecipientGetTemplateRecipientFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientGetTemplateRecipientTextAlign4], @@ -492,7 +739,7 @@ class RecipientGetTemplateRecipientFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientGetTemplateRecipientTextAlign3], @@ -531,7 +778,7 @@ class RecipientGetTemplateRecipientFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientGetTemplateRecipientTextAlign2], @@ -570,7 +817,7 @@ class RecipientGetTemplateRecipientFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientGetTemplateRecipientTextAlign1], @@ -578,14 +825,42 @@ class RecipientGetTemplateRecipientFieldMetaInitials(BaseModel): ] = None +class RecipientGetTemplateRecipientTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class RecipientGetTemplateRecipientFieldMetaSignatureTypedDict(TypedDict): + type: RecipientGetTemplateRecipientTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class RecipientGetTemplateRecipientFieldMetaSignature(BaseModel): + type: RecipientGetTemplateRecipientTypeSignature + + 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")] = 12 + + RecipientGetTemplateRecipientFieldMetaUnionTypedDict = TypeAliasType( "RecipientGetTemplateRecipientFieldMetaUnionTypedDict", Union[ - RecipientGetTemplateRecipientFieldMetaRadioTypedDict, + RecipientGetTemplateRecipientFieldMetaSignatureTypedDict, RecipientGetTemplateRecipientFieldMetaInitialsTypedDict, RecipientGetTemplateRecipientFieldMetaNameTypedDict, RecipientGetTemplateRecipientFieldMetaEmailTypedDict, RecipientGetTemplateRecipientFieldMetaDateTypedDict, + RecipientGetTemplateRecipientFieldMetaRadioTypedDict, RecipientGetTemplateRecipientFieldMetaDropdownTypedDict, RecipientGetTemplateRecipientFieldMetaCheckboxTypedDict, RecipientGetTemplateRecipientFieldMetaTextTypedDict, @@ -597,11 +872,12 @@ class RecipientGetTemplateRecipientFieldMetaInitials(BaseModel): RecipientGetTemplateRecipientFieldMetaUnion = TypeAliasType( "RecipientGetTemplateRecipientFieldMetaUnion", Union[ - RecipientGetTemplateRecipientFieldMetaRadio, + RecipientGetTemplateRecipientFieldMetaSignature, RecipientGetTemplateRecipientFieldMetaInitials, RecipientGetTemplateRecipientFieldMetaName, RecipientGetTemplateRecipientFieldMetaEmail, RecipientGetTemplateRecipientFieldMetaDate, + RecipientGetTemplateRecipientFieldMetaRadio, RecipientGetTemplateRecipientFieldMetaDropdown, RecipientGetTemplateRecipientFieldMetaCheckbox, RecipientGetTemplateRecipientFieldMetaText, @@ -611,38 +887,46 @@ class RecipientGetTemplateRecipientFieldMetaInitials(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[RecipientGetTemplateRecipientFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -653,18 +937,18 @@ class RecipientGetTemplateRecipientField(BaseModel): pydantic.Field(alias="fieldMeta"), ] - position_x: Annotated[Optional[Any], pydantic.Field(alias="positionX")] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - position_y: Annotated[Optional[Any], pydantic.Field(alias="positionY")] = None - - width: Optional[Any] = None - - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -695,13 +979,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 @@ -710,14 +993,17 @@ class RecipientGetTemplateRecipientResponseTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[RecipientGetTemplateRecipientAuthOptionsTypedDict] 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] 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 +1021,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 @@ -759,24 +1041,31 @@ class RecipientGetTemplateRecipientResponse(BaseModel): ] 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")] 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..e934658 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 @@ -20,14 +27,11 @@ class RecipientUpdateDocumentRecipientRoleRequest(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -37,7 +41,6 @@ class RecipientUpdateDocumentRecipientActionAuthRequest(str, Enum): class RecipientUpdateDocumentRecipientRecipientTypedDict(TypedDict): id: float - r"""The ID of the recipient to update.""" email: NotRequired[str] name: NotRequired[str] role: NotRequired[RecipientUpdateDocumentRecipientRoleRequest] @@ -48,7 +51,6 @@ class RecipientUpdateDocumentRecipientRecipientTypedDict(TypedDict): class RecipientUpdateDocumentRecipientRecipient(BaseModel): id: float - r"""The ID of the recipient to update.""" email: Optional[str] = None @@ -100,10 +102,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 +117,75 @@ 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 RecipientUpdateDocumentRecipientForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientUpdateDocumentRecipientForbiddenIssue(BaseModel): + message: str + + +class RecipientUpdateDocumentRecipientForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientUpdateDocumentRecipientForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientUpdateDocumentRecipientForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientUpdateDocumentRecipientForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientUpdateDocumentRecipientForbiddenErrorData, + 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 RecipientUpdateDocumentRecipientUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientUpdateDocumentRecipientUnauthorizedIssue(BaseModel): + message: str + + +class RecipientUpdateDocumentRecipientUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientUpdateDocumentRecipientUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientUpdateDocumentRecipientUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientUpdateDocumentRecipientUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientUpdateDocumentRecipientUnauthorizedErrorData, + 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 RecipientUpdateDocumentRecipientBadRequestIssueTypedDict(TypedDict): @@ -133,10 +204,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 +219,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): @@ -175,14 +247,11 @@ class RecipientUpdateDocumentRecipientSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -239,6 +308,7 @@ class RecipientUpdateDocumentRecipientFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateDocumentRecipientValue3TypedDict]] default_value: NotRequired[str] @@ -254,6 +324,8 @@ class RecipientUpdateDocumentRecipientFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateDocumentRecipientValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -277,15 +349,22 @@ class RecipientUpdateDocumentRecipientValue2(BaseModel): value: str +class RecipientUpdateDocumentRecipientDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict(TypedDict): type: RecipientUpdateDocumentRecipientTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateDocumentRecipientValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientUpdateDocumentRecipientDirection2] class RecipientUpdateDocumentRecipientFieldMetaCheckbox(BaseModel): @@ -299,6 +378,8 @@ class RecipientUpdateDocumentRecipientFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateDocumentRecipientValue2]] = None validation_rule: Annotated[ @@ -309,6 +390,10 @@ class RecipientUpdateDocumentRecipientFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientUpdateDocumentRecipientDirection2] = ( + RecipientUpdateDocumentRecipientDirection2.VERTICAL + ) + class RecipientUpdateDocumentRecipientTypeRadio(str, Enum): RADIO = "radio" @@ -328,13 +413,20 @@ class RecipientUpdateDocumentRecipientValue1(BaseModel): value: str +class RecipientUpdateDocumentRecipientDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateDocumentRecipientFieldMetaRadioTypedDict(TypedDict): type: RecipientUpdateDocumentRecipientTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateDocumentRecipientValue1TypedDict]] + direction: NotRequired[RecipientUpdateDocumentRecipientDirection1] class RecipientUpdateDocumentRecipientFieldMetaRadio(BaseModel): @@ -348,8 +440,14 @@ class RecipientUpdateDocumentRecipientFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateDocumentRecipientValue1]] = None + direction: Optional[RecipientUpdateDocumentRecipientDirection1] = ( + RecipientUpdateDocumentRecipientDirection1.VERTICAL + ) + class RecipientUpdateDocumentRecipientTypeNumber(str, Enum): NUMBER = "number" @@ -361,18 +459,29 @@ class RecipientUpdateDocumentRecipientTextAlign6(str, Enum): RIGHT = "right" +class RecipientUpdateDocumentRecipientVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientUpdateDocumentRecipientFieldMetaNumberTypedDict(TypedDict): type: RecipientUpdateDocumentRecipientTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[RecipientUpdateDocumentRecipientTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[RecipientUpdateDocumentRecipientVerticalAlign2] + ] class RecipientUpdateDocumentRecipientFieldMetaNumber(BaseModel): @@ -386,21 +495,91 @@ class RecipientUpdateDocumentRecipientFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[RecipientUpdateDocumentRecipientTextAlign6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientUpdateDocumentRecipientVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -412,16 +591,27 @@ class RecipientUpdateDocumentRecipientTextAlign5(str, Enum): RIGHT = "right" +class RecipientUpdateDocumentRecipientVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientUpdateDocumentRecipientFieldMetaTextTypedDict(TypedDict): type: RecipientUpdateDocumentRecipientTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[RecipientUpdateDocumentRecipientTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[RecipientUpdateDocumentRecipientVerticalAlign1] + ] class RecipientUpdateDocumentRecipientFieldMetaText(BaseModel): @@ -435,19 +625,74 @@ class RecipientUpdateDocumentRecipientFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[RecipientUpdateDocumentRecipientTextAlign5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientUpdateDocumentRecipientVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 RecipientUpdateDocumentRecipientTypeDate(str, Enum): DATE = "date" @@ -480,7 +725,7 @@ class RecipientUpdateDocumentRecipientFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateDocumentRecipientTextAlign4], @@ -519,7 +764,7 @@ class RecipientUpdateDocumentRecipientFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateDocumentRecipientTextAlign3], @@ -558,7 +803,7 @@ class RecipientUpdateDocumentRecipientFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateDocumentRecipientTextAlign2], @@ -597,7 +842,7 @@ class RecipientUpdateDocumentRecipientFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateDocumentRecipientTextAlign1], @@ -605,14 +850,42 @@ class RecipientUpdateDocumentRecipientFieldMetaInitials(BaseModel): ] = None +class RecipientUpdateDocumentRecipientTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class RecipientUpdateDocumentRecipientFieldMetaSignatureTypedDict(TypedDict): + type: RecipientUpdateDocumentRecipientTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class RecipientUpdateDocumentRecipientFieldMetaSignature(BaseModel): + type: RecipientUpdateDocumentRecipientTypeSignature + + 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")] = 12 + + RecipientUpdateDocumentRecipientFieldMetaUnionTypedDict = TypeAliasType( "RecipientUpdateDocumentRecipientFieldMetaUnionTypedDict", Union[ - RecipientUpdateDocumentRecipientFieldMetaRadioTypedDict, + RecipientUpdateDocumentRecipientFieldMetaSignatureTypedDict, RecipientUpdateDocumentRecipientFieldMetaInitialsTypedDict, RecipientUpdateDocumentRecipientFieldMetaNameTypedDict, RecipientUpdateDocumentRecipientFieldMetaEmailTypedDict, RecipientUpdateDocumentRecipientFieldMetaDateTypedDict, + RecipientUpdateDocumentRecipientFieldMetaRadioTypedDict, RecipientUpdateDocumentRecipientFieldMetaDropdownTypedDict, RecipientUpdateDocumentRecipientFieldMetaCheckboxTypedDict, RecipientUpdateDocumentRecipientFieldMetaTextTypedDict, @@ -624,11 +897,12 @@ class RecipientUpdateDocumentRecipientFieldMetaInitials(BaseModel): RecipientUpdateDocumentRecipientFieldMetaUnion = TypeAliasType( "RecipientUpdateDocumentRecipientFieldMetaUnion", Union[ - RecipientUpdateDocumentRecipientFieldMetaRadio, + RecipientUpdateDocumentRecipientFieldMetaSignature, RecipientUpdateDocumentRecipientFieldMetaInitials, RecipientUpdateDocumentRecipientFieldMetaName, RecipientUpdateDocumentRecipientFieldMetaEmail, RecipientUpdateDocumentRecipientFieldMetaDate, + RecipientUpdateDocumentRecipientFieldMetaRadio, RecipientUpdateDocumentRecipientFieldMetaDropdown, RecipientUpdateDocumentRecipientFieldMetaCheckbox, RecipientUpdateDocumentRecipientFieldMetaText, @@ -638,38 +912,46 @@ class RecipientUpdateDocumentRecipientFieldMetaInitials(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[RecipientUpdateDocumentRecipientFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -680,18 +962,18 @@ class RecipientUpdateDocumentRecipientField(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -722,13 +1004,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 @@ -737,14 +1018,17 @@ class RecipientUpdateDocumentRecipientResponseTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[RecipientUpdateDocumentRecipientAuthOptionsTypedDict] 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] 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 +1046,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 @@ -786,24 +1066,31 @@ class RecipientUpdateDocumentRecipientResponse(BaseModel): ] 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")] 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..d893a69 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 @@ -20,14 +27,11 @@ class RecipientUpdateDocumentRecipientsRoleRequest(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -37,7 +41,6 @@ class RecipientUpdateDocumentRecipientsActionAuthRequest(str, Enum): class RecipientUpdateDocumentRecipientsRecipientRequestTypedDict(TypedDict): id: float - r"""The ID of the recipient to update.""" email: NotRequired[str] name: NotRequired[str] role: NotRequired[RecipientUpdateDocumentRecipientsRoleRequest] @@ -48,7 +51,6 @@ class RecipientUpdateDocumentRecipientsRecipientRequestTypedDict(TypedDict): class RecipientUpdateDocumentRecipientsRecipientRequest(BaseModel): id: float - r"""The ID of the recipient to update.""" email: Optional[str] = None @@ -100,10 +102,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 +117,75 @@ 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 RecipientUpdateDocumentRecipientsForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientUpdateDocumentRecipientsForbiddenIssue(BaseModel): + message: str + + +class RecipientUpdateDocumentRecipientsForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientUpdateDocumentRecipientsForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientUpdateDocumentRecipientsForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientUpdateDocumentRecipientsForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientUpdateDocumentRecipientsForbiddenErrorData, + 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 RecipientUpdateDocumentRecipientsUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientUpdateDocumentRecipientsUnauthorizedIssue(BaseModel): + message: str + + +class RecipientUpdateDocumentRecipientsUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientUpdateDocumentRecipientsUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientUpdateDocumentRecipientsUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientUpdateDocumentRecipientsUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientUpdateDocumentRecipientsUnauthorizedErrorData, + 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 RecipientUpdateDocumentRecipientsBadRequestIssueTypedDict(TypedDict): @@ -133,10 +204,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 +219,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): @@ -175,14 +247,11 @@ class RecipientUpdateDocumentRecipientsSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -239,6 +308,7 @@ class RecipientUpdateDocumentRecipientsFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateDocumentRecipientsValue3TypedDict]] default_value: NotRequired[str] @@ -254,6 +324,8 @@ class RecipientUpdateDocumentRecipientsFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateDocumentRecipientsValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -277,15 +349,22 @@ class RecipientUpdateDocumentRecipientsValue2(BaseModel): value: str +class RecipientUpdateDocumentRecipientsDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict(TypedDict): type: RecipientUpdateDocumentRecipientsTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateDocumentRecipientsValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientUpdateDocumentRecipientsDirection2] class RecipientUpdateDocumentRecipientsFieldMetaCheckbox(BaseModel): @@ -299,6 +378,8 @@ class RecipientUpdateDocumentRecipientsFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateDocumentRecipientsValue2]] = None validation_rule: Annotated[ @@ -309,6 +390,10 @@ class RecipientUpdateDocumentRecipientsFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientUpdateDocumentRecipientsDirection2] = ( + RecipientUpdateDocumentRecipientsDirection2.VERTICAL + ) + class RecipientUpdateDocumentRecipientsTypeRadio(str, Enum): RADIO = "radio" @@ -328,13 +413,20 @@ class RecipientUpdateDocumentRecipientsValue1(BaseModel): value: str +class RecipientUpdateDocumentRecipientsDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateDocumentRecipientsFieldMetaRadioTypedDict(TypedDict): type: RecipientUpdateDocumentRecipientsTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateDocumentRecipientsValue1TypedDict]] + direction: NotRequired[RecipientUpdateDocumentRecipientsDirection1] class RecipientUpdateDocumentRecipientsFieldMetaRadio(BaseModel): @@ -348,8 +440,14 @@ class RecipientUpdateDocumentRecipientsFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateDocumentRecipientsValue1]] = None + direction: Optional[RecipientUpdateDocumentRecipientsDirection1] = ( + RecipientUpdateDocumentRecipientsDirection1.VERTICAL + ) + class RecipientUpdateDocumentRecipientsTypeNumber(str, Enum): NUMBER = "number" @@ -361,18 +459,29 @@ class RecipientUpdateDocumentRecipientsTextAlign6(str, Enum): RIGHT = "right" +class RecipientUpdateDocumentRecipientsVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientUpdateDocumentRecipientsFieldMetaNumberTypedDict(TypedDict): type: RecipientUpdateDocumentRecipientsTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[RecipientUpdateDocumentRecipientsTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[RecipientUpdateDocumentRecipientsVerticalAlign2] + ] class RecipientUpdateDocumentRecipientsFieldMetaNumber(BaseModel): @@ -386,21 +495,91 @@ class RecipientUpdateDocumentRecipientsFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[RecipientUpdateDocumentRecipientsTextAlign6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientUpdateDocumentRecipientsVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -412,16 +591,27 @@ class RecipientUpdateDocumentRecipientsTextAlign5(str, Enum): RIGHT = "right" +class RecipientUpdateDocumentRecipientsVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientUpdateDocumentRecipientsFieldMetaTextTypedDict(TypedDict): type: RecipientUpdateDocumentRecipientsTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[RecipientUpdateDocumentRecipientsTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[RecipientUpdateDocumentRecipientsVerticalAlign1] + ] class RecipientUpdateDocumentRecipientsFieldMetaText(BaseModel): @@ -435,19 +625,74 @@ class RecipientUpdateDocumentRecipientsFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[RecipientUpdateDocumentRecipientsTextAlign5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientUpdateDocumentRecipientsVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 RecipientUpdateDocumentRecipientsTypeDate(str, Enum): DATE = "date" @@ -480,7 +725,7 @@ class RecipientUpdateDocumentRecipientsFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateDocumentRecipientsTextAlign4], @@ -519,7 +764,7 @@ class RecipientUpdateDocumentRecipientsFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateDocumentRecipientsTextAlign3], @@ -558,7 +803,7 @@ class RecipientUpdateDocumentRecipientsFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateDocumentRecipientsTextAlign2], @@ -597,7 +842,7 @@ class RecipientUpdateDocumentRecipientsFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateDocumentRecipientsTextAlign1], @@ -605,14 +850,42 @@ class RecipientUpdateDocumentRecipientsFieldMetaInitials(BaseModel): ] = None +class RecipientUpdateDocumentRecipientsTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class RecipientUpdateDocumentRecipientsFieldMetaSignatureTypedDict(TypedDict): + type: RecipientUpdateDocumentRecipientsTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class RecipientUpdateDocumentRecipientsFieldMetaSignature(BaseModel): + type: RecipientUpdateDocumentRecipientsTypeSignature + + 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")] = 12 + + RecipientUpdateDocumentRecipientsFieldMetaUnionTypedDict = TypeAliasType( "RecipientUpdateDocumentRecipientsFieldMetaUnionTypedDict", Union[ - RecipientUpdateDocumentRecipientsFieldMetaRadioTypedDict, + RecipientUpdateDocumentRecipientsFieldMetaSignatureTypedDict, RecipientUpdateDocumentRecipientsFieldMetaInitialsTypedDict, RecipientUpdateDocumentRecipientsFieldMetaNameTypedDict, RecipientUpdateDocumentRecipientsFieldMetaEmailTypedDict, RecipientUpdateDocumentRecipientsFieldMetaDateTypedDict, + RecipientUpdateDocumentRecipientsFieldMetaRadioTypedDict, RecipientUpdateDocumentRecipientsFieldMetaDropdownTypedDict, RecipientUpdateDocumentRecipientsFieldMetaCheckboxTypedDict, RecipientUpdateDocumentRecipientsFieldMetaTextTypedDict, @@ -624,11 +897,12 @@ class RecipientUpdateDocumentRecipientsFieldMetaInitials(BaseModel): RecipientUpdateDocumentRecipientsFieldMetaUnion = TypeAliasType( "RecipientUpdateDocumentRecipientsFieldMetaUnion", Union[ - RecipientUpdateDocumentRecipientsFieldMetaRadio, + RecipientUpdateDocumentRecipientsFieldMetaSignature, RecipientUpdateDocumentRecipientsFieldMetaInitials, RecipientUpdateDocumentRecipientsFieldMetaName, RecipientUpdateDocumentRecipientsFieldMetaEmail, RecipientUpdateDocumentRecipientsFieldMetaDate, + RecipientUpdateDocumentRecipientsFieldMetaRadio, RecipientUpdateDocumentRecipientsFieldMetaDropdown, RecipientUpdateDocumentRecipientsFieldMetaCheckbox, RecipientUpdateDocumentRecipientsFieldMetaText, @@ -638,38 +912,46 @@ class RecipientUpdateDocumentRecipientsFieldMetaInitials(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[RecipientUpdateDocumentRecipientsFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -680,18 +962,18 @@ class RecipientUpdateDocumentRecipientsField(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -720,13 +1002,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 @@ -735,12 +1016,15 @@ class RecipientUpdateDocumentRecipientsRecipientResponseTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[RecipientUpdateDocumentRecipientsAuthOptionsTypedDict] 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] 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 +1042,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 @@ -782,24 +1062,31 @@ class RecipientUpdateDocumentRecipientsRecipientResponse(BaseModel): ] 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")] 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..e4bc50b 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 @@ -20,14 +27,11 @@ class RecipientUpdateTemplateRecipientRoleRequest(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -37,7 +41,6 @@ class RecipientUpdateTemplateRecipientActionAuthRequest(str, Enum): class RecipientUpdateTemplateRecipientRecipientTypedDict(TypedDict): id: float - r"""The ID of the recipient to update.""" email: NotRequired[str] name: NotRequired[str] role: NotRequired[RecipientUpdateTemplateRecipientRoleRequest] @@ -48,7 +51,6 @@ class RecipientUpdateTemplateRecipientRecipientTypedDict(TypedDict): class RecipientUpdateTemplateRecipientRecipient(BaseModel): id: float - r"""The ID of the recipient to update.""" email: Optional[str] = None @@ -100,10 +102,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 +117,75 @@ 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 RecipientUpdateTemplateRecipientForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientUpdateTemplateRecipientForbiddenIssue(BaseModel): + message: str + + +class RecipientUpdateTemplateRecipientForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientUpdateTemplateRecipientForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientUpdateTemplateRecipientForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientUpdateTemplateRecipientForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientUpdateTemplateRecipientForbiddenErrorData, + 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 RecipientUpdateTemplateRecipientUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientUpdateTemplateRecipientUnauthorizedIssue(BaseModel): + message: str + + +class RecipientUpdateTemplateRecipientUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientUpdateTemplateRecipientUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientUpdateTemplateRecipientUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientUpdateTemplateRecipientUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientUpdateTemplateRecipientUnauthorizedErrorData, + 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 RecipientUpdateTemplateRecipientBadRequestIssueTypedDict(TypedDict): @@ -133,10 +204,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 +219,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): @@ -175,14 +247,11 @@ class RecipientUpdateTemplateRecipientSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -239,6 +308,7 @@ class RecipientUpdateTemplateRecipientFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateTemplateRecipientValue3TypedDict]] default_value: NotRequired[str] @@ -254,6 +324,8 @@ class RecipientUpdateTemplateRecipientFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateTemplateRecipientValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -277,15 +349,22 @@ class RecipientUpdateTemplateRecipientValue2(BaseModel): value: str +class RecipientUpdateTemplateRecipientDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict(TypedDict): type: RecipientUpdateTemplateRecipientTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateTemplateRecipientValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientUpdateTemplateRecipientDirection2] class RecipientUpdateTemplateRecipientFieldMetaCheckbox(BaseModel): @@ -299,6 +378,8 @@ class RecipientUpdateTemplateRecipientFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateTemplateRecipientValue2]] = None validation_rule: Annotated[ @@ -309,6 +390,10 @@ class RecipientUpdateTemplateRecipientFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientUpdateTemplateRecipientDirection2] = ( + RecipientUpdateTemplateRecipientDirection2.VERTICAL + ) + class RecipientUpdateTemplateRecipientTypeRadio(str, Enum): RADIO = "radio" @@ -328,13 +413,20 @@ class RecipientUpdateTemplateRecipientValue1(BaseModel): value: str +class RecipientUpdateTemplateRecipientDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateTemplateRecipientFieldMetaRadioTypedDict(TypedDict): type: RecipientUpdateTemplateRecipientTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateTemplateRecipientValue1TypedDict]] + direction: NotRequired[RecipientUpdateTemplateRecipientDirection1] class RecipientUpdateTemplateRecipientFieldMetaRadio(BaseModel): @@ -348,8 +440,14 @@ class RecipientUpdateTemplateRecipientFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateTemplateRecipientValue1]] = None + direction: Optional[RecipientUpdateTemplateRecipientDirection1] = ( + RecipientUpdateTemplateRecipientDirection1.VERTICAL + ) + class RecipientUpdateTemplateRecipientTypeNumber(str, Enum): NUMBER = "number" @@ -361,18 +459,29 @@ class RecipientUpdateTemplateRecipientTextAlign6(str, Enum): RIGHT = "right" +class RecipientUpdateTemplateRecipientVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientUpdateTemplateRecipientFieldMetaNumberTypedDict(TypedDict): type: RecipientUpdateTemplateRecipientTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[RecipientUpdateTemplateRecipientTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[RecipientUpdateTemplateRecipientVerticalAlign2] + ] class RecipientUpdateTemplateRecipientFieldMetaNumber(BaseModel): @@ -386,21 +495,91 @@ class RecipientUpdateTemplateRecipientFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[RecipientUpdateTemplateRecipientTextAlign6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientUpdateTemplateRecipientVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -412,16 +591,27 @@ class RecipientUpdateTemplateRecipientTextAlign5(str, Enum): RIGHT = "right" +class RecipientUpdateTemplateRecipientVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientUpdateTemplateRecipientFieldMetaTextTypedDict(TypedDict): type: RecipientUpdateTemplateRecipientTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[RecipientUpdateTemplateRecipientTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[RecipientUpdateTemplateRecipientVerticalAlign1] + ] class RecipientUpdateTemplateRecipientFieldMetaText(BaseModel): @@ -435,19 +625,74 @@ class RecipientUpdateTemplateRecipientFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[RecipientUpdateTemplateRecipientTextAlign5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientUpdateTemplateRecipientVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 RecipientUpdateTemplateRecipientTypeDate(str, Enum): DATE = "date" @@ -480,7 +725,7 @@ class RecipientUpdateTemplateRecipientFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateTemplateRecipientTextAlign4], @@ -519,7 +764,7 @@ class RecipientUpdateTemplateRecipientFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateTemplateRecipientTextAlign3], @@ -558,7 +803,7 @@ class RecipientUpdateTemplateRecipientFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateTemplateRecipientTextAlign2], @@ -597,7 +842,7 @@ class RecipientUpdateTemplateRecipientFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateTemplateRecipientTextAlign1], @@ -605,14 +850,42 @@ class RecipientUpdateTemplateRecipientFieldMetaInitials(BaseModel): ] = None +class RecipientUpdateTemplateRecipientTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class RecipientUpdateTemplateRecipientFieldMetaSignatureTypedDict(TypedDict): + type: RecipientUpdateTemplateRecipientTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class RecipientUpdateTemplateRecipientFieldMetaSignature(BaseModel): + type: RecipientUpdateTemplateRecipientTypeSignature + + 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")] = 12 + + RecipientUpdateTemplateRecipientFieldMetaUnionTypedDict = TypeAliasType( "RecipientUpdateTemplateRecipientFieldMetaUnionTypedDict", Union[ - RecipientUpdateTemplateRecipientFieldMetaRadioTypedDict, + RecipientUpdateTemplateRecipientFieldMetaSignatureTypedDict, RecipientUpdateTemplateRecipientFieldMetaInitialsTypedDict, RecipientUpdateTemplateRecipientFieldMetaNameTypedDict, RecipientUpdateTemplateRecipientFieldMetaEmailTypedDict, RecipientUpdateTemplateRecipientFieldMetaDateTypedDict, + RecipientUpdateTemplateRecipientFieldMetaRadioTypedDict, RecipientUpdateTemplateRecipientFieldMetaDropdownTypedDict, RecipientUpdateTemplateRecipientFieldMetaCheckboxTypedDict, RecipientUpdateTemplateRecipientFieldMetaTextTypedDict, @@ -624,11 +897,12 @@ class RecipientUpdateTemplateRecipientFieldMetaInitials(BaseModel): RecipientUpdateTemplateRecipientFieldMetaUnion = TypeAliasType( "RecipientUpdateTemplateRecipientFieldMetaUnion", Union[ - RecipientUpdateTemplateRecipientFieldMetaRadio, + RecipientUpdateTemplateRecipientFieldMetaSignature, RecipientUpdateTemplateRecipientFieldMetaInitials, RecipientUpdateTemplateRecipientFieldMetaName, RecipientUpdateTemplateRecipientFieldMetaEmail, RecipientUpdateTemplateRecipientFieldMetaDate, + RecipientUpdateTemplateRecipientFieldMetaRadio, RecipientUpdateTemplateRecipientFieldMetaDropdown, RecipientUpdateTemplateRecipientFieldMetaCheckbox, RecipientUpdateTemplateRecipientFieldMetaText, @@ -638,38 +912,46 @@ class RecipientUpdateTemplateRecipientFieldMetaInitials(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[RecipientUpdateTemplateRecipientFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -680,18 +962,18 @@ class RecipientUpdateTemplateRecipientField(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -722,13 +1004,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 @@ -737,14 +1018,17 @@ class RecipientUpdateTemplateRecipientResponseTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[RecipientUpdateTemplateRecipientAuthOptionsTypedDict] 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] 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 +1046,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 @@ -786,24 +1066,31 @@ class RecipientUpdateTemplateRecipientResponse(BaseModel): ] 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")] 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..8bed987 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 @@ -20,14 +27,11 @@ class RecipientUpdateTemplateRecipientsRoleRequest(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -37,7 +41,6 @@ class RecipientUpdateTemplateRecipientsActionAuthRequest(str, Enum): class RecipientUpdateTemplateRecipientsRecipientRequestTypedDict(TypedDict): id: float - r"""The ID of the recipient to update.""" email: NotRequired[str] name: NotRequired[str] role: NotRequired[RecipientUpdateTemplateRecipientsRoleRequest] @@ -48,7 +51,6 @@ class RecipientUpdateTemplateRecipientsRecipientRequestTypedDict(TypedDict): class RecipientUpdateTemplateRecipientsRecipientRequest(BaseModel): id: float - r"""The ID of the recipient to update.""" email: Optional[str] = None @@ -100,10 +102,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 +117,75 @@ 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 RecipientUpdateTemplateRecipientsForbiddenIssueTypedDict(TypedDict): + message: str + + +class RecipientUpdateTemplateRecipientsForbiddenIssue(BaseModel): + message: str + + +class RecipientUpdateTemplateRecipientsForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientUpdateTemplateRecipientsForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientUpdateTemplateRecipientsForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: RecipientUpdateTemplateRecipientsForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: RecipientUpdateTemplateRecipientsForbiddenErrorData, + 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 RecipientUpdateTemplateRecipientsUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class RecipientUpdateTemplateRecipientsUnauthorizedIssue(BaseModel): + message: str + + +class RecipientUpdateTemplateRecipientsUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[RecipientUpdateTemplateRecipientsUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class RecipientUpdateTemplateRecipientsUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: RecipientUpdateTemplateRecipientsUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: RecipientUpdateTemplateRecipientsUnauthorizedErrorData, + 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 RecipientUpdateTemplateRecipientsBadRequestIssueTypedDict(TypedDict): @@ -133,10 +204,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 +219,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): @@ -175,14 +247,11 @@ class RecipientUpdateTemplateRecipientsSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -239,6 +308,7 @@ class RecipientUpdateTemplateRecipientsFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateTemplateRecipientsValue3TypedDict]] default_value: NotRequired[str] @@ -254,6 +324,8 @@ class RecipientUpdateTemplateRecipientsFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateTemplateRecipientsValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -277,15 +349,22 @@ class RecipientUpdateTemplateRecipientsValue2(BaseModel): value: str +class RecipientUpdateTemplateRecipientsDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict(TypedDict): type: RecipientUpdateTemplateRecipientsTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateTemplateRecipientsValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[RecipientUpdateTemplateRecipientsDirection2] class RecipientUpdateTemplateRecipientsFieldMetaCheckbox(BaseModel): @@ -299,6 +378,8 @@ class RecipientUpdateTemplateRecipientsFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateTemplateRecipientsValue2]] = None validation_rule: Annotated[ @@ -309,6 +390,10 @@ class RecipientUpdateTemplateRecipientsFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[RecipientUpdateTemplateRecipientsDirection2] = ( + RecipientUpdateTemplateRecipientsDirection2.VERTICAL + ) + class RecipientUpdateTemplateRecipientsTypeRadio(str, Enum): RADIO = "radio" @@ -328,13 +413,20 @@ class RecipientUpdateTemplateRecipientsValue1(BaseModel): value: str +class RecipientUpdateTemplateRecipientsDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class RecipientUpdateTemplateRecipientsFieldMetaRadioTypedDict(TypedDict): type: RecipientUpdateTemplateRecipientsTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[RecipientUpdateTemplateRecipientsValue1TypedDict]] + direction: NotRequired[RecipientUpdateTemplateRecipientsDirection1] class RecipientUpdateTemplateRecipientsFieldMetaRadio(BaseModel): @@ -348,8 +440,14 @@ class RecipientUpdateTemplateRecipientsFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[RecipientUpdateTemplateRecipientsValue1]] = None + direction: Optional[RecipientUpdateTemplateRecipientsDirection1] = ( + RecipientUpdateTemplateRecipientsDirection1.VERTICAL + ) + class RecipientUpdateTemplateRecipientsTypeNumber(str, Enum): NUMBER = "number" @@ -361,18 +459,29 @@ class RecipientUpdateTemplateRecipientsTextAlign6(str, Enum): RIGHT = "right" +class RecipientUpdateTemplateRecipientsVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientUpdateTemplateRecipientsFieldMetaNumberTypedDict(TypedDict): type: RecipientUpdateTemplateRecipientsTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[RecipientUpdateTemplateRecipientsTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[RecipientUpdateTemplateRecipientsVerticalAlign2] + ] class RecipientUpdateTemplateRecipientsFieldMetaNumber(BaseModel): @@ -386,21 +495,91 @@ class RecipientUpdateTemplateRecipientsFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[RecipientUpdateTemplateRecipientsTextAlign6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientUpdateTemplateRecipientsVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -412,16 +591,27 @@ class RecipientUpdateTemplateRecipientsTextAlign5(str, Enum): RIGHT = "right" +class RecipientUpdateTemplateRecipientsVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class RecipientUpdateTemplateRecipientsFieldMetaTextTypedDict(TypedDict): type: RecipientUpdateTemplateRecipientsTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[RecipientUpdateTemplateRecipientsTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[RecipientUpdateTemplateRecipientsVerticalAlign1] + ] class RecipientUpdateTemplateRecipientsFieldMetaText(BaseModel): @@ -435,19 +625,74 @@ class RecipientUpdateTemplateRecipientsFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[RecipientUpdateTemplateRecipientsTextAlign5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[RecipientUpdateTemplateRecipientsVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 RecipientUpdateTemplateRecipientsTypeDate(str, Enum): DATE = "date" @@ -480,7 +725,7 @@ class RecipientUpdateTemplateRecipientsFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateTemplateRecipientsTextAlign4], @@ -519,7 +764,7 @@ class RecipientUpdateTemplateRecipientsFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateTemplateRecipientsTextAlign3], @@ -558,7 +803,7 @@ class RecipientUpdateTemplateRecipientsFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateTemplateRecipientsTextAlign2], @@ -597,7 +842,7 @@ class RecipientUpdateTemplateRecipientsFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[RecipientUpdateTemplateRecipientsTextAlign1], @@ -605,14 +850,42 @@ class RecipientUpdateTemplateRecipientsFieldMetaInitials(BaseModel): ] = None +class RecipientUpdateTemplateRecipientsTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class RecipientUpdateTemplateRecipientsFieldMetaSignatureTypedDict(TypedDict): + type: RecipientUpdateTemplateRecipientsTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class RecipientUpdateTemplateRecipientsFieldMetaSignature(BaseModel): + type: RecipientUpdateTemplateRecipientsTypeSignature + + 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")] = 12 + + RecipientUpdateTemplateRecipientsFieldMetaUnionTypedDict = TypeAliasType( "RecipientUpdateTemplateRecipientsFieldMetaUnionTypedDict", Union[ - RecipientUpdateTemplateRecipientsFieldMetaRadioTypedDict, + RecipientUpdateTemplateRecipientsFieldMetaSignatureTypedDict, RecipientUpdateTemplateRecipientsFieldMetaInitialsTypedDict, RecipientUpdateTemplateRecipientsFieldMetaNameTypedDict, RecipientUpdateTemplateRecipientsFieldMetaEmailTypedDict, RecipientUpdateTemplateRecipientsFieldMetaDateTypedDict, + RecipientUpdateTemplateRecipientsFieldMetaRadioTypedDict, RecipientUpdateTemplateRecipientsFieldMetaDropdownTypedDict, RecipientUpdateTemplateRecipientsFieldMetaCheckboxTypedDict, RecipientUpdateTemplateRecipientsFieldMetaTextTypedDict, @@ -624,11 +897,12 @@ class RecipientUpdateTemplateRecipientsFieldMetaInitials(BaseModel): RecipientUpdateTemplateRecipientsFieldMetaUnion = TypeAliasType( "RecipientUpdateTemplateRecipientsFieldMetaUnion", Union[ - RecipientUpdateTemplateRecipientsFieldMetaRadio, + RecipientUpdateTemplateRecipientsFieldMetaSignature, RecipientUpdateTemplateRecipientsFieldMetaInitials, RecipientUpdateTemplateRecipientsFieldMetaName, RecipientUpdateTemplateRecipientsFieldMetaEmail, RecipientUpdateTemplateRecipientsFieldMetaDate, + RecipientUpdateTemplateRecipientsFieldMetaRadio, RecipientUpdateTemplateRecipientsFieldMetaDropdown, RecipientUpdateTemplateRecipientsFieldMetaCheckbox, RecipientUpdateTemplateRecipientsFieldMetaText, @@ -638,38 +912,46 @@ class RecipientUpdateTemplateRecipientsFieldMetaInitials(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[RecipientUpdateTemplateRecipientsFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -680,18 +962,18 @@ class RecipientUpdateTemplateRecipientsField(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -720,13 +1002,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 @@ -735,12 +1016,15 @@ class RecipientUpdateTemplateRecipientsRecipientResponseTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[RecipientUpdateTemplateRecipientsAuthOptionsTypedDict] 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] 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 +1042,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 @@ -782,24 +1062,31 @@ class RecipientUpdateTemplateRecipientsRecipientResponse(BaseModel): ] 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")] 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..654fd99 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 @@ -13,51 +20,60 @@ class TemplateCreateDocumentFromTemplateRecipientRequestTypedDict(TypedDict): id: float - r"""The ID of the recipient in the template.""" email: str name: NotRequired[str] class TemplateCreateDocumentFromTemplateRecipientRequest(BaseModel): id: float - r"""The ID of the recipient in the template.""" email: str name: Optional[str] = None -class PrefillFieldTypeDate(str, Enum): +class TemplateCreateDocumentFromTemplateCustomDocumentDatumTypedDict(TypedDict): + document_data_id: str + envelope_item_id: str + + +class TemplateCreateDocumentFromTemplateCustomDocumentDatum(BaseModel): + document_data_id: Annotated[str, pydantic.Field(alias="documentDataId")] + + envelope_item_id: Annotated[str, pydantic.Field(alias="envelopeItemId")] + + +class TemplateCreateDocumentFromTemplatePrefillFieldTypeDate(str, Enum): DATE = "date" -class PrefillFieldDateTypedDict(TypedDict): - type: PrefillFieldTypeDate +class TemplateCreateDocumentFromTemplatePrefillFieldDateTypedDict(TypedDict): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeDate id: float value: NotRequired[str] -class PrefillFieldDate(BaseModel): - type: PrefillFieldTypeDate +class TemplateCreateDocumentFromTemplatePrefillFieldDate(BaseModel): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeDate id: float value: Optional[str] = None -class PrefillFieldTypeDropdown(str, Enum): +class TemplateCreateDocumentFromTemplatePrefillFieldTypeDropdown(str, Enum): DROPDOWN = "dropdown" -class PrefillFieldDropdownTypedDict(TypedDict): - type: PrefillFieldTypeDropdown +class TemplateCreateDocumentFromTemplatePrefillFieldDropdownTypedDict(TypedDict): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeDropdown id: float label: NotRequired[str] value: NotRequired[str] -class PrefillFieldDropdown(BaseModel): - type: PrefillFieldTypeDropdown +class TemplateCreateDocumentFromTemplatePrefillFieldDropdown(BaseModel): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeDropdown id: float @@ -66,19 +82,19 @@ class PrefillFieldDropdown(BaseModel): value: Optional[str] = None -class PrefillFieldTypeCheckbox(str, Enum): +class TemplateCreateDocumentFromTemplatePrefillFieldTypeCheckbox(str, Enum): CHECKBOX = "checkbox" -class PrefillFieldCheckboxTypedDict(TypedDict): - type: PrefillFieldTypeCheckbox +class TemplateCreateDocumentFromTemplatePrefillFieldCheckboxTypedDict(TypedDict): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeCheckbox id: float label: NotRequired[str] value: NotRequired[List[str]] -class PrefillFieldCheckbox(BaseModel): - type: PrefillFieldTypeCheckbox +class TemplateCreateDocumentFromTemplatePrefillFieldCheckbox(BaseModel): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeCheckbox id: float @@ -87,19 +103,19 @@ class PrefillFieldCheckbox(BaseModel): value: Optional[List[str]] = None -class PrefillFieldTypeRadio(str, Enum): +class TemplateCreateDocumentFromTemplatePrefillFieldTypeRadio(str, Enum): RADIO = "radio" -class PrefillFieldRadioTypedDict(TypedDict): - type: PrefillFieldTypeRadio +class TemplateCreateDocumentFromTemplatePrefillFieldRadioTypedDict(TypedDict): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeRadio id: float label: NotRequired[str] value: NotRequired[str] -class PrefillFieldRadio(BaseModel): - type: PrefillFieldTypeRadio +class TemplateCreateDocumentFromTemplatePrefillFieldRadio(BaseModel): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeRadio id: float @@ -108,20 +124,20 @@ class PrefillFieldRadio(BaseModel): value: Optional[str] = None -class PrefillFieldTypeNumber(str, Enum): +class TemplateCreateDocumentFromTemplatePrefillFieldTypeNumber(str, Enum): NUMBER = "number" -class PrefillFieldNumberTypedDict(TypedDict): - type: PrefillFieldTypeNumber +class TemplateCreateDocumentFromTemplatePrefillFieldNumberTypedDict(TypedDict): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeNumber id: float label: NotRequired[str] placeholder: NotRequired[str] value: NotRequired[str] -class PrefillFieldNumber(BaseModel): - type: PrefillFieldTypeNumber +class TemplateCreateDocumentFromTemplatePrefillFieldNumber(BaseModel): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeNumber id: float @@ -132,20 +148,20 @@ class PrefillFieldNumber(BaseModel): value: Optional[str] = None -class PrefillFieldTypeText(str, Enum): +class TemplateCreateDocumentFromTemplatePrefillFieldTypeText(str, Enum): TEXT = "text" -class PrefillFieldTextTypedDict(TypedDict): - type: PrefillFieldTypeText +class TemplateCreateDocumentFromTemplatePrefillFieldTextTypedDict(TypedDict): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeText id: float label: NotRequired[str] placeholder: NotRequired[str] value: NotRequired[str] -class PrefillFieldText(BaseModel): - type: PrefillFieldTypeText +class TemplateCreateDocumentFromTemplatePrefillFieldText(BaseModel): + type: TemplateCreateDocumentFromTemplatePrefillFieldTypeText id: float @@ -156,28 +172,28 @@ class PrefillFieldText(BaseModel): value: Optional[str] = None -PrefillFieldTypedDict = TypeAliasType( - "PrefillFieldTypedDict", +TemplateCreateDocumentFromTemplatePrefillFieldUnionTypedDict = TypeAliasType( + "TemplateCreateDocumentFromTemplatePrefillFieldUnionTypedDict", Union[ - PrefillFieldDateTypedDict, - PrefillFieldRadioTypedDict, - PrefillFieldCheckboxTypedDict, - PrefillFieldDropdownTypedDict, - PrefillFieldTextTypedDict, - PrefillFieldNumberTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldDateTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldRadioTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldCheckboxTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldDropdownTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldTextTypedDict, + TemplateCreateDocumentFromTemplatePrefillFieldNumberTypedDict, ], ) -PrefillField = TypeAliasType( - "PrefillField", +TemplateCreateDocumentFromTemplatePrefillFieldUnion = TypeAliasType( + "TemplateCreateDocumentFromTemplatePrefillFieldUnion", Union[ - PrefillFieldDate, - PrefillFieldRadio, - PrefillFieldCheckbox, - PrefillFieldDropdown, - PrefillFieldText, - PrefillFieldNumber, + TemplateCreateDocumentFromTemplatePrefillFieldDate, + TemplateCreateDocumentFromTemplatePrefillFieldRadio, + TemplateCreateDocumentFromTemplatePrefillFieldCheckbox, + TemplateCreateDocumentFromTemplatePrefillFieldDropdown, + TemplateCreateDocumentFromTemplatePrefillFieldText, + TemplateCreateDocumentFromTemplatePrefillFieldNumber, ], ) @@ -185,35 +201,41 @@ class PrefillFieldText(BaseModel): class TemplateCreateDocumentFromTemplateRequestTypedDict(TypedDict): template_id: float recipients: List[TemplateCreateDocumentFromTemplateRecipientRequestTypedDict] - r"""The information of the recipients to create the document with.""" 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.""" - 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.""" + custom_document_data: NotRequired[ + List[TemplateCreateDocumentFromTemplateCustomDocumentDatumTypedDict] + ] + folder_id: NotRequired[str] + prefill_fields: NotRequired[ + List[TemplateCreateDocumentFromTemplatePrefillFieldUnionTypedDict] + ] class TemplateCreateDocumentFromTemplateRequest(BaseModel): template_id: Annotated[float, pydantic.Field(alias="templateId")] recipients: List[TemplateCreateDocumentFromTemplateRecipientRequest] - r"""The information of the recipients to create the document with.""" distribute_document: Annotated[ Optional[bool], pydantic.Field(alias="distributeDocument") ] = None - r"""Whether to create the document as pending and distribute it to recipients.""" 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.""" + + custom_document_data: Annotated[ + Optional[List[TemplateCreateDocumentFromTemplateCustomDocumentDatum]], + pydantic.Field(alias="customDocumentData"), + ] = None + + folder_id: Annotated[Optional[str], pydantic.Field(alias="folderId")] = None prefill_fields: Annotated[ - Optional[List[PrefillField]], pydantic.Field(alias="prefillFields") + Optional[List[TemplateCreateDocumentFromTemplatePrefillFieldUnion]], + pydantic.Field(alias="prefillFields"), ] = None - 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.""" class TemplateCreateDocumentFromTemplateInternalServerErrorIssueTypedDict(TypedDict): @@ -234,10 +256,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 +271,75 @@ 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 TemplateCreateDocumentFromTemplateForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateDocumentFromTemplateForbiddenIssue(BaseModel): + message: str + + +class TemplateCreateDocumentFromTemplateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateDocumentFromTemplateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateDocumentFromTemplateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateCreateDocumentFromTemplateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateDocumentFromTemplateForbiddenErrorData, + 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 TemplateCreateDocumentFromTemplateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateDocumentFromTemplateUnauthorizedIssue(BaseModel): + message: str + + +class TemplateCreateDocumentFromTemplateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateDocumentFromTemplateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateDocumentFromTemplateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateCreateDocumentFromTemplateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateDocumentFromTemplateUnauthorizedErrorData, + 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 TemplateCreateDocumentFromTemplateBadRequestIssueTypedDict(TypedDict): @@ -267,10 +358,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 +373,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): @@ -304,14 +396,11 @@ class TemplateCreateDocumentFromTemplateSource(str, Enum): 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): - 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" @@ -356,6 +445,7 @@ class TemplateCreateDocumentFromTemplateDocumentDataTypedDict(TypedDict): id: str data: str initial_data: str + envelope_item_id: str class TemplateCreateDocumentFromTemplateDocumentData(BaseModel): @@ -367,6 +457,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" @@ -380,56 +472,42 @@ class TemplateCreateDocumentFromTemplateDistributionMethod(str, Enum): class TemplateCreateDocumentFromTemplateEmailSettingsTypedDict(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 TemplateCreateDocumentFromTemplateEmailSettings(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 TemplateCreateDocumentFromTemplateDocumentMetaTypedDict(TypedDict): @@ -439,9 +517,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 +525,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 +550,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 +577,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) @@ -540,6 +626,17 @@ def serialize_model(self, handler): return m +class TemplateCreateDocumentFromTemplateEnvelopeItemTypedDict(TypedDict): + id: str + envelope_id: str + + +class TemplateCreateDocumentFromTemplateEnvelopeItem(BaseModel): + id: str + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + class TemplateCreateDocumentFromTemplateFolderType(str, Enum): DOCUMENT = "DOCUMENT" TEMPLATE = "TEMPLATE" @@ -641,14 +738,11 @@ class TemplateCreateDocumentFromTemplateSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -674,13 +768,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 @@ -691,11 +784,14 @@ class TemplateCreateDocumentFromTemplateRecipientResponseTypedDict(TypedDict): TemplateCreateDocumentFromTemplateRecipientAuthOptionsTypedDict ] 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 +809,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 @@ -737,22 +829,29 @@ class TemplateCreateDocumentFromTemplateRecipientResponse(BaseModel): ] 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 = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -813,6 +912,7 @@ class TemplateCreateDocumentFromTemplateFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[TemplateCreateDocumentFromTemplateValue3TypedDict]] default_value: NotRequired[str] @@ -828,6 +928,8 @@ class TemplateCreateDocumentFromTemplateFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[TemplateCreateDocumentFromTemplateValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -851,15 +953,22 @@ class TemplateCreateDocumentFromTemplateValue2(BaseModel): value: str +class TemplateCreateDocumentFromTemplateDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class TemplateCreateDocumentFromTemplateFieldMetaCheckboxTypedDict(TypedDict): type: TemplateCreateDocumentFromTemplateFieldMetaTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[TemplateCreateDocumentFromTemplateValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[TemplateCreateDocumentFromTemplateDirection2] class TemplateCreateDocumentFromTemplateFieldMetaCheckbox(BaseModel): @@ -873,6 +982,8 @@ class TemplateCreateDocumentFromTemplateFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[TemplateCreateDocumentFromTemplateValue2]] = None validation_rule: Annotated[ @@ -883,6 +994,10 @@ class TemplateCreateDocumentFromTemplateFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[TemplateCreateDocumentFromTemplateDirection2] = ( + TemplateCreateDocumentFromTemplateDirection2.VERTICAL + ) + class TemplateCreateDocumentFromTemplateFieldMetaTypeRadio(str, Enum): RADIO = "radio" @@ -902,13 +1017,20 @@ class TemplateCreateDocumentFromTemplateValue1(BaseModel): value: str +class TemplateCreateDocumentFromTemplateDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class TemplateCreateDocumentFromTemplateFieldMetaRadioTypedDict(TypedDict): type: TemplateCreateDocumentFromTemplateFieldMetaTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[TemplateCreateDocumentFromTemplateValue1TypedDict]] + direction: NotRequired[TemplateCreateDocumentFromTemplateDirection1] class TemplateCreateDocumentFromTemplateFieldMetaRadio(BaseModel): @@ -922,8 +1044,14 @@ class TemplateCreateDocumentFromTemplateFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[TemplateCreateDocumentFromTemplateValue1]] = None + direction: Optional[TemplateCreateDocumentFromTemplateDirection1] = ( + TemplateCreateDocumentFromTemplateDirection1.VERTICAL + ) + class TemplateCreateDocumentFromTemplateFieldMetaTypeNumber(str, Enum): NUMBER = "number" @@ -935,18 +1063,29 @@ class TemplateCreateDocumentFromTemplateTextAlign6(str, Enum): RIGHT = "right" +class TemplateCreateDocumentFromTemplateVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class TemplateCreateDocumentFromTemplateFieldMetaNumberTypedDict(TypedDict): type: TemplateCreateDocumentFromTemplateFieldMetaTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[TemplateCreateDocumentFromTemplateTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[TemplateCreateDocumentFromTemplateVerticalAlign2] + ] class TemplateCreateDocumentFromTemplateFieldMetaNumber(BaseModel): @@ -960,21 +1099,91 @@ class TemplateCreateDocumentFromTemplateFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[TemplateCreateDocumentFromTemplateTextAlign6], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[TemplateCreateDocumentFromTemplateVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -986,16 +1195,27 @@ class TemplateCreateDocumentFromTemplateTextAlign5(str, Enum): RIGHT = "right" +class TemplateCreateDocumentFromTemplateVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class TemplateCreateDocumentFromTemplateFieldMetaTextTypedDict(TypedDict): type: TemplateCreateDocumentFromTemplateFieldMetaTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[TemplateCreateDocumentFromTemplateTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[ + Nullable[TemplateCreateDocumentFromTemplateVerticalAlign1] + ] class TemplateCreateDocumentFromTemplateFieldMetaText(BaseModel): @@ -1009,19 +1229,74 @@ class TemplateCreateDocumentFromTemplateFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[TemplateCreateDocumentFromTemplateTextAlign5], pydantic.Field(alias="textAlign"), ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[TemplateCreateDocumentFromTemplateVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 TemplateCreateDocumentFromTemplateFieldMetaTypeDate(str, Enum): DATE = "date" @@ -1054,7 +1329,7 @@ class TemplateCreateDocumentFromTemplateFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateCreateDocumentFromTemplateTextAlign4], @@ -1093,7 +1368,7 @@ class TemplateCreateDocumentFromTemplateFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateCreateDocumentFromTemplateTextAlign3], @@ -1132,7 +1407,7 @@ class TemplateCreateDocumentFromTemplateFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateCreateDocumentFromTemplateTextAlign2], @@ -1171,7 +1446,7 @@ class TemplateCreateDocumentFromTemplateFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateCreateDocumentFromTemplateTextAlign1], @@ -1179,14 +1454,42 @@ class TemplateCreateDocumentFromTemplateFieldMetaInitials(BaseModel): ] = None +class TemplateCreateDocumentFromTemplateTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class TemplateCreateDocumentFromTemplateFieldMetaSignatureTypedDict(TypedDict): + type: TemplateCreateDocumentFromTemplateTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class TemplateCreateDocumentFromTemplateFieldMetaSignature(BaseModel): + type: TemplateCreateDocumentFromTemplateTypeSignature + + 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")] = 12 + + TemplateCreateDocumentFromTemplateFieldMetaUnionTypedDict = TypeAliasType( "TemplateCreateDocumentFromTemplateFieldMetaUnionTypedDict", Union[ - TemplateCreateDocumentFromTemplateFieldMetaRadioTypedDict, + TemplateCreateDocumentFromTemplateFieldMetaSignatureTypedDict, TemplateCreateDocumentFromTemplateFieldMetaInitialsTypedDict, TemplateCreateDocumentFromTemplateFieldMetaNameTypedDict, TemplateCreateDocumentFromTemplateFieldMetaEmailTypedDict, TemplateCreateDocumentFromTemplateFieldMetaDateTypedDict, + TemplateCreateDocumentFromTemplateFieldMetaRadioTypedDict, TemplateCreateDocumentFromTemplateFieldMetaDropdownTypedDict, TemplateCreateDocumentFromTemplateFieldMetaCheckboxTypedDict, TemplateCreateDocumentFromTemplateFieldMetaTextTypedDict, @@ -1198,11 +1501,12 @@ class TemplateCreateDocumentFromTemplateFieldMetaInitials(BaseModel): TemplateCreateDocumentFromTemplateFieldMetaUnion = TypeAliasType( "TemplateCreateDocumentFromTemplateFieldMetaUnion", Union[ - TemplateCreateDocumentFromTemplateFieldMetaRadio, + TemplateCreateDocumentFromTemplateFieldMetaSignature, TemplateCreateDocumentFromTemplateFieldMetaInitials, TemplateCreateDocumentFromTemplateFieldMetaName, TemplateCreateDocumentFromTemplateFieldMetaEmail, TemplateCreateDocumentFromTemplateFieldMetaDate, + TemplateCreateDocumentFromTemplateFieldMetaRadio, TemplateCreateDocumentFromTemplateFieldMetaDropdown, TemplateCreateDocumentFromTemplateFieldMetaCheckbox, TemplateCreateDocumentFromTemplateFieldMetaText, @@ -1212,38 +1516,46 @@ class TemplateCreateDocumentFromTemplateFieldMetaInitials(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[TemplateCreateDocumentFromTemplateFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -1254,18 +1566,18 @@ class TemplateCreateDocumentFromTemplateField(BaseModel): pydantic.Field(alias="fieldMeta"), ] - position_x: Annotated[Optional[Any], pydantic.Field(alias="positionX")] = None - - position_y: Annotated[Optional[Any], pydantic.Field(alias="positionY")] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - width: Optional[Any] = None - - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -1301,27 +1613,28 @@ class TemplateCreateDocumentFromTemplateResponseTypedDict(TypedDict): source: TemplateCreateDocumentFromTemplateSource 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[TemplateCreateDocumentFromTemplateAuthOptionsTypedDict] form_values: Nullable[ 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 + internal_version: float document_data: TemplateCreateDocumentFromTemplateDocumentDataTypedDict - document_meta: Nullable[TemplateCreateDocumentFromTemplateDocumentMetaTypedDict] + document_meta: TemplateCreateDocumentFromTemplateDocumentMetaTypedDict + envelope_items: List[TemplateCreateDocumentFromTemplateEnvelopeItemTypedDict] folder: Nullable[TemplateCreateDocumentFromTemplateFolderTypedDict] recipients: List[TemplateCreateDocumentFromTemplateRecipientResponseTypedDict] fields: List[TemplateCreateDocumentFromTemplateFieldTypedDict] + template_id: NotRequired[Nullable[float]] + document_data_id: NotRequired[str] class TemplateCreateDocumentFromTemplateResponse(BaseModel): @@ -1336,10 +1649,8 @@ class TemplateCreateDocumentFromTemplateResponse(BaseModel): id: float external_id: Annotated[Nullable[str], pydantic.Field(alias="externalId")] - r"""A custom external ID you can use to identify the document.""" user_id: Annotated[float, pydantic.Field(alias="userId")] - r"""The ID of the user that created this document.""" auth_options: Annotated[ Nullable[TemplateCreateDocumentFromTemplateAuthOptions], @@ -1353,8 +1664,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,38 +1674,52 @@ 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")] + + internal_version: Annotated[float, pydantic.Field(alias="internalVersion")] + document_data: Annotated[ TemplateCreateDocumentFromTemplateDocumentData, pydantic.Field(alias="documentData"), ] document_meta: Annotated[ - Nullable[TemplateCreateDocumentFromTemplateDocumentMeta], + TemplateCreateDocumentFromTemplateDocumentMeta, pydantic.Field(alias="documentMeta"), ] + envelope_items: Annotated[ + List[TemplateCreateDocumentFromTemplateEnvelopeItem], + pydantic.Field(alias="envelopeItems"), + ] + folder: Nullable[TemplateCreateDocumentFromTemplateFolder] recipients: List[TemplateCreateDocumentFromTemplateRecipientResponse] fields: List[TemplateCreateDocumentFromTemplateField] + template_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="templateId") + ] = UNSET + + 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..1b3a59b 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 @@ -12,7 +13,6 @@ class TemplateCreateTemplateDirectLinkRequestTypedDict(TypedDict): template_id: float direct_recipient_id: NotRequired[float] - r"""The of the recipient in the current template to transform into the primary recipient when the template is used.""" class TemplateCreateTemplateDirectLinkRequest(BaseModel): @@ -21,7 +21,6 @@ class TemplateCreateTemplateDirectLinkRequest(BaseModel): direct_recipient_id: Annotated[ Optional[float], pydantic.Field(alias="directRecipientId") ] = None - r"""The of the recipient in the current template to transform into the primary recipient when the template is used.""" class TemplateCreateTemplateDirectLinkInternalServerErrorIssueTypedDict(TypedDict): @@ -42,10 +41,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 +56,75 @@ 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 TemplateCreateTemplateDirectLinkForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateTemplateDirectLinkForbiddenIssue(BaseModel): + message: str + + +class TemplateCreateTemplateDirectLinkForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateTemplateDirectLinkForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateTemplateDirectLinkForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateCreateTemplateDirectLinkForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateTemplateDirectLinkForbiddenErrorData, + 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 TemplateCreateTemplateDirectLinkUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateTemplateDirectLinkUnauthorizedIssue(BaseModel): + message: str + + +class TemplateCreateTemplateDirectLinkUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateTemplateDirectLinkUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateTemplateDirectLinkUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateCreateTemplateDirectLinkUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateTemplateDirectLinkUnauthorizedErrorData, + 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 TemplateCreateTemplateDirectLinkBadRequestIssueTypedDict(TypedDict): @@ -75,10 +143,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 +158,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 +178,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 +187,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_createtemplateop.py b/src/documenso_sdk/models/template_createtemplateop.py new file mode 100644 index 0000000..ac4e34e --- /dev/null +++ b/src/documenso_sdk/models/template_createtemplateop.py @@ -0,0 +1,543 @@ +"""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 documenso_sdk.utils import FieldMetadata, MultipartFormMetadata +from enum import Enum +import httpx +import io +import pydantic +from pydantic import model_serializer +from typing import IO, List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypedDict + + +class TemplateCreateTemplateVisibility(str, Enum): + EVERYONE = "EVERYONE" + MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" + ADMIN = "ADMIN" + + +class TemplateCreateTemplateGlobalAccessAuth(str, Enum): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class TemplateCreateTemplateGlobalActionAuth(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class TemplateCreateTemplateType(str, Enum): + PUBLIC = "PUBLIC" + PRIVATE = "PRIVATE" + + +class TemplateCreateTemplateDateFormat(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 TemplateCreateTemplateDistributionMethod(str, Enum): + EMAIL = "EMAIL" + NONE = "NONE" + + +class TemplateCreateTemplateEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class TemplateCreateTemplateEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class TemplateCreateTemplateLanguage(str, Enum): + DE = "de" + EN = "en" + FR = "fr" + ES = "es" + IT = "it" + PL = "pl" + + +class TemplateCreateTemplateSigningOrder(str, Enum): + PARALLEL = "PARALLEL" + SEQUENTIAL = "SEQUENTIAL" + + +class TemplateCreateTemplateMetaTypedDict(TypedDict): + subject: NotRequired[str] + message: NotRequired[str] + timezone: NotRequired[str] + date_format: NotRequired[TemplateCreateTemplateDateFormat] + distribution_method: NotRequired[TemplateCreateTemplateDistributionMethod] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[TemplateCreateTemplateEmailSettingsTypedDict] + redirect_url: NotRequired[str] + language: NotRequired[TemplateCreateTemplateLanguage] + typed_signature_enabled: NotRequired[bool] + upload_signature_enabled: NotRequired[bool] + draw_signature_enabled: NotRequired[bool] + signing_order: NotRequired[TemplateCreateTemplateSigningOrder] + allow_dictate_next_signer: NotRequired[bool] + + +class TemplateCreateTemplateMeta(BaseModel): + subject: Optional[str] = None + + message: Optional[str] = None + + timezone: Optional[str] = None + + date_format: Annotated[ + Optional[TemplateCreateTemplateDateFormat], pydantic.Field(alias="dateFormat") + ] = None + + distribution_method: Annotated[ + Optional[TemplateCreateTemplateDistributionMethod], + pydantic.Field(alias="distributionMethod"), + ] = None + + 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[TemplateCreateTemplateEmailSettings], + pydantic.Field(alias="emailSettings"), + ] = None + + redirect_url: Annotated[Optional[str], pydantic.Field(alias="redirectUrl")] = None + + language: Optional[TemplateCreateTemplateLanguage] = None + + typed_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="typedSignatureEnabled") + ] = None + + upload_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="uploadSignatureEnabled") + ] = None + + draw_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="drawSignatureEnabled") + ] = None + + signing_order: Annotated[ + Optional[TemplateCreateTemplateSigningOrder], + 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 TemplateCreateTemplateTypeLink(str, Enum): + LINK = "link" + + +class TemplateCreateTemplateAttachmentTypedDict(TypedDict): + label: str + data: str + type: NotRequired[TemplateCreateTemplateTypeLink] + + +class TemplateCreateTemplateAttachment(BaseModel): + label: str + + data: str + + type: Optional[TemplateCreateTemplateTypeLink] = TemplateCreateTemplateTypeLink.LINK + + +class TemplateCreateTemplatePayloadTypedDict(TypedDict): + title: str + folder_id: NotRequired[str] + external_id: NotRequired[Nullable[str]] + visibility: NotRequired[TemplateCreateTemplateVisibility] + global_access_auth: NotRequired[List[TemplateCreateTemplateGlobalAccessAuth]] + global_action_auth: NotRequired[List[TemplateCreateTemplateGlobalActionAuth]] + public_title: NotRequired[str] + public_description: NotRequired[str] + type: NotRequired[TemplateCreateTemplateType] + meta: NotRequired[TemplateCreateTemplateMetaTypedDict] + attachments: NotRequired[List[TemplateCreateTemplateAttachmentTypedDict]] + + +class TemplateCreateTemplatePayload(BaseModel): + title: str + + folder_id: Annotated[Optional[str], pydantic.Field(alias="folderId")] = None + + external_id: Annotated[ + OptionalNullable[str], pydantic.Field(alias="externalId") + ] = UNSET + + visibility: Optional[TemplateCreateTemplateVisibility] = None + + global_access_auth: Annotated[ + Optional[List[TemplateCreateTemplateGlobalAccessAuth]], + pydantic.Field(alias="globalAccessAuth"), + ] = None + + global_action_auth: Annotated[ + Optional[List[TemplateCreateTemplateGlobalActionAuth]], + pydantic.Field(alias="globalActionAuth"), + ] = None + + public_title: Annotated[Optional[str], pydantic.Field(alias="publicTitle")] = None + + public_description: Annotated[ + Optional[str], pydantic.Field(alias="publicDescription") + ] = None + + type: Optional[TemplateCreateTemplateType] = None + + meta: Optional[TemplateCreateTemplateMeta] = None + + attachments: Optional[List[TemplateCreateTemplateAttachment]] = None + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "folderId", + "externalId", + "visibility", + "globalAccessAuth", + "globalActionAuth", + "publicTitle", + "publicDescription", + "type", + "meta", + "attachments", + ] + 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 TemplateCreateTemplateFileTypedDict(TypedDict): + file_name: str + content: Union[bytes, IO[bytes], io.BufferedReader] + content_type: NotRequired[str] + + +class TemplateCreateTemplateFile(BaseModel): + file_name: Annotated[ + str, pydantic.Field(alias="fileName"), FieldMetadata(multipart=True) + ] + + content: Annotated[ + Union[bytes, IO[bytes], io.BufferedReader], + pydantic.Field(alias=""), + FieldMetadata(multipart=MultipartFormMetadata(content=True)), + ] + + content_type: Annotated[ + Optional[str], + pydantic.Field(alias="Content-Type"), + FieldMetadata(multipart=True), + ] = None + + +class TemplateCreateTemplateRequestTypedDict(TypedDict): + payload: TemplateCreateTemplatePayloadTypedDict + file: TemplateCreateTemplateFileTypedDict + + +class TemplateCreateTemplateRequest(BaseModel): + payload: Annotated[ + TemplateCreateTemplatePayload, + FieldMetadata(multipart=MultipartFormMetadata(json=True)), + ] + + file: Annotated[ + TemplateCreateTemplateFile, + FieldMetadata(multipart=MultipartFormMetadata(file=True)), + ] + + +class TemplateCreateTemplateInternalServerErrorIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateTemplateInternalServerErrorIssue(BaseModel): + message: str + + +class TemplateCreateTemplateInternalServerErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateTemplateInternalServerErrorIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateTemplateInternalServerError(DocumensoError): + r"""Internal server error""" + + data: TemplateCreateTemplateInternalServerErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateTemplateInternalServerErrorData, + 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 TemplateCreateTemplateForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateTemplateForbiddenIssue(BaseModel): + message: str + + +class TemplateCreateTemplateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateTemplateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateTemplateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateCreateTemplateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateTemplateForbiddenErrorData, + 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 TemplateCreateTemplateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateTemplateUnauthorizedIssue(BaseModel): + message: str + + +class TemplateCreateTemplateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateTemplateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateTemplateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateCreateTemplateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateTemplateUnauthorizedErrorData, + 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 TemplateCreateTemplateBadRequestIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateTemplateBadRequestIssue(BaseModel): + message: str + + +class TemplateCreateTemplateBadRequestErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateTemplateBadRequestIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateTemplateBadRequestError(DocumensoError): + r"""Invalid input data""" + + data: TemplateCreateTemplateBadRequestErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateTemplateBadRequestErrorData, + 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 TemplateCreateTemplateResponseTypedDict(TypedDict): + r"""Successful response""" + + envelope_id: str + id: float + + +class TemplateCreateTemplateResponse(BaseModel): + r"""Successful response""" + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + id: float diff --git a/src/documenso_sdk/models/template_createtemplatetemporaryop.py b/src/documenso_sdk/models/template_createtemplatetemporaryop.py new file mode 100644 index 0000000..69b302f --- /dev/null +++ b/src/documenso_sdk/models/template_createtemplatetemporaryop.py @@ -0,0 +1,1916 @@ +"""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): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class TemplateCreateTemplateTemporaryGlobalActionAuthRequest(str, Enum): + ACCOUNT = "ACCOUNT" + PASSKEY = "PASSKEY" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + PASSWORD = "PASSWORD" + + +class TemplateCreateTemplateTemporaryTypeRequest(str, Enum): + PUBLIC = "PUBLIC" + PRIVATE = "PRIVATE" + + +class TemplateCreateTemplateTemporaryDateFormat(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 TemplateCreateTemplateTemporaryMetaDistributionMethod(str, Enum): + EMAIL = "EMAIL" + NONE = "NONE" + + +class TemplateCreateTemplateTemporaryMetaEmailSettingsTypedDict(TypedDict): + recipient_signing_request: NotRequired[bool] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class TemplateCreateTemplateTemporaryMetaEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +class TemplateCreateTemplateTemporaryLanguage(str, Enum): + 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] + message: NotRequired[str] + timezone: NotRequired[str] + date_format: NotRequired[TemplateCreateTemplateTemporaryDateFormat] + distribution_method: NotRequired[ + TemplateCreateTemplateTemporaryMetaDistributionMethod + ] + email_id: NotRequired[Nullable[str]] + email_reply_to: NotRequired[Nullable[str]] + email_settings: NotRequired[ + TemplateCreateTemplateTemporaryMetaEmailSettingsTypedDict + ] + redirect_url: NotRequired[str] + language: NotRequired[TemplateCreateTemplateTemporaryLanguage] + typed_signature_enabled: NotRequired[bool] + upload_signature_enabled: NotRequired[bool] + draw_signature_enabled: NotRequired[bool] + signing_order: NotRequired[TemplateCreateTemplateTemporarySigningOrderRequest] + allow_dictate_next_signer: NotRequired[bool] + + +class TemplateCreateTemplateTemporaryMeta(BaseModel): + subject: Optional[str] = None + + message: Optional[str] = None + + timezone: Optional[str] = None + + date_format: Annotated[ + Optional[TemplateCreateTemplateTemporaryDateFormat], + pydantic.Field(alias="dateFormat"), + ] = None + + distribution_method: Annotated[ + Optional[TemplateCreateTemplateTemporaryMetaDistributionMethod], + pydantic.Field(alias="distributionMethod"), + ] = None + + 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[TemplateCreateTemplateTemporaryMetaEmailSettings], + pydantic.Field(alias="emailSettings"), + ] = None + + redirect_url: Annotated[Optional[str], pydantic.Field(alias="redirectUrl")] = None + + language: Optional[TemplateCreateTemplateTemporaryLanguage] = None + + typed_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="typedSignatureEnabled") + ] = None + + upload_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="uploadSignatureEnabled") + ] = None + + draw_signature_enabled: Annotated[ + Optional[bool], pydantic.Field(alias="drawSignatureEnabled") + ] = None + + 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 TemplateCreateTemplateTemporaryTypeLink(str, Enum): + LINK = "link" + + +class TemplateCreateTemplateTemporaryAttachmentTypedDict(TypedDict): + label: str + data: str + type: NotRequired[TemplateCreateTemplateTemporaryTypeLink] + + +class TemplateCreateTemplateTemporaryAttachment(BaseModel): + label: str + + data: str + + type: Optional[TemplateCreateTemplateTemporaryTypeLink] = ( + TemplateCreateTemplateTemporaryTypeLink.LINK + ) + + +class TemplateCreateTemplateTemporaryRequestTypedDict(TypedDict): + title: str + 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] + public_description: NotRequired[str] + type: NotRequired[TemplateCreateTemplateTemporaryTypeRequest] + meta: NotRequired[TemplateCreateTemplateTemporaryMetaTypedDict] + attachments: NotRequired[List[TemplateCreateTemplateTemporaryAttachmentTypedDict]] + + +class TemplateCreateTemplateTemporaryRequest(BaseModel): + title: str + + 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 + + public_description: Annotated[ + Optional[str], pydantic.Field(alias="publicDescription") + ] = None + + type: Optional[TemplateCreateTemplateTemporaryTypeRequest] = None + + meta: Optional[TemplateCreateTemplateTemporaryMeta] = None + + attachments: Optional[List[TemplateCreateTemplateTemporaryAttachment]] = None + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "folderId", + "externalId", + "visibility", + "globalAccessAuth", + "globalActionAuth", + "publicTitle", + "publicDescription", + "type", + "meta", + "attachments", + ] + 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 TemplateCreateTemplateTemporaryForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateTemplateTemporaryForbiddenIssue(BaseModel): + message: str + + +class TemplateCreateTemplateTemporaryForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateTemplateTemporaryForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateTemplateTemporaryForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateCreateTemplateTemporaryForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateTemplateTemporaryForbiddenErrorData, + 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 TemplateCreateTemplateTemporaryUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateCreateTemplateTemporaryUnauthorizedIssue(BaseModel): + message: str + + +class TemplateCreateTemplateTemporaryUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateCreateTemplateTemporaryUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateCreateTemplateTemporaryUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateCreateTemplateTemporaryUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateCreateTemplateTemporaryUnauthorizedErrorData, + 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): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class TemplateCreateTemplateTemporaryGlobalActionAuthResponse(str, Enum): + 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] + recipient_removed: NotRequired[bool] + recipient_signed: NotRequired[bool] + document_pending: NotRequired[bool] + document_completed: NotRequired[bool] + document_deleted: NotRequired[bool] + owner_document_completed: NotRequired[bool] + + +class TemplateCreateTemplateTemporaryTemplateMetaEmailSettings(BaseModel): + recipient_signing_request: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigningRequest") + ] = True + + recipient_removed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientRemoved") + ] = True + + recipient_signed: Annotated[ + Optional[bool], pydantic.Field(alias="recipientSigned") + ] = True + + document_pending: Annotated[ + Optional[bool], pydantic.Field(alias="documentPending") + ] = True + + document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="documentCompleted") + ] = True + + document_deleted: Annotated[ + Optional[bool], pydantic.Field(alias="documentDeleted") + ] = True + + owner_document_completed: Annotated[ + Optional[bool], pydantic.Field(alias="ownerDocumentCompleted") + ] = True + + +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): + ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" + + +class TemplateCreateTemplateTemporaryActionAuth(str, Enum): + 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] + 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")] + + 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] + font_size: NotRequired[float] + 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 + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + + 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 TemplateCreateTemplateTemporaryDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class TemplateCreateTemplateTemporaryFieldMetaCheckboxTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeCheckbox + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[TemplateCreateTemplateTemporaryValue2TypedDict]] + validation_rule: NotRequired[str] + validation_length: NotRequired[float] + direction: NotRequired[TemplateCreateTemplateTemporaryDirection2] + + +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 + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + + 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[TemplateCreateTemplateTemporaryDirection2] = ( + TemplateCreateTemplateTemporaryDirection2.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 TemplateCreateTemplateTemporaryDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + +class TemplateCreateTemplateTemporaryFieldMetaRadioTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeRadio + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + values: NotRequired[List[TemplateCreateTemplateTemporaryValue1TypedDict]] + direction: NotRequired[TemplateCreateTemplateTemporaryDirection1] + + +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 + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + + values: Optional[List[TemplateCreateTemplateTemporaryValue1]] = None + + direction: Optional[TemplateCreateTemplateTemporaryDirection1] = ( + TemplateCreateTemplateTemporaryDirection1.VERTICAL + ) + + +class TemplateCreateTemplateTemporaryTypeNumber(str, Enum): + NUMBER = "number" + + +class TemplateCreateTemplateTemporaryTextAlign6(str, Enum): + LEFT = "left" + CENTER = "center" + RIGHT = "right" + + +class TemplateCreateTemplateTemporaryVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class TemplateCreateTemplateTemporaryFieldMetaNumberTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeNumber + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] + text_align: NotRequired[TemplateCreateTemplateTemporaryTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[TemplateCreateTemplateTemporaryVerticalAlign2]] + + +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 + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + + 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 + ) + + text_align: Annotated[ + Optional[TemplateCreateTemplateTemporaryTextAlign6], + pydantic.Field(alias="textAlign"), + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[TemplateCreateTemplateTemporaryVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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 TemplateCreateTemplateTemporaryVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + +class TemplateCreateTemplateTemporaryFieldMetaTextTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeText + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + text: NotRequired[str] + character_limit: NotRequired[float] + text_align: NotRequired[TemplateCreateTemplateTemporaryTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[TemplateCreateTemplateTemporaryVerticalAlign1]] + + +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 + + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + + text: Optional[str] = None + + character_limit: Annotated[ + Optional[float], pydantic.Field(alias="characterLimit") + ] = None + + text_align: Annotated[ + Optional[TemplateCreateTemplateTemporaryTextAlign5], + pydantic.Field(alias="textAlign"), + ] = None + + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[TemplateCreateTemplateTemporaryVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 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")] = 12 + + 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")] = 12 + + 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")] = 12 + + 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")] = 12 + + text_align: Annotated[ + Optional[TemplateCreateTemplateTemporaryTextAlign1], + pydantic.Field(alias="textAlign"), + ] = None + + +class TemplateCreateTemplateTemporaryTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class TemplateCreateTemplateTemporaryFieldMetaSignatureTypedDict(TypedDict): + type: TemplateCreateTemplateTemporaryTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class TemplateCreateTemplateTemporaryFieldMetaSignature(BaseModel): + type: TemplateCreateTemplateTemporaryTypeSignature + + 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")] = 12 + + +TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict = TypeAliasType( + "TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict", + Union[ + TemplateCreateTemplateTemporaryFieldMetaSignatureTypedDict, + TemplateCreateTemplateTemporaryFieldMetaInitialsTypedDict, + TemplateCreateTemplateTemporaryFieldMetaNameTypedDict, + TemplateCreateTemplateTemporaryFieldMetaEmailTypedDict, + TemplateCreateTemplateTemporaryFieldMetaDateTypedDict, + TemplateCreateTemplateTemporaryFieldMetaRadioTypedDict, + TemplateCreateTemplateTemporaryFieldMetaDropdownTypedDict, + TemplateCreateTemplateTemporaryFieldMetaCheckboxTypedDict, + TemplateCreateTemplateTemporaryFieldMetaTextTypedDict, + TemplateCreateTemplateTemporaryFieldMetaNumberTypedDict, + ], +) + + +TemplateCreateTemplateTemporaryFieldMetaUnion = TypeAliasType( + "TemplateCreateTemplateTemporaryFieldMetaUnion", + Union[ + TemplateCreateTemplateTemporaryFieldMetaSignature, + TemplateCreateTemplateTemporaryFieldMetaInitials, + TemplateCreateTemplateTemporaryFieldMetaName, + TemplateCreateTemplateTemporaryFieldMetaEmail, + TemplateCreateTemplateTemporaryFieldMetaDate, + TemplateCreateTemplateTemporaryFieldMetaRadio, + TemplateCreateTemplateTemporaryFieldMetaDropdown, + TemplateCreateTemplateTemporaryFieldMetaCheckbox, + TemplateCreateTemplateTemporaryFieldMetaText, + TemplateCreateTemplateTemporaryFieldMetaNumber, + ], +) + + +class TemplateCreateTemplateTemporaryFieldTypedDict(TypedDict): + envelope_id: str + envelope_item_id: str + type: TemplateCreateTemplateTemporaryFieldType + id: float + secondary_id: str + recipient_id: float + page: float + position_x: Any + position_y: Any + width: Any + height: Any + custom_text: str + inserted: bool + field_meta: Nullable[TemplateCreateTemplateTemporaryFieldMetaUnionTypedDict] + 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 + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any + + custom_text: Annotated[str, pydantic.Field(alias="customText")] + + inserted: bool + + field_meta: Annotated[ + Nullable[TemplateCreateTemplateTemporaryFieldMetaUnion], + pydantic.Field(alias="fieldMeta"), + ] + + 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 = ["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 TemplateCreateTemplateTemporaryEnvelopeItemTypedDict(TypedDict): + id: str + envelope_id: str + + +class TemplateCreateTemplateTemporaryEnvelopeItem(BaseModel): + id: str + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + +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] + envelope_items: List[TemplateCreateTemplateTemporaryEnvelopeItemTypedDict] + 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] + + envelope_items: Annotated[ + List[TemplateCreateTemplateTemporaryEnvelopeItem], + pydantic.Field(alias="envelopeItems"), + ] + + 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..62eb632 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,75 @@ 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 TemplateDeleteTemplateDirectLinkForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateDeleteTemplateDirectLinkForbiddenIssue(BaseModel): + message: str + + +class TemplateDeleteTemplateDirectLinkForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateDeleteTemplateDirectLinkForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateDeleteTemplateDirectLinkForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateDeleteTemplateDirectLinkForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateDeleteTemplateDirectLinkForbiddenErrorData, + 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 TemplateDeleteTemplateDirectLinkUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateDeleteTemplateDirectLinkUnauthorizedIssue(BaseModel): + message: str + + +class TemplateDeleteTemplateDirectLinkUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateDeleteTemplateDirectLinkUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateDeleteTemplateDirectLinkUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateDeleteTemplateDirectLinkUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateDeleteTemplateDirectLinkUnauthorizedErrorData, + 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 TemplateDeleteTemplateDirectLinkBadRequestIssueTypedDict(TypedDict): @@ -68,10 +138,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 +153,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..0b2ad18 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,75 @@ 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 TemplateDeleteTemplateForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateDeleteTemplateForbiddenIssue(BaseModel): + message: str + + +class TemplateDeleteTemplateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateDeleteTemplateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateDeleteTemplateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateDeleteTemplateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateDeleteTemplateForbiddenErrorData, + 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 TemplateDeleteTemplateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateDeleteTemplateUnauthorizedIssue(BaseModel): + message: str + + +class TemplateDeleteTemplateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateDeleteTemplateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateDeleteTemplateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateDeleteTemplateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateDeleteTemplateUnauthorizedErrorData, + 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 TemplateDeleteTemplateBadRequestIssueTypedDict(TypedDict): @@ -66,10 +136,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 +151,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..3c000e2 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,75 @@ 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 TemplateDuplicateTemplateForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateDuplicateTemplateForbiddenIssue(BaseModel): + message: str + + +class TemplateDuplicateTemplateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateDuplicateTemplateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateDuplicateTemplateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateDuplicateTemplateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateDuplicateTemplateForbiddenErrorData, + 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 TemplateDuplicateTemplateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateDuplicateTemplateUnauthorizedIssue(BaseModel): + message: str + + +class TemplateDuplicateTemplateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateDuplicateTemplateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateDuplicateTemplateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateDuplicateTemplateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateDuplicateTemplateUnauthorizedErrorData, + 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 TemplateDuplicateTemplateBadRequestIssueTypedDict(TypedDict): @@ -68,10 +138,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 +153,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): @@ -97,14 +168,11 @@ class TemplateDuplicateTemplateVisibility(str, Enum): 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): - 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" @@ -139,13 +207,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 +239,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 +253,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..2380b64 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 @@ -12,7 +19,7 @@ from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict -class QueryParamType(str, Enum): +class TemplateFindTemplatesQueryParamType(str, Enum): r"""Filter templates by type.""" PUBLIC = "PUBLIC" @@ -26,7 +33,7 @@ class TemplateFindTemplatesRequestTypedDict(TypedDict): r"""The pagination page number, starts at 1.""" per_page: NotRequired[float] r"""The number of items per page.""" - type: NotRequired[QueryParamType] + type: NotRequired[TemplateFindTemplatesQueryParamType] r"""Filter templates by type.""" folder_id: NotRequired[str] r"""The ID of the folder to filter templates by.""" @@ -53,7 +60,7 @@ class TemplateFindTemplatesRequest(BaseModel): r"""The number of items per page.""" type: Annotated[ - Optional[QueryParamType], + Optional[TemplateFindTemplatesQueryParamType], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), ] = None r"""Filter templates by type.""" @@ -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,75 @@ 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 TemplateFindTemplatesForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateFindTemplatesForbiddenIssue(BaseModel): + message: str + + +class TemplateFindTemplatesForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateFindTemplatesForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateFindTemplatesForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateFindTemplatesForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateFindTemplatesForbiddenErrorData, + 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 TemplateFindTemplatesUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateFindTemplatesUnauthorizedIssue(BaseModel): + message: str + + +class TemplateFindTemplatesUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateFindTemplatesUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateFindTemplatesUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateFindTemplatesUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateFindTemplatesUnauthorizedErrorData, + 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 TemplateFindTemplatesBadRequestIssueTypedDict(TypedDict): @@ -148,10 +225,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 +240,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): @@ -177,14 +255,11 @@ class TemplateFindTemplatesVisibility(str, Enum): 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): - 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" @@ -251,6 +326,7 @@ class TemplateFindTemplatesFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[TemplateFindTemplatesValue3TypedDict]] default_value: NotRequired[str] @@ -266,6 +342,8 @@ class TemplateFindTemplatesFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[TemplateFindTemplatesValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -289,15 +367,22 @@ class TemplateFindTemplatesValue2(BaseModel): value: str +class TemplateFindTemplatesDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class TemplateFindTemplatesFieldMetaCheckboxTypedDict(TypedDict): type: TemplateFindTemplatesTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[TemplateFindTemplatesValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[TemplateFindTemplatesDirection2] class TemplateFindTemplatesFieldMetaCheckbox(BaseModel): @@ -311,6 +396,8 @@ class TemplateFindTemplatesFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[TemplateFindTemplatesValue2]] = None validation_rule: Annotated[ @@ -321,6 +408,10 @@ class TemplateFindTemplatesFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[TemplateFindTemplatesDirection2] = ( + TemplateFindTemplatesDirection2.VERTICAL + ) + class TemplateFindTemplatesTypeRadio(str, Enum): RADIO = "radio" @@ -340,13 +431,20 @@ class TemplateFindTemplatesValue1(BaseModel): value: str +class TemplateFindTemplatesDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class TemplateFindTemplatesFieldMetaRadioTypedDict(TypedDict): type: TemplateFindTemplatesTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[TemplateFindTemplatesValue1TypedDict]] + direction: NotRequired[TemplateFindTemplatesDirection1] class TemplateFindTemplatesFieldMetaRadio(BaseModel): @@ -360,8 +458,14 @@ class TemplateFindTemplatesFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[TemplateFindTemplatesValue1]] = None + direction: Optional[TemplateFindTemplatesDirection1] = ( + TemplateFindTemplatesDirection1.VERTICAL + ) + class TemplateFindTemplatesTypeNumber(str, Enum): NUMBER = "number" @@ -373,18 +477,27 @@ class TemplateFindTemplatesTextAlign6(str, Enum): RIGHT = "right" +class TemplateFindTemplatesVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class TemplateFindTemplatesFieldMetaNumberTypedDict(TypedDict): type: TemplateFindTemplatesTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[TemplateFindTemplatesTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[TemplateFindTemplatesVerticalAlign2]] class TemplateFindTemplatesFieldMetaNumber(BaseModel): @@ -398,20 +511,90 @@ class TemplateFindTemplatesFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[TemplateFindTemplatesTextAlign6], pydantic.Field(alias="textAlign") ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[TemplateFindTemplatesVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -423,16 +606,25 @@ class TemplateFindTemplatesTextAlign5(str, Enum): RIGHT = "right" +class TemplateFindTemplatesVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class TemplateFindTemplatesFieldMetaTextTypedDict(TypedDict): type: TemplateFindTemplatesTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[TemplateFindTemplatesTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[TemplateFindTemplatesVerticalAlign1]] class TemplateFindTemplatesFieldMetaText(BaseModel): @@ -446,18 +638,73 @@ class TemplateFindTemplatesFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[TemplateFindTemplatesTextAlign5], pydantic.Field(alias="textAlign") ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[TemplateFindTemplatesVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 TemplateFindTemplatesTypeDate(str, Enum): DATE = "date" @@ -490,7 +737,7 @@ class TemplateFindTemplatesFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateFindTemplatesTextAlign4], pydantic.Field(alias="textAlign") @@ -528,7 +775,7 @@ class TemplateFindTemplatesFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateFindTemplatesTextAlign3], pydantic.Field(alias="textAlign") @@ -566,7 +813,7 @@ class TemplateFindTemplatesFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateFindTemplatesTextAlign2], pydantic.Field(alias="textAlign") @@ -604,21 +851,49 @@ class TemplateFindTemplatesFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateFindTemplatesTextAlign1], pydantic.Field(alias="textAlign") ] = None +class TemplateFindTemplatesTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class TemplateFindTemplatesFieldMetaSignatureTypedDict(TypedDict): + type: TemplateFindTemplatesTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class TemplateFindTemplatesFieldMetaSignature(BaseModel): + type: TemplateFindTemplatesTypeSignature + + 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")] = 12 + + TemplateFindTemplatesFieldMetaUnionTypedDict = TypeAliasType( "TemplateFindTemplatesFieldMetaUnionTypedDict", Union[ - TemplateFindTemplatesFieldMetaRadioTypedDict, + TemplateFindTemplatesFieldMetaSignatureTypedDict, TemplateFindTemplatesFieldMetaInitialsTypedDict, TemplateFindTemplatesFieldMetaNameTypedDict, TemplateFindTemplatesFieldMetaEmailTypedDict, TemplateFindTemplatesFieldMetaDateTypedDict, + TemplateFindTemplatesFieldMetaRadioTypedDict, TemplateFindTemplatesFieldMetaDropdownTypedDict, TemplateFindTemplatesFieldMetaCheckboxTypedDict, TemplateFindTemplatesFieldMetaTextTypedDict, @@ -630,11 +905,12 @@ class TemplateFindTemplatesFieldMetaInitials(BaseModel): TemplateFindTemplatesFieldMetaUnion = TypeAliasType( "TemplateFindTemplatesFieldMetaUnion", Union[ - TemplateFindTemplatesFieldMetaRadio, + TemplateFindTemplatesFieldMetaSignature, TemplateFindTemplatesFieldMetaInitials, TemplateFindTemplatesFieldMetaName, TemplateFindTemplatesFieldMetaEmail, TemplateFindTemplatesFieldMetaDate, + TemplateFindTemplatesFieldMetaRadio, TemplateFindTemplatesFieldMetaDropdown, TemplateFindTemplatesFieldMetaCheckbox, TemplateFindTemplatesFieldMetaText, @@ -644,38 +920,46 @@ class TemplateFindTemplatesFieldMetaInitials(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[TemplateFindTemplatesFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -685,18 +969,18 @@ class TemplateFindTemplatesField(BaseModel): Nullable[TemplateFindTemplatesFieldMetaUnion], pydantic.Field(alias="fieldMeta") ] - position_x: Annotated[Optional[Any], pydantic.Field(alias="positionX")] = None - - position_y: Annotated[Optional[Any], pydantic.Field(alias="positionY")] = None + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - width: Optional[Any] = None - - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -749,14 +1033,11 @@ class TemplateFindTemplatesSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -780,13 +1061,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 @@ -795,11 +1075,14 @@ class TemplateFindTemplatesRecipientTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[TemplateFindTemplatesRecipientAuthOptionsTypedDict] 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 +1099,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 @@ -840,22 +1119,29 @@ class TemplateFindTemplatesRecipient(BaseModel): ] 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 = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -895,14 +1181,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 +1195,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 +1216,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 +1250,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 +1264,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 +1281,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", @@ -1070,13 +1328,9 @@ class TemplateFindTemplatesResponseTypedDict(TypedDict): data: List[TemplateFindTemplatesDataTypedDict] count: float - r"""The total number of items.""" current_page: float - r"""The current page number, starts at 1.""" per_page: float - r"""The number of items per page.""" total_pages: float - r"""The total number of pages.""" class TemplateFindTemplatesResponse(BaseModel): @@ -1085,13 +1339,9 @@ class TemplateFindTemplatesResponse(BaseModel): data: List[TemplateFindTemplatesData] count: float - r"""The total number of items.""" current_page: Annotated[float, pydantic.Field(alias="currentPage")] - r"""The current page number, starts at 1.""" per_page: Annotated[float, pydantic.Field(alias="perPage")] - r"""The number of items per page.""" total_pages: Annotated[float, pydantic.Field(alias="totalPages")] - r"""The total number of pages.""" diff --git a/src/documenso_sdk/models/template_gettemplatebyidop.py b/src/documenso_sdk/models/template_gettemplatebyidop.py index 329fe18..bb1d5ea 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,75 @@ 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 TemplateGetTemplateByIDForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateGetTemplateByIDForbiddenIssue(BaseModel): + message: str + + +class TemplateGetTemplateByIDForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateGetTemplateByIDForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateGetTemplateByIDForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateGetTemplateByIDForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateGetTemplateByIDForbiddenErrorData, + 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 TemplateGetTemplateByIDUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateGetTemplateByIDUnauthorizedIssue(BaseModel): + message: str + + +class TemplateGetTemplateByIDUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateGetTemplateByIDUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateGetTemplateByIDUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateGetTemplateByIDUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateGetTemplateByIDUnauthorizedErrorData, + 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 TemplateGetTemplateByIDBadRequestIssueTypedDict(TypedDict): @@ -106,10 +183,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 +198,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): @@ -135,14 +213,11 @@ class TemplateGetTemplateByIDVisibility(str, Enum): 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): - 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" @@ -166,21 +241,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 +264,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" @@ -201,56 +279,42 @@ class TemplateGetTemplateByIDDistributionMethod(str, Enum): class TemplateGetTemplateByIDEmailSettingsTypedDict(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 TemplateGetTemplateByIDEmailSettings(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 TemplateGetTemplateByIDTemplateMetaTypedDict(TypedDict): @@ -259,16 +323,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 +349,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 +373,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 +382,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 +396,11 @@ def serialize_model(self, handler): "message", "timezone", "dateFormat", - "signingOrder", "redirectUrl", "emailSettings", + "emailId", + "emailReplyTo", + "templateId", ] null_default_fields = [] @@ -360,17 +431,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 +454,8 @@ class TemplateGetTemplateByIDDirectLink(BaseModel): float, pydantic.Field(alias="directTemplateRecipientId") ] + template_id: Annotated[float, pydantic.Field(alias="templateId")] + class TemplateGetTemplateByIDUserTypedDict(TypedDict): id: float @@ -452,14 +526,11 @@ class TemplateGetTemplateByIDSendStatus(str, Enum): 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): - r"""The type of authentication required for the recipient to sign the document.""" - ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -483,13 +554,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 @@ -498,11 +568,14 @@ class TemplateGetTemplateByIDRecipientTypedDict(TypedDict): signed_at: Nullable[str] auth_options: Nullable[TemplateGetTemplateByIDRecipientAuthOptionsTypedDict] 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 +592,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 @@ -543,22 +612,29 @@ class TemplateGetTemplateByIDRecipient(BaseModel): ] 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 = [] + optional_fields = ["documentId", "templateId"] nullable_fields = [ - "documentId", - "templateId", "documentDeletedAt", "expired", "signedAt", "authOptions", "signingOrder", "rejectionReason", + "documentId", + "templateId", ] null_default_fields = [] @@ -619,6 +695,7 @@ class TemplateGetTemplateByIDFieldMetaDropdownTypedDict(TypedDict): placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[TemplateGetTemplateByIDValue3TypedDict]] default_value: NotRequired[str] @@ -634,6 +711,8 @@ class TemplateGetTemplateByIDFieldMetaDropdown(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[TemplateGetTemplateByIDValue3]] = None default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None @@ -657,15 +736,22 @@ class TemplateGetTemplateByIDValue2(BaseModel): value: str +class TemplateGetTemplateByIDDirection2(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class TemplateGetTemplateByIDFieldMetaCheckboxTypedDict(TypedDict): type: TemplateGetTemplateByIDTypeCheckbox label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[TemplateGetTemplateByIDValue2TypedDict]] validation_rule: NotRequired[str] validation_length: NotRequired[float] + direction: NotRequired[TemplateGetTemplateByIDDirection2] class TemplateGetTemplateByIDFieldMetaCheckbox(BaseModel): @@ -679,6 +765,8 @@ class TemplateGetTemplateByIDFieldMetaCheckbox(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[TemplateGetTemplateByIDValue2]] = None validation_rule: Annotated[ @@ -689,6 +777,10 @@ class TemplateGetTemplateByIDFieldMetaCheckbox(BaseModel): Optional[float], pydantic.Field(alias="validationLength") ] = None + direction: Optional[TemplateGetTemplateByIDDirection2] = ( + TemplateGetTemplateByIDDirection2.VERTICAL + ) + class TemplateGetTemplateByIDTypeRadio(str, Enum): RADIO = "radio" @@ -708,13 +800,20 @@ class TemplateGetTemplateByIDValue1(BaseModel): value: str +class TemplateGetTemplateByIDDirection1(str, Enum): + VERTICAL = "vertical" + HORIZONTAL = "horizontal" + + class TemplateGetTemplateByIDFieldMetaRadioTypedDict(TypedDict): type: TemplateGetTemplateByIDTypeRadio label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] values: NotRequired[List[TemplateGetTemplateByIDValue1TypedDict]] + direction: NotRequired[TemplateGetTemplateByIDDirection1] class TemplateGetTemplateByIDFieldMetaRadio(BaseModel): @@ -728,8 +827,14 @@ class TemplateGetTemplateByIDFieldMetaRadio(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + values: Optional[List[TemplateGetTemplateByIDValue1]] = None + direction: Optional[TemplateGetTemplateByIDDirection1] = ( + TemplateGetTemplateByIDDirection1.VERTICAL + ) + class TemplateGetTemplateByIDTypeNumber(str, Enum): NUMBER = "number" @@ -741,18 +846,27 @@ class TemplateGetTemplateByIDTextAlign6(str, Enum): RIGHT = "right" +class TemplateGetTemplateByIDVerticalAlign2(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class TemplateGetTemplateByIDFieldMetaNumberTypedDict(TypedDict): type: TemplateGetTemplateByIDTypeNumber label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] - number_format: NotRequired[str] - value: NotRequired[str] - min_value: NotRequired[float] - max_value: NotRequired[float] font_size: NotRequired[float] + number_format: NotRequired[Nullable[str]] + value: NotRequired[str] + min_value: NotRequired[Nullable[float]] + max_value: NotRequired[Nullable[float]] text_align: NotRequired[TemplateGetTemplateByIDTextAlign6] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[TemplateGetTemplateByIDVerticalAlign2]] class TemplateGetTemplateByIDFieldMetaNumber(BaseModel): @@ -766,20 +880,90 @@ class TemplateGetTemplateByIDFieldMetaNumber(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - number_format: Annotated[Optional[str], pydantic.Field(alias="numberFormat")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 - value: Optional[str] = None + number_format: Annotated[ + OptionalNullable[str], pydantic.Field(alias="numberFormat") + ] = UNSET - min_value: Annotated[Optional[float], pydantic.Field(alias="minValue")] = None + value: Optional[str] = None - max_value: Annotated[Optional[float], pydantic.Field(alias="maxValue")] = None + min_value: Annotated[OptionalNullable[float], pydantic.Field(alias="minValue")] = ( + UNSET + ) - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + max_value: Annotated[OptionalNullable[float], pydantic.Field(alias="maxValue")] = ( + UNSET + ) text_align: Annotated[ Optional[TemplateGetTemplateByIDTextAlign6], pydantic.Field(alias="textAlign") ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[TemplateGetTemplateByIDVerticalAlign2], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "numberFormat", + "value", + "minValue", + "maxValue", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = [ + "numberFormat", + "minValue", + "maxValue", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + 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" @@ -791,16 +975,25 @@ class TemplateGetTemplateByIDTextAlign5(str, Enum): RIGHT = "right" +class TemplateGetTemplateByIDVerticalAlign1(str, Enum): + TOP = "top" + MIDDLE = "middle" + BOTTOM = "bottom" + + class TemplateGetTemplateByIDFieldMetaTextTypedDict(TypedDict): type: TemplateGetTemplateByIDTypeText label: NotRequired[str] placeholder: NotRequired[str] required: NotRequired[bool] read_only: NotRequired[bool] + font_size: NotRequired[float] text: NotRequired[str] character_limit: NotRequired[float] - font_size: NotRequired[float] text_align: NotRequired[TemplateGetTemplateByIDTextAlign5] + line_height: NotRequired[Nullable[float]] + letter_spacing: NotRequired[Nullable[float]] + vertical_align: NotRequired[Nullable[TemplateGetTemplateByIDVerticalAlign1]] class TemplateGetTemplateByIDFieldMetaText(BaseModel): @@ -814,18 +1007,73 @@ class TemplateGetTemplateByIDFieldMetaText(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 + 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[TemplateGetTemplateByIDTextAlign5], pydantic.Field(alias="textAlign") ] = None + line_height: Annotated[ + OptionalNullable[float], pydantic.Field(alias="lineHeight") + ] = UNSET + + letter_spacing: Annotated[ + OptionalNullable[float], pydantic.Field(alias="letterSpacing") + ] = UNSET + + vertical_align: Annotated[ + OptionalNullable[TemplateGetTemplateByIDVerticalAlign1], + pydantic.Field(alias="verticalAlign"), + ] = UNSET + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "label", + "placeholder", + "required", + "readOnly", + "fontSize", + "text", + "characterLimit", + "textAlign", + "lineHeight", + "letterSpacing", + "verticalAlign", + ] + nullable_fields = ["lineHeight", "letterSpacing", "verticalAlign"] + 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 TemplateGetTemplateByIDTypeDate(str, Enum): DATE = "date" @@ -858,7 +1106,7 @@ class TemplateGetTemplateByIDFieldMetaDate(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateGetTemplateByIDTextAlign4], pydantic.Field(alias="textAlign") @@ -896,7 +1144,7 @@ class TemplateGetTemplateByIDFieldMetaEmail(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateGetTemplateByIDTextAlign3], pydantic.Field(alias="textAlign") @@ -934,7 +1182,7 @@ class TemplateGetTemplateByIDFieldMetaName(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateGetTemplateByIDTextAlign2], pydantic.Field(alias="textAlign") @@ -972,21 +1220,49 @@ class TemplateGetTemplateByIDFieldMetaInitials(BaseModel): read_only: Annotated[Optional[bool], pydantic.Field(alias="readOnly")] = None - font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = None + font_size: Annotated[Optional[float], pydantic.Field(alias="fontSize")] = 12 text_align: Annotated[ Optional[TemplateGetTemplateByIDTextAlign1], pydantic.Field(alias="textAlign") ] = None +class TemplateGetTemplateByIDTypeSignature(str, Enum): + SIGNATURE = "signature" + + +class TemplateGetTemplateByIDFieldMetaSignatureTypedDict(TypedDict): + type: TemplateGetTemplateByIDTypeSignature + label: NotRequired[str] + placeholder: NotRequired[str] + required: NotRequired[bool] + read_only: NotRequired[bool] + font_size: NotRequired[float] + + +class TemplateGetTemplateByIDFieldMetaSignature(BaseModel): + type: TemplateGetTemplateByIDTypeSignature + + 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")] = 12 + + TemplateGetTemplateByIDFieldMetaUnionTypedDict = TypeAliasType( "TemplateGetTemplateByIDFieldMetaUnionTypedDict", Union[ - TemplateGetTemplateByIDFieldMetaRadioTypedDict, + TemplateGetTemplateByIDFieldMetaSignatureTypedDict, TemplateGetTemplateByIDFieldMetaInitialsTypedDict, TemplateGetTemplateByIDFieldMetaNameTypedDict, TemplateGetTemplateByIDFieldMetaEmailTypedDict, TemplateGetTemplateByIDFieldMetaDateTypedDict, + TemplateGetTemplateByIDFieldMetaRadioTypedDict, TemplateGetTemplateByIDFieldMetaDropdownTypedDict, TemplateGetTemplateByIDFieldMetaCheckboxTypedDict, TemplateGetTemplateByIDFieldMetaTextTypedDict, @@ -998,11 +1274,12 @@ class TemplateGetTemplateByIDFieldMetaInitials(BaseModel): TemplateGetTemplateByIDFieldMetaUnion = TypeAliasType( "TemplateGetTemplateByIDFieldMetaUnion", Union[ - TemplateGetTemplateByIDFieldMetaRadio, + TemplateGetTemplateByIDFieldMetaSignature, TemplateGetTemplateByIDFieldMetaInitials, TemplateGetTemplateByIDFieldMetaName, TemplateGetTemplateByIDFieldMetaEmail, TemplateGetTemplateByIDFieldMetaDate, + TemplateGetTemplateByIDFieldMetaRadio, TemplateGetTemplateByIDFieldMetaDropdown, TemplateGetTemplateByIDFieldMetaCheckbox, TemplateGetTemplateByIDFieldMetaText, @@ -1012,38 +1289,46 @@ class TemplateGetTemplateByIDFieldMetaInitials(BaseModel): 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.""" + position_x: Any + position_y: Any + width: Any + height: Any custom_text: str inserted: bool field_meta: Nullable[TemplateGetTemplateByIDFieldMetaUnionTypedDict] - 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 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 - r"""The page number of the field on the document. Starts from 1.""" + + position_x: Annotated[Any, pydantic.Field(alias="positionX")] + + position_y: Annotated[Any, pydantic.Field(alias="positionY")] + + width: Any + + height: Any custom_text: Annotated[str, pydantic.Field(alias="customText")] @@ -1054,18 +1339,18 @@ class TemplateGetTemplateByIDField(BaseModel): 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 + document_id: Annotated[ + OptionalNullable[float], pydantic.Field(alias="documentId") + ] = UNSET - height: Optional[Any] = None + 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 = ["documentId", "templateId"] + nullable_fields = ["fieldMeta", "documentId", "templateId"] null_default_fields = [] serialized = handler(self) @@ -1169,6 +1454,17 @@ def serialize_model(self, handler): return m +class TemplateGetTemplateByIDEnvelopeItemTypedDict(TypedDict): + id: str + envelope_id: str + + +class TemplateGetTemplateByIDEnvelopeItem(BaseModel): + id: str + + envelope_id: Annotated[str, pydantic.Field(alias="envelopeId")] + + class TemplateGetTemplateByIDResponseTypedDict(TypedDict): r"""Successful response""" @@ -1180,19 +1476,21 @@ 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] + envelope_items: List[TemplateGetTemplateByIDEnvelopeItemTypedDict] + template_document_data_id: NotRequired[str] class TemplateGetTemplateByIDResponse(BaseModel): @@ -1217,10 +1515,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 +1525,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 +1548,21 @@ class TemplateGetTemplateByIDResponse(BaseModel): folder: Nullable[TemplateGetTemplateByIDFolder] + envelope_items: Annotated[ + List[TemplateGetTemplateByIDEnvelopeItem], pydantic.Field(alias="envelopeItems") + ] + + 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..4e6e9ee 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,75 @@ 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 TemplateToggleTemplateDirectLinkForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateToggleTemplateDirectLinkForbiddenIssue(BaseModel): + message: str + + +class TemplateToggleTemplateDirectLinkForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateToggleTemplateDirectLinkForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateToggleTemplateDirectLinkForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateToggleTemplateDirectLinkForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateToggleTemplateDirectLinkForbiddenErrorData, + 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 TemplateToggleTemplateDirectLinkUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateToggleTemplateDirectLinkUnauthorizedIssue(BaseModel): + message: str + + +class TemplateToggleTemplateDirectLinkUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateToggleTemplateDirectLinkUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateToggleTemplateDirectLinkUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateToggleTemplateDirectLinkUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateToggleTemplateDirectLinkUnauthorizedErrorData, + 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 TemplateToggleTemplateDirectLinkBadRequestIssueTypedDict(TypedDict): @@ -71,10 +141,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 +156,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 +176,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 +185,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..d821710 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, @@ -17,21 +18,18 @@ from typing_extensions import Annotated, NotRequired, TypedDict -class TemplateUpdateTemplateVisibilityRequest(str, Enum): +class TemplateUpdateTemplateDataVisibility(str, Enum): EVERYONE = "EVERYONE" MANAGER_AND_ABOVE = "MANAGER_AND_ABOVE" ADMIN = "ADMIN" -class TemplateUpdateTemplateGlobalAccessAuthRequest(str, Enum): - r"""The type of authentication required for the recipient to access the document.""" - +class TemplateUpdateTemplateDataGlobalAccessAuth(str, Enum): ACCOUNT = "ACCOUNT" + TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" -class TemplateUpdateTemplateGlobalActionAuthRequest(str, Enum): - r"""The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only.""" - +class TemplateUpdateTemplateDataGlobalActionAuth(str, Enum): ACCOUNT = "ACCOUNT" PASSKEY = "PASSKEY" TWO_FACTOR_AUTH = "TWO_FACTOR_AUTH" @@ -46,15 +44,14 @@ class TemplateUpdateTemplateDataType(str, Enum): class TemplateUpdateTemplateDataTypedDict(TypedDict): title: NotRequired[str] external_id: NotRequired[Nullable[str]] - visibility: NotRequired[TemplateUpdateTemplateVisibilityRequest] - global_access_auth: NotRequired[List[TemplateUpdateTemplateGlobalAccessAuthRequest]] - global_action_auth: NotRequired[List[TemplateUpdateTemplateGlobalActionAuthRequest]] + visibility: NotRequired[TemplateUpdateTemplateDataVisibility] + global_access_auth: NotRequired[List[TemplateUpdateTemplateDataGlobalAccessAuth]] + global_action_auth: NotRequired[List[TemplateUpdateTemplateDataGlobalActionAuth]] 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[TemplateUpdateTemplateDataType] use_legacy_field_insertion: NotRequired[bool] + folder_id: NotRequired[Nullable[str]] class TemplateUpdateTemplateData(BaseModel): @@ -64,25 +61,23 @@ class TemplateUpdateTemplateData(BaseModel): OptionalNullable[str], pydantic.Field(alias="externalId") ] = UNSET - visibility: Optional[TemplateUpdateTemplateVisibilityRequest] = None + visibility: Optional[TemplateUpdateTemplateDataVisibility] = None global_access_auth: Annotated[ - Optional[List[TemplateUpdateTemplateGlobalAccessAuthRequest]], + Optional[List[TemplateUpdateTemplateDataGlobalAccessAuth]], pydantic.Field(alias="globalAccessAuth"), ] = None global_action_auth: Annotated[ - Optional[List[TemplateUpdateTemplateGlobalActionAuthRequest]], + Optional[List[TemplateUpdateTemplateDataGlobalActionAuth]], 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[TemplateUpdateTemplateDataType] = None @@ -90,6 +85,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 +101,9 @@ def serialize_model(self, handler): "publicDescription", "type", "useLegacyFieldInsertion", + "folderId", ] - nullable_fields = ["externalId"] + nullable_fields = ["externalId", "folderId"] null_default_fields = [] serialized = handler(self) @@ -132,84 +132,76 @@ 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): - r"""The distribution method to use when sending the document to the recipients.""" - EMAIL = "EMAIL" NONE = "NONE" class TemplateUpdateTemplateEmailSettingsTypedDict(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 TemplateUpdateTemplateEmailSettings(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 TemplateUpdateTemplateLanguage(str, Enum): - r"""The language to use for email communications with recipients.""" - DE = "de" EN = "en" FR = "fr" @@ -225,50 +217,43 @@ class TemplateUpdateTemplateSigningOrder(str, Enum): class TemplateUpdateTemplateMetaTypedDict(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[TemplateUpdateTemplateDateFormat] - 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.""" language: NotRequired[TemplateUpdateTemplateLanguage] - 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[TemplateUpdateTemplateSigningOrder] allow_dictate_next_signer: NotRequired[bool] class TemplateUpdateTemplateMeta(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[TemplateUpdateTemplateDateFormat], pydantic.Field(alias="dateFormat") ] = None - r"""The date format to use for date fields and signing the document.""" distribution_method: Annotated[ Optional[TemplateUpdateTemplateDistributionMethod], 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[TemplateUpdateTemplateEmailSettings], @@ -276,25 +261,20 @@ class TemplateUpdateTemplateMeta(BaseModel): ] = 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[TemplateUpdateTemplateLanguage] = 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[TemplateUpdateTemplateSigningOrder], @@ -305,6 +285,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 +362,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 +377,75 @@ 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 TemplateUpdateTemplateForbiddenIssueTypedDict(TypedDict): + message: str + + +class TemplateUpdateTemplateForbiddenIssue(BaseModel): + message: str + + +class TemplateUpdateTemplateForbiddenErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateUpdateTemplateForbiddenIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateUpdateTemplateForbiddenError(DocumensoError): + r"""Insufficient access""" + + data: TemplateUpdateTemplateForbiddenErrorData = field(hash=False) + + def __init__( + self, + data: TemplateUpdateTemplateForbiddenErrorData, + 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 TemplateUpdateTemplateUnauthorizedIssueTypedDict(TypedDict): + message: str + + +class TemplateUpdateTemplateUnauthorizedIssue(BaseModel): + message: str + + +class TemplateUpdateTemplateUnauthorizedErrorData(BaseModel): + message: str + + code: str + + issues: Optional[List[TemplateUpdateTemplateUnauthorizedIssue]] = None + + +@dataclass(unsafe_hash=True) +class TemplateUpdateTemplateUnauthorizedError(DocumensoError): + r"""Authorization not provided""" + + data: TemplateUpdateTemplateUnauthorizedErrorData = field(hash=False) + + def __init__( + self, + data: TemplateUpdateTemplateUnauthorizedErrorData, + 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 TemplateUpdateTemplateBadRequestIssueTypedDict(TypedDict): @@ -369,10 +464,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 +479,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): @@ -398,14 +494,11 @@ class TemplateUpdateTemplateVisibilityResponse(str, Enum): 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): - 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" @@ -440,13 +533,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 +564,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 +578,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..d0e6ec9 100644 --- a/src/documenso_sdk/sdk.py +++ b/src/documenso_sdk/sdk.py @@ -15,20 +15,35 @@ 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.envelopes import Envelopes + from documenso_sdk.folders import Folders + from documenso_sdk.template_sdk import TemplateSDK from documenso_sdk.templates import Templates class Documenso(BaseSDK): - r"""Documenso v2 beta API: Subject to breaking changes until v2 is fully released.""" + r"""Documenso v2 API: Welcome to the Documenso v2 API. + This API provides access to our system, which you can use to integrate applications, automate workflows, or build custom tools. + """ + + envelopes: "Envelopes" documents: "Documents" + document: "DocumentSDK" templates: "Templates" + folders: "Folders" + template: "TemplateSDK" embedding: "Embedding" _sub_sdk_map = { + "envelopes": ("documenso_sdk.envelopes", "Envelopes"), "documents": ("documenso_sdk.documents", "Documents"), + "document": ("documenso_sdk.document_sdk", "DocumentSDK"), "templates": ("documenso_sdk.templates", "Templates"), + "folders": ("documenso_sdk.folders", "Folders"), + "template": ("documenso_sdk.template_sdk", "TemplateSDK"), "embedding": ("documenso_sdk.embedding", "Embedding"), } @@ -57,7 +72,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 +81,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/sdkconfiguration.py b/src/documenso_sdk/sdkconfiguration.py index 3e41ba5..eb22983 100644 --- a/src/documenso_sdk/sdkconfiguration.py +++ b/src/documenso_sdk/sdkconfiguration.py @@ -16,7 +16,7 @@ SERVERS = [ - "https://app.documenso.com/api/v2-beta", + "https://app.documenso.com/api/v2", ] """Contains the list of servers available to the SDK""" diff --git a/src/documenso_sdk/template_sdk.py b/src/documenso_sdk/template_sdk.py new file mode 100644 index 0000000..af2455b --- /dev/null +++ b/src/documenso_sdk/template_sdk.py @@ -0,0 +1,355 @@ +"""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, + attachments: Optional[ + Union[ + List[models.TemplateCreateTemplateTemporaryAttachment], + List[models.TemplateCreateTemplateTemporaryAttachmentTypedDict], + ] + ] = 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: + :param folder_id: + :param external_id: + :param visibility: + :param global_access_auth: + :param global_action_auth: + :param public_title: + :param public_description: + :param type: + :param meta: + :param attachments: + :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] + ), + attachments=utils.get_pydantic_model( + attachments, + Optional[List[models.TemplateCreateTemplateTemporaryAttachment]], + ), + ) + + 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", "401", "403", "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, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateTemporaryUnauthorizedErrorData, http_res + ) + raise models.TemplateCreateTemplateTemporaryUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateTemporaryForbiddenErrorData, http_res + ) + raise models.TemplateCreateTemplateTemporaryForbiddenError( + 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, + attachments: Optional[ + Union[ + List[models.TemplateCreateTemplateTemporaryAttachment], + List[models.TemplateCreateTemplateTemporaryAttachmentTypedDict], + ] + ] = 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: + :param folder_id: + :param external_id: + :param visibility: + :param global_access_auth: + :param global_action_auth: + :param public_title: + :param public_description: + :param type: + :param meta: + :param attachments: + :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] + ), + attachments=utils.get_pydantic_model( + attachments, + Optional[List[models.TemplateCreateTemplateTemporaryAttachment]], + ), + ) + + 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", "401", "403", "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, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateTemporaryUnauthorizedErrorData, http_res + ) + raise models.TemplateCreateTemplateTemporaryUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateTemporaryForbiddenErrorData, http_res + ) + raise models.TemplateCreateTemplateTemporaryForbiddenError( + 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..65f27ac 100644 --- a/src/documenso_sdk/templates.py +++ b/src/documenso_sdk/templates.py @@ -42,7 +42,7 @@ def find( query: Optional[str] = None, page: Optional[float] = None, per_page: Optional[float] = None, - type_: Optional[models.QueryParamType] = None, + type_: Optional[models.TemplateFindTemplatesQueryParamType] = None, folder_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -110,13 +110,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -130,6 +130,16 @@ def find( models.TemplateFindTemplatesBadRequestErrorData, http_res ) raise models.TemplateFindTemplatesBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateFindTemplatesUnauthorizedErrorData, http_res + ) + raise models.TemplateFindTemplatesUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateFindTemplatesForbiddenErrorData, http_res + ) + raise models.TemplateFindTemplatesForbiddenError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.TemplateFindTemplatesNotFoundErrorData, http_res @@ -157,7 +167,7 @@ async def find_async( query: Optional[str] = None, page: Optional[float] = None, per_page: Optional[float] = None, - type_: Optional[models.QueryParamType] = None, + type_: Optional[models.TemplateFindTemplatesQueryParamType] = None, folder_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -225,13 +235,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -245,6 +255,16 @@ async def find_async( models.TemplateFindTemplatesBadRequestErrorData, http_res ) raise models.TemplateFindTemplatesBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateFindTemplatesUnauthorizedErrorData, http_res + ) + raise models.TemplateFindTemplatesUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateFindTemplatesForbiddenErrorData, http_res + ) + raise models.TemplateFindTemplatesForbiddenError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.TemplateFindTemplatesNotFoundErrorData, http_res @@ -326,13 +346,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -346,6 +366,18 @@ def get( models.TemplateGetTemplateByIDBadRequestErrorData, http_res ) raise models.TemplateGetTemplateByIDBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateGetTemplateByIDUnauthorizedErrorData, http_res + ) + raise models.TemplateGetTemplateByIDUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateGetTemplateByIDForbiddenErrorData, http_res + ) + raise models.TemplateGetTemplateByIDForbiddenError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.TemplateGetTemplateByIDNotFoundErrorData, http_res @@ -427,13 +459,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -447,6 +479,18 @@ async def get_async( models.TemplateGetTemplateByIDBadRequestErrorData, http_res ) raise models.TemplateGetTemplateByIDBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateGetTemplateByIDUnauthorizedErrorData, http_res + ) + raise models.TemplateGetTemplateByIDUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateGetTemplateByIDForbiddenErrorData, http_res + ) + raise models.TemplateGetTemplateByIDForbiddenError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.TemplateGetTemplateByIDNotFoundErrorData, http_res @@ -468,6 +512,254 @@ async def get_async( raise models.APIError("Unexpected response received", http_res) + def create( + self, + *, + payload: Union[ + models.TemplateCreateTemplatePayload, + models.TemplateCreateTemplatePayloadTypedDict, + ], + file: Union[ + models.TemplateCreateTemplateFile, + models.TemplateCreateTemplateFileTypedDict, + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.TemplateCreateTemplateResponse: + r"""Create template + + Create a new template + + :param payload: + :param file: + :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.TemplateCreateTemplateRequest( + payload=utils.get_pydantic_model( + payload, models.TemplateCreateTemplatePayload + ), + file=utils.get_pydantic_model(file, models.TemplateCreateTemplateFile), + ) + + req = self._build_request( + method="POST", + path="/template/create", + 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, "multipart", models.TemplateCreateTemplateRequest + ), + 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-createTemplate", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.TemplateCreateTemplateResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateBadRequestErrorData, http_res + ) + raise models.TemplateCreateTemplateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateUnauthorizedErrorData, http_res + ) + raise models.TemplateCreateTemplateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateForbiddenErrorData, http_res + ) + raise models.TemplateCreateTemplateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateInternalServerErrorData, http_res + ) + raise models.TemplateCreateTemplateInternalServerError( + 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 create_async( + self, + *, + payload: Union[ + models.TemplateCreateTemplatePayload, + models.TemplateCreateTemplatePayloadTypedDict, + ], + file: Union[ + models.TemplateCreateTemplateFile, + models.TemplateCreateTemplateFileTypedDict, + ], + retries: OptionalNullable[utils.RetryConfig] = UNSET, + server_url: Optional[str] = None, + timeout_ms: Optional[int] = None, + http_headers: Optional[Mapping[str, str]] = None, + ) -> models.TemplateCreateTemplateResponse: + r"""Create template + + Create a new template + + :param payload: + :param file: + :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.TemplateCreateTemplateRequest( + payload=utils.get_pydantic_model( + payload, models.TemplateCreateTemplatePayload + ), + file=utils.get_pydantic_model(file, models.TemplateCreateTemplateFile), + ) + + req = self._build_request_async( + method="POST", + path="/template/create", + 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, "multipart", models.TemplateCreateTemplateRequest + ), + 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-createTemplate", + oauth2_scopes=None, + security_source=get_security_from_env( + self.sdk_configuration.security, models.Security + ), + ), + request=req, + error_status_codes=["400", "401", "403", "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.TemplateCreateTemplateResponse, http_res + ) + if utils.match_response(http_res, "400", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateBadRequestErrorData, http_res + ) + raise models.TemplateCreateTemplateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateUnauthorizedErrorData, http_res + ) + raise models.TemplateCreateTemplateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateForbiddenErrorData, http_res + ) + raise models.TemplateCreateTemplateForbiddenError(response_data, http_res) + if utils.match_response(http_res, "500", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateTemplateInternalServerErrorData, http_res + ) + raise models.TemplateCreateTemplateInternalServerError( + 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) + def update( self, *, @@ -551,13 +843,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -571,6 +863,18 @@ def update( models.TemplateUpdateTemplateBadRequestErrorData, http_res ) raise models.TemplateUpdateTemplateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateUpdateTemplateUnauthorizedErrorData, http_res + ) + raise models.TemplateUpdateTemplateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateUpdateTemplateForbiddenErrorData, http_res + ) + raise models.TemplateUpdateTemplateForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateUpdateTemplateInternalServerErrorData, http_res @@ -670,13 +974,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -690,6 +994,18 @@ async def update_async( models.TemplateUpdateTemplateBadRequestErrorData, http_res ) raise models.TemplateUpdateTemplateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateUpdateTemplateUnauthorizedErrorData, http_res + ) + raise models.TemplateUpdateTemplateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateUpdateTemplateForbiddenErrorData, http_res + ) + raise models.TemplateUpdateTemplateForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateUpdateTemplateInternalServerErrorData, http_res @@ -769,13 +1085,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -791,6 +1107,20 @@ def duplicate( raise models.TemplateDuplicateTemplateBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDuplicateTemplateUnauthorizedErrorData, http_res + ) + raise models.TemplateDuplicateTemplateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDuplicateTemplateForbiddenErrorData, http_res + ) + raise models.TemplateDuplicateTemplateForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateDuplicateTemplateInternalServerErrorData, http_res @@ -870,13 +1200,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -892,6 +1222,20 @@ async def duplicate_async( raise models.TemplateDuplicateTemplateBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDuplicateTemplateUnauthorizedErrorData, http_res + ) + raise models.TemplateDuplicateTemplateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDuplicateTemplateForbiddenErrorData, http_res + ) + raise models.TemplateDuplicateTemplateForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateDuplicateTemplateInternalServerErrorData, http_res @@ -971,13 +1315,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -991,6 +1335,18 @@ def delete( models.TemplateDeleteTemplateBadRequestErrorData, http_res ) raise models.TemplateDeleteTemplateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDeleteTemplateUnauthorizedErrorData, http_res + ) + raise models.TemplateDeleteTemplateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDeleteTemplateForbiddenErrorData, http_res + ) + raise models.TemplateDeleteTemplateForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateDeleteTemplateInternalServerErrorData, http_res @@ -1070,13 +1426,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1090,6 +1446,18 @@ async def delete_async( models.TemplateDeleteTemplateBadRequestErrorData, http_res ) raise models.TemplateDeleteTemplateBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDeleteTemplateUnauthorizedErrorData, http_res + ) + raise models.TemplateDeleteTemplateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateDeleteTemplateForbiddenErrorData, http_res + ) + raise models.TemplateDeleteTemplateForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateDeleteTemplateInternalServerErrorData, http_res @@ -1116,8 +1484,22 @@ def use( ], distribute_document: Optional[bool] = None, custom_document_data_id: Optional[str] = None, + custom_document_data: Optional[ + Union[ + List[models.TemplateCreateDocumentFromTemplateCustomDocumentDatum], + List[ + models.TemplateCreateDocumentFromTemplateCustomDocumentDatumTypedDict + ], + ] + ] = None, + folder_id: Optional[str] = None, prefill_fields: Optional[ - Union[List[models.PrefillField], List[models.PrefillFieldTypedDict]] + Union[ + List[models.TemplateCreateDocumentFromTemplatePrefillFieldUnion], + List[ + models.TemplateCreateDocumentFromTemplatePrefillFieldUnionTypedDict + ], + ] ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -1129,10 +1511,12 @@ def use( Use the template to create a document :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 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 recipients: + :param distribute_document: + :param custom_document_data_id: + :param custom_document_data: + :param folder_id: + :param prefill_fields: :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 @@ -1156,8 +1540,18 @@ 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.TemplateCreateDocumentFromTemplateCustomDocumentDatum] + ], + ), + folder_id=folder_id, prefill_fields=utils.get_pydantic_model( - prefill_fields, Optional[List[models.PrefillField]] + prefill_fields, + Optional[ + List[models.TemplateCreateDocumentFromTemplatePrefillFieldUnion] + ], ), ) @@ -1197,13 +1591,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1219,6 +1613,20 @@ def use( raise models.TemplateCreateDocumentFromTemplateBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateDocumentFromTemplateUnauthorizedErrorData, http_res + ) + raise models.TemplateCreateDocumentFromTemplateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateDocumentFromTemplateForbiddenErrorData, http_res + ) + raise models.TemplateCreateDocumentFromTemplateForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateCreateDocumentFromTemplateInternalServerErrorData, @@ -1246,8 +1654,22 @@ async def use_async( ], distribute_document: Optional[bool] = None, custom_document_data_id: Optional[str] = None, + custom_document_data: Optional[ + Union[ + List[models.TemplateCreateDocumentFromTemplateCustomDocumentDatum], + List[ + models.TemplateCreateDocumentFromTemplateCustomDocumentDatumTypedDict + ], + ] + ] = None, + folder_id: Optional[str] = None, prefill_fields: Optional[ - Union[List[models.PrefillField], List[models.PrefillFieldTypedDict]] + Union[ + List[models.TemplateCreateDocumentFromTemplatePrefillFieldUnion], + List[ + models.TemplateCreateDocumentFromTemplatePrefillFieldUnionTypedDict + ], + ] ] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -1259,10 +1681,12 @@ async def use_async( Use the template to create a document :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 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 recipients: + :param distribute_document: + :param custom_document_data_id: + :param custom_document_data: + :param folder_id: + :param prefill_fields: :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 @@ -1286,8 +1710,18 @@ 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.TemplateCreateDocumentFromTemplateCustomDocumentDatum] + ], + ), + folder_id=folder_id, prefill_fields=utils.get_pydantic_model( - prefill_fields, Optional[List[models.PrefillField]] + prefill_fields, + Optional[ + List[models.TemplateCreateDocumentFromTemplatePrefillFieldUnion] + ], ), ) @@ -1327,13 +1761,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1349,6 +1783,20 @@ async def use_async( raise models.TemplateCreateDocumentFromTemplateBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateDocumentFromTemplateUnauthorizedErrorData, http_res + ) + raise models.TemplateCreateDocumentFromTemplateUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.TemplateCreateDocumentFromTemplateForbiddenErrorData, http_res + ) + raise models.TemplateCreateDocumentFromTemplateForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.TemplateCreateDocumentFromTemplateInternalServerErrorData, diff --git a/src/documenso_sdk/templates_fields.py b/src/documenso_sdk/templates_fields.py index bd3d37e..2576763 100644 --- a/src/documenso_sdk/templates_fields.py +++ b/src/documenso_sdk/templates_fields.py @@ -83,13 +83,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -105,6 +105,18 @@ def create( raise models.FieldCreateTemplateFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateTemplateFieldUnauthorizedErrorData, http_res + ) + raise models.FieldCreateTemplateFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateTemplateFieldForbiddenErrorData, http_res + ) + raise models.FieldCreateTemplateFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldCreateTemplateFieldInternalServerErrorData, http_res @@ -194,13 +206,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -216,6 +228,18 @@ async def create_async( raise models.FieldCreateTemplateFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateTemplateFieldUnauthorizedErrorData, http_res + ) + raise models.FieldCreateTemplateFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateTemplateFieldForbiddenErrorData, http_res + ) + raise models.FieldCreateTemplateFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldCreateTemplateFieldInternalServerErrorData, http_res @@ -294,13 +318,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -314,6 +338,16 @@ def get( models.FieldGetTemplateFieldBadRequestErrorData, http_res ) raise models.FieldGetTemplateFieldBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldGetTemplateFieldUnauthorizedErrorData, http_res + ) + raise models.FieldGetTemplateFieldUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldGetTemplateFieldForbiddenErrorData, http_res + ) + raise models.FieldGetTemplateFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.FieldGetTemplateFieldNotFoundErrorData, http_res @@ -397,13 +431,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -417,6 +451,16 @@ async def get_async( models.FieldGetTemplateFieldBadRequestErrorData, http_res ) raise models.FieldGetTemplateFieldBadRequestError(response_data, http_res) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldGetTemplateFieldUnauthorizedErrorData, http_res + ) + raise models.FieldGetTemplateFieldUnauthorizedError(response_data, http_res) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldGetTemplateFieldForbiddenErrorData, http_res + ) + raise models.FieldGetTemplateFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.FieldGetTemplateFieldNotFoundErrorData, http_res @@ -511,13 +555,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -533,6 +577,20 @@ def create_many( raise models.FieldCreateTemplateFieldsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateTemplateFieldsUnauthorizedErrorData, http_res + ) + raise models.FieldCreateTemplateFieldsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateTemplateFieldsForbiddenErrorData, http_res + ) + raise models.FieldCreateTemplateFieldsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldCreateTemplateFieldsInternalServerErrorData, http_res @@ -622,13 +680,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -644,6 +702,20 @@ async def create_many_async( raise models.FieldCreateTemplateFieldsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateTemplateFieldsUnauthorizedErrorData, http_res + ) + raise models.FieldCreateTemplateFieldsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldCreateTemplateFieldsForbiddenErrorData, http_res + ) + raise models.FieldCreateTemplateFieldsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldCreateTemplateFieldsInternalServerErrorData, http_res @@ -733,13 +805,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -755,6 +827,18 @@ def update( raise models.FieldUpdateTemplateFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateTemplateFieldUnauthorizedErrorData, http_res + ) + raise models.FieldUpdateTemplateFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateTemplateFieldForbiddenErrorData, http_res + ) + raise models.FieldUpdateTemplateFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldUpdateTemplateFieldInternalServerErrorData, http_res @@ -844,13 +928,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -866,6 +950,18 @@ async def update_async( raise models.FieldUpdateTemplateFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateTemplateFieldUnauthorizedErrorData, http_res + ) + raise models.FieldUpdateTemplateFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateTemplateFieldForbiddenErrorData, http_res + ) + raise models.FieldUpdateTemplateFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldUpdateTemplateFieldInternalServerErrorData, http_res @@ -955,13 +1051,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -977,6 +1073,20 @@ def update_many( raise models.FieldUpdateTemplateFieldsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateTemplateFieldsUnauthorizedErrorData, http_res + ) + raise models.FieldUpdateTemplateFieldsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateTemplateFieldsForbiddenErrorData, http_res + ) + raise models.FieldUpdateTemplateFieldsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldUpdateTemplateFieldsInternalServerErrorData, http_res @@ -1066,13 +1176,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1088,6 +1198,20 @@ async def update_many_async( raise models.FieldUpdateTemplateFieldsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateTemplateFieldsUnauthorizedErrorData, http_res + ) + raise models.FieldUpdateTemplateFieldsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldUpdateTemplateFieldsForbiddenErrorData, http_res + ) + raise models.FieldUpdateTemplateFieldsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldUpdateTemplateFieldsInternalServerErrorData, http_res @@ -1167,13 +1291,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1189,6 +1313,18 @@ def delete( raise models.FieldDeleteTemplateFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldDeleteTemplateFieldUnauthorizedErrorData, http_res + ) + raise models.FieldDeleteTemplateFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldDeleteTemplateFieldForbiddenErrorData, http_res + ) + raise models.FieldDeleteTemplateFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldDeleteTemplateFieldInternalServerErrorData, http_res @@ -1268,13 +1404,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1290,6 +1426,18 @@ async def delete_async( raise models.FieldDeleteTemplateFieldBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.FieldDeleteTemplateFieldUnauthorizedErrorData, http_res + ) + raise models.FieldDeleteTemplateFieldUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.FieldDeleteTemplateFieldForbiddenErrorData, http_res + ) + raise models.FieldDeleteTemplateFieldForbiddenError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.FieldDeleteTemplateFieldInternalServerErrorData, http_res diff --git a/src/documenso_sdk/templates_recipients.py b/src/documenso_sdk/templates_recipients.py index 6cd9631..759d4b2 100644 --- a/src/documenso_sdk/templates_recipients.py +++ b/src/documenso_sdk/templates_recipients.py @@ -72,13 +72,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -94,6 +94,20 @@ def get( raise models.RecipientGetTemplateRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientGetTemplateRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientGetTemplateRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientGetTemplateRecipientForbiddenErrorData, http_res + ) + raise models.RecipientGetTemplateRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.RecipientGetTemplateRecipientNotFoundErrorData, http_res @@ -179,13 +193,13 @@ 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 ), ), request=req, - error_status_codes=["400", "404", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "404", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -201,6 +215,20 @@ async def get_async( raise models.RecipientGetTemplateRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientGetTemplateRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientGetTemplateRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientGetTemplateRecipientForbiddenErrorData, http_res + ) + raise models.RecipientGetTemplateRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( models.RecipientGetTemplateRecipientNotFoundErrorData, http_res @@ -301,13 +329,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -323,6 +351,20 @@ def create( raise models.RecipientCreateTemplateRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateTemplateRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientCreateTemplateRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateTemplateRecipientForbiddenErrorData, http_res + ) + raise models.RecipientCreateTemplateRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientCreateTemplateRecipientInternalServerErrorData, http_res @@ -416,13 +458,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -438,6 +480,20 @@ async def create_async( raise models.RecipientCreateTemplateRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateTemplateRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientCreateTemplateRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateTemplateRecipientForbiddenErrorData, http_res + ) + raise models.RecipientCreateTemplateRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientCreateTemplateRecipientInternalServerErrorData, http_res @@ -532,13 +588,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -554,6 +610,20 @@ def create_many( raise models.RecipientCreateTemplateRecipientsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateTemplateRecipientsUnauthorizedErrorData, http_res + ) + raise models.RecipientCreateTemplateRecipientsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateTemplateRecipientsForbiddenErrorData, http_res + ) + raise models.RecipientCreateTemplateRecipientsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientCreateTemplateRecipientsInternalServerErrorData, @@ -649,13 +719,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -671,6 +741,20 @@ async def create_many_async( raise models.RecipientCreateTemplateRecipientsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateTemplateRecipientsUnauthorizedErrorData, http_res + ) + raise models.RecipientCreateTemplateRecipientsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientCreateTemplateRecipientsForbiddenErrorData, http_res + ) + raise models.RecipientCreateTemplateRecipientsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientCreateTemplateRecipientsInternalServerErrorData, @@ -765,13 +849,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -787,6 +871,20 @@ def update( raise models.RecipientUpdateTemplateRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateTemplateRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientUpdateTemplateRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateTemplateRecipientForbiddenErrorData, http_res + ) + raise models.RecipientUpdateTemplateRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientUpdateTemplateRecipientInternalServerErrorData, http_res @@ -880,13 +978,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -902,6 +1000,20 @@ async def update_async( raise models.RecipientUpdateTemplateRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateTemplateRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientUpdateTemplateRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateTemplateRecipientForbiddenErrorData, http_res + ) + raise models.RecipientUpdateTemplateRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientUpdateTemplateRecipientInternalServerErrorData, http_res @@ -996,13 +1108,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1018,6 +1130,20 @@ def update_many( raise models.RecipientUpdateTemplateRecipientsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateTemplateRecipientsUnauthorizedErrorData, http_res + ) + raise models.RecipientUpdateTemplateRecipientsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateTemplateRecipientsForbiddenErrorData, http_res + ) + raise models.RecipientUpdateTemplateRecipientsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientUpdateTemplateRecipientsInternalServerErrorData, @@ -1113,13 +1239,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1135,6 +1261,20 @@ async def update_many_async( raise models.RecipientUpdateTemplateRecipientsBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateTemplateRecipientsUnauthorizedErrorData, http_res + ) + raise models.RecipientUpdateTemplateRecipientsUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientUpdateTemplateRecipientsForbiddenErrorData, http_res + ) + raise models.RecipientUpdateTemplateRecipientsForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientUpdateTemplateRecipientsInternalServerErrorData, @@ -1219,13 +1359,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1241,6 +1381,20 @@ def delete( raise models.RecipientDeleteTemplateRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientDeleteTemplateRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientDeleteTemplateRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientDeleteTemplateRecipientForbiddenErrorData, http_res + ) + raise models.RecipientDeleteTemplateRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientDeleteTemplateRecipientInternalServerErrorData, http_res @@ -1324,13 +1478,13 @@ 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 ), ), request=req, - error_status_codes=["400", "4XX", "500", "5XX"], + error_status_codes=["400", "401", "403", "4XX", "500", "5XX"], retry_config=retry_config, ) @@ -1346,6 +1500,20 @@ async def delete_async( raise models.RecipientDeleteTemplateRecipientBadRequestError( response_data, http_res ) + if utils.match_response(http_res, "401", "application/json"): + response_data = unmarshal_json_response( + models.RecipientDeleteTemplateRecipientUnauthorizedErrorData, http_res + ) + raise models.RecipientDeleteTemplateRecipientUnauthorizedError( + response_data, http_res + ) + if utils.match_response(http_res, "403", "application/json"): + response_data = unmarshal_json_response( + models.RecipientDeleteTemplateRecipientForbiddenErrorData, http_res + ) + raise models.RecipientDeleteTemplateRecipientForbiddenError( + response_data, http_res + ) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( models.RecipientDeleteTemplateRecipientInternalServerErrorData, http_res 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}") From 9ff024b7556801fde6d4b04010f299e3f3be199d Mon Sep 17 00:00:00 2001 From: "speakeasy-github[bot]" <128539517+speakeasy-github[bot]@users.noreply.github.com> Date: Wed, 12 Nov 2025 08:56:49 +0000 Subject: [PATCH 2/2] empty commit to trigger [run-tests] workflow